label

import Logging

A Logging API for Swift.

struct Logger

A Logger is the central type in SwiftLog. Its central function is to emit log messages using one of the methods corresponding to a log level.

@frozen struct String

A Unicode string value that is a collection of characters.

init(label: String)

Construct a Logger given a label identifying the creator of the Logger.

init(label: String, factory: (String) -> any LogHandler)

Construct a Logger given a label identifying the creator of the Logger or a non-standard LogHandler.

init(label: String, factory: (String, Logger.MetadataProvider?) -> any LogHandler)

Construct a Logger given a label identifying the creator of the Logger or a non-standard LogHandler.

init(label: String, metadataProvider: MetadataProvider)

Construct a Logger given a label identifying the creator of the Logger and a non-standard MetadataProvider.

var handler: any LogHandler { get set }

A computed property to access the LogHandler.

var logLevel: Logger.Level { get set }

Get or set the log level configured for this Logger.

var metadataProvider: Logger.MetadataProvider? { get }

The metadata provider this logger was created with.

subscript(metadataKey metadataKey: String) -> Logger.Metadata.Value? { get set }

Add, change, or remove a logging metadata item.

func critical(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the critical log level.

func critical(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, source: @autoclosure () -> String? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the critical log level.

func debug(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the debug log level.

func debug(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, source: @autoclosure () -> String? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the debug log level.

func error(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the error log level.

func error(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, source: @autoclosure () -> String? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the error log level.

func info(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the info log level.

func info(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, source: @autoclosure () -> String? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the info log level.

func log(level: Logger.Level, _ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing the log level as a parameter.

func log(level: Logger.Level, _ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, source: @autoclosure () -> String? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing the log level as a parameter.

func notice(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the notice log level.

func notice(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, source: @autoclosure () -> String? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the notice log level.

func trace(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the trace log level.

func trace(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, source: @autoclosure () -> String? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the trace log level.

func warning(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the warning log level.

func warning(_ message: @autoclosure () -> Logger.Message, metadata: @autoclosure () -> Logger.Metadata? = nil, source: @autoclosure () -> String? = nil, file: String = #fileID, function: String = #function, line: UInt = #line)

Log a message passing with the warning log level.

enum Level

The log level.

struct Message

Logger.Message represents a log message’s text. It is usually created using string literals.

struct MetadataProvider

A MetadataProvider is used to automatically inject runtime-generated metadata to all logs emitted by a logger.

enum MetadataValue

A logging metadata value. Logger.MetadataValue is string, array, and dictionary literal convertible.

typealias Metadata = [String : MetadataValue]

Metadata is a typealias for [String: Logger.MetadataValue] the type of the metadata storage.