BasicLogConfiguration

open class BasicLogConfiguration: LogConfiguration

In case the name didn’t give it away, the BasicLogConfiguration class provides a basic implementation of the LogConfiguration protocol.

  • The minimum LogSeverity supported by the configuration.

    Declaration

    Swift

    open let minimumSeverity: LogSeverity

  • The LogFilters to use when deciding whether a given LogEntry should be passed along to the receiver’s recorders. If any filter returns false from shouldRecordLogEntry(_:), the LogEntry will be silently ignored when being processed for this LogConfiguration.

    Declaration

    Swift

    open let filters: [LogFilter]

  • The LogRecorders to use for recording any LogEntry that has passed the filtering process.

    Declaration

    Swift

    open let recorders: [LogRecorder]

  • A flag indicating whether synchronous mode will be used when passing LogEntry instances to the receiver’s recorders. Synchronous mode is helpful while debugging, as it ensures that logs are always up-to-date when debug breakpoints are hit. However, synchronous mode can have a negative influence on performance and is therefore not recommended for use in production code.

    Declaration

    Swift

    open let synchronousMode: Bool

  • For organizational purposes, a given LogConfiguration may in turn contain one or more additional LogConfigurations. Each contained LogConfiguration is an entirely separate entity; children do not inherit any state from parent containers.

    Declaration

    Swift

    open let configurations: [LogConfiguration]?

  • Initializes a new BasicLogConfiguration instance.

    Declaration

    Swift

    public init(minimumSeverity: LogSeverity = .info, filters: [LogFilter] = [], recorders: [LogRecorder] = [], synchronousMode: Bool = false, configurations: [LogConfiguration]? = nil)

    Parameters

    minimumSeverity

    The minimum LogSeverity supported by the configuration. Log entries having a severity less than minimumSeverity will not be passed to the receiver’s recorders.
    filters

    The LogFilters to use when deciding whether a given LogEntry should be passed along to the receiver’s LogRecorders.
    recorders

    The LogRecorders to use for recording any LogEntry that has passed the filtering process.
    synchronousMode

    Determines whether synchronous mode will be used when passing LogEntry instances to the receiver’s recorders. Synchronous mode is helpful while debugging, as it ensures that logs are always up-to-date when debug breakpoints are hit. However, synchronous mode can have a negative influence on performance and is therefore not recommended for use in production code.
    configurations

    Optional LogConfigurations. For organizational purposes, a given LogConfiguration may in turn contain one or more additional LogConfigurations. Note that these are handled as entirely separate entities; the receiver’s state does not affect the behavior of the contained configurations in any way.