Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
474 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| { | ||
| "object": { | ||
| "pins": [ | ||
| { | ||
| "package": "swift-log", | ||
| "repositoryURL": "https://github.com/apple/swift-log.git", | ||
| "state": { | ||
| "branch": null, | ||
| "revision": "173f567a2dfec11d74588eea82cecea555bdc0bc", | ||
| "version": "1.4.0" | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "version": 1 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
205 changes: 205 additions & 0 deletions
205
Sources/CocoaLumberjackSwiftLogBackend/DDLogHandler.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| // Software License Agreement (BSD License) | ||
| // | ||
| // Copyright (c) 2010-2020, Deusty, LLC | ||
| // All rights reserved. | ||
| // | ||
| // Redistribution and use of this software in source and binary forms, | ||
| // with or without modification, are permitted provided that the following conditions are met: | ||
| // | ||
| // * Redistributions of source code must retain the above copyright notice, | ||
| // this list of conditions and the following disclaimer. | ||
| // | ||
| // * Neither the name of Deusty nor the names of its contributors may be used | ||
| // to endorse or promote products derived from this software without specific | ||
| // prior written permission of Deusty, LLC. | ||
|
|
||
| import CocoaLumberjack | ||
| import Logging | ||
|
|
||
| extension Logger.Level { | ||
| @inlinable | ||
| var ddLogLevelAndFlag: (DDLogLevel, DDLogFlag) { | ||
| switch self { | ||
| case .trace: return (.verbose, .verbose) | ||
| case .debug: return (.debug, .debug) | ||
| case .info, .notice: return (.info, .info) | ||
| case .warning: return (.warning, .warning) | ||
| case .error, .critical: return (.error, .error) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension DDLogMessage { | ||
| /// Contains the swift-log details of a given log message. | ||
| public struct SwiftLogInformation: Equatable { | ||
| /// Contains information about the swift-log logger that logged this message. | ||
| public struct LoggerInformation: Equatable { | ||
| /// The label of the swift-log logger that logged this message. | ||
| public let label: String | ||
| /// The metadata of the swift-log logger that logged this message. | ||
| public let metadata: Logger.Metadata | ||
| } | ||
|
|
||
| /// Contains information about the swift-log message thas was logged. | ||
| public struct MessageInformation: Equatable { | ||
| /// The original swift-log message. | ||
| public let message: Logger.Message | ||
| /// The original swift-log level of the message. This could be more fine-grained than `DDLogMessage.level` & `DDLogMessage.flag`. | ||
| public let level: Logger.Level | ||
| /// The original swift-log metadata of the message. | ||
| public let metadata: Logger.Metadata? | ||
| /// The original swift-log source of the message. | ||
| public let source: String | ||
| } | ||
|
|
||
| /// The information about the swift-log logger that logged this message. | ||
| public let logger: LoggerInformation | ||
| /// The information about the swift-log message that was logged. | ||
| public let message: MessageInformation | ||
| } | ||
|
|
||
| /// The swift-log information of this log message. This only exists for messages logged via swift-log. | ||
| /// - SeeAlso: `DDLogMessage.SwiftLogInformation` | ||
| @inlinable | ||
| public var swiftLogInfo: SwiftLogInformation? { | ||
| return (self as? SwiftLogMessage)?._swiftLogInfo | ||
| } | ||
| } | ||
|
|
||
| /// This class (intentionally internal) is basically only an "encapsulation" layer above `DDLogMessage`. | ||
| /// It's basically an implementation detail of `DDLogMessage.swiftLogInfo`. | ||
| @usableFromInline | ||
| final class SwiftLogMessage: DDLogMessage { | ||
| @usableFromInline | ||
| let _swiftLogInfo: SwiftLogInformation | ||
|
|
||
| @usableFromInline | ||
| init(loggerLabel: String, | ||
| loggerMetadata: Logger.Metadata, | ||
| message: Logger.Message, | ||
| level: Logger.Level, | ||
| metadata: Logger.Metadata?, | ||
| source: String, | ||
| file: String, | ||
| function: String, | ||
| line: UInt) { | ||
| _swiftLogInfo = .init(logger: .init(label: loggerLabel, metadata: loggerMetadata), | ||
| message: .init(message: message, | ||
| level: level, | ||
| metadata: metadata, | ||
| source: source)) | ||
| let (ddLogLevel, ddLogFlag) = level.ddLogLevelAndFlag | ||
| super.init(message: String(describing: message), | ||
| level: ddLogLevel, | ||
| flag: ddLogFlag, | ||
| context: 0, | ||
| file: file, | ||
| function: function, | ||
| line: line, | ||
| tag: nil, | ||
| options: .dontCopyMessage, // Swift will bridge to NSString. No need to make an additional copy. | ||
| timestamp: nil) // Passing nil will make DDLogMessage create the timestamp which saves us the bridging between Date and NSDate. | ||
| } | ||
|
|
||
| override func isEqual(_ object: Any?) -> Bool { | ||
| return super.isEqual(object) && (object as? SwiftLogMessage)?._swiftLogInfo == _swiftLogInfo | ||
| } | ||
| } | ||
|
|
||
| /// A swift-log `LogHandler` implenentation that forwards messages to a given `DDLog` instance. | ||
| public struct DDLogHandler: LogHandler { | ||
| @usableFromInline | ||
| struct Configuration { | ||
| @usableFromInline | ||
| let log: DDLog | ||
| @usableFromInline | ||
| let syncLoggingTresholdLevel: Logger.Level | ||
| } | ||
|
|
||
| @usableFromInline | ||
| struct LoggerInfo { | ||
| @usableFromInline | ||
| let label: String | ||
| @usableFromInline | ||
| var logLevel: Logger.Level | ||
| @usableFromInline | ||
| var metadata: Logger.Metadata = [:] | ||
| } | ||
|
|
||
| @usableFromInline | ||
| let config: Configuration | ||
| @usableFromInline | ||
| var loggerInfo: LoggerInfo | ||
|
|
||
| public var logLevel: Logger.Level { | ||
| get { loggerInfo.logLevel } | ||
| set { loggerInfo.logLevel = newValue } | ||
| } | ||
| public var metadata: Logger.Metadata { | ||
| get { loggerInfo.metadata } | ||
| set { loggerInfo.metadata = newValue } | ||
| } | ||
|
|
||
| @inlinable | ||
| public subscript(metadataKey metadataKey: String) -> Logger.Metadata.Value? { | ||
| get { return metadata[metadataKey] } | ||
| set { metadata[metadataKey] = newValue } | ||
| } | ||
|
|
||
| private init(config: Configuration, loggerInfo: LoggerInfo) { | ||
| self.config = config | ||
| self.loggerInfo = loggerInfo | ||
| } | ||
|
|
||
| @inlinable | ||
| public func log(level: Logger.Level, | ||
| message: Logger.Message, | ||
| metadata: Logger.Metadata?, | ||
| source: String, | ||
| file: String, | ||
| function: String, | ||
| line: UInt) { | ||
| let slMessage = SwiftLogMessage(loggerLabel: loggerInfo.label, | ||
| loggerMetadata: loggerInfo.metadata, | ||
| message: message, | ||
| level: level, | ||
| metadata: metadata, | ||
| source: source, | ||
| file: file, | ||
| function: function, | ||
| line: line) | ||
| config.log.log(asynchronous: level < config.syncLoggingTresholdLevel, | ||
| message: slMessage) | ||
| } | ||
| } | ||
|
|
||
| extension DDLogHandler { | ||
| /// Creates a new `LogHandler` factory using `DDLogHandler` with the given parameters. | ||
| /// - Parameters: | ||
| /// - log: The `DDLog` instance to use for logging. Defaults to `DDLog.sharedInstance`. | ||
| /// - defaultLogLevel: The default log level for new loggers. Defaults to `.info`. | ||
| /// - syncLoggingTreshold: The level as of which log messages should be logged synchronously instead of asynchronously. Defaults to `.error`. | ||
| /// - Returns: A new `LogHandler` factory using `DDLogHandler` that can be passed to `LoggingSystem.bootstrap`. | ||
| /// - SeeAlso: `DDLog`, `LoggingSystem.boostrap` | ||
| public static func handlerFactory(for log: DDLog = .sharedInstance, | ||
| defaultLogLevel: Logger.Level = .info, | ||
| loggingSynchronousAsOf syncLoggingTreshold: Logger.Level = .error) -> (String) -> LogHandler { | ||
| let config = DDLogHandler.Configuration(log: log, syncLoggingTresholdLevel: syncLoggingTreshold) | ||
| return { DDLogHandler(config: config, loggerInfo: .init(label: $0, logLevel: defaultLogLevel)) } | ||
| } | ||
| } | ||
|
|
||
| extension LoggingSystem { | ||
| /// Bootraps the logging system with a new `LogHandler` factory using `DDLogHandler`. | ||
| /// - Parameters: | ||
| /// - log: The `DDLog` instance to use for logging. Defaults to `DDLog.sharedInstance`. | ||
| /// - defaultLogLevel: The default log level for new loggers. Defaults to `.info`. | ||
| /// - syncLoggingTreshold: The level as of which log messages should be logged synchronously instead of asynchronously. Defaults to `.error`. | ||
| /// - SeeAlso: `DDLogHandler.handlerFactory`, `LoggingSystem.bootstrap` | ||
| @inlinable | ||
| public static func bootstrapWithCocoaLumberjack(for log: DDLog = .sharedInstance, | ||
| defaultLogLevel: Logger.Level = .info, | ||
| loggingSynchronousAsOf syncLoggingTreshold: Logger.Level = .error) { | ||
| bootstrap(DDLogHandler.handlerFactory(for: log, defaultLogLevel: defaultLogLevel, loggingSynchronousAsOf: syncLoggingTreshold)) | ||
| } | ||
| } |
Oops, something went wrong.