Add label in the logger

Author: Frizlab

Sources/JSONLogger.swift

@@ -44,6 +44,8 @@ public struct JSONLogger : LogHandler {
 	}
 	public var metadataProvider: Logger.MetadataProvider?
 
+	public let label: String
+	
 	public let outputFileDescriptor: FileDescriptor
 	public let lineSeparator: Data
 	public let prefix: Data
@@ -54,11 +56,12 @@ public struct JSONLogger : LogHandler {
 	 If the encoding fails or this property is set to `false` the String value will be used. */
 	public var tryEncodingStringConvertibles: Bool
 
-	public static func forJSONSeq(on fd: FileDescriptor = .standardError, metadataProvider: Logger.MetadataProvider? = LoggingSystem.metadataProvider) -> Self {
-		return Self(fd: fd, lineSeparator: Data(), prefix: Data([0x1e]), suffix: Data([0x0a]), metadataProvider: metadataProvider)
+	public static func forJSONSeq(on fd: FileDescriptor = .standardError, label: String, metadataProvider: Logger.MetadataProvider? = LoggingSystem.metadataProvider) -> Self {
+		return Self(label: label, fd: fd, lineSeparator: Data(), prefix: Data([0x1e]), suffix: Data([0x0a]), metadataProvider: metadataProvider)
 	}
 
-	public init(fd: FileDescriptor = .standardError, lineSeparator: Data = Data("\n".utf8), prefix: Data = Data(), suffix: Data = Data(), tryEncodingStringConvertibles: Bool = true, metadataProvider: Logger.MetadataProvider? = LoggingSystem.metadataProvider) {
+	public init(label: String, fd: FileDescriptor = .standardError, lineSeparator: Data = Data("\n".utf8), prefix: Data = Data(), suffix: Data = Data(), tryEncodingStringConvertibles: Bool = true, metadataProvider: Logger.MetadataProvider? = LoggingSystem.metadataProvider) {
+		self.label = label
 		self.outputFileDescriptor = fd
 		self.lineSeparator = lineSeparator
 		self.prefix = prefix
@@ -80,7 +83,7 @@ public struct JSONLogger : LogHandler {
 
 		/* We compute the data to print outside of the lock. */
 		let line = LogLine(level: level, message: message.description, metadata: effectiveJSONMetadata,
-								 source: source, file: file, function: function, line: line)
+								 label: label, source: source, file: file, function: function, line: line)
 		let jsonLine: Data
 		do    {jsonLine = try JSONEncoder().encode(line)}
 		catch {
@@ -94,6 +97,7 @@ public struct JSONLogger : LogHandler {
 						#""JSONLogger.LogInfo":"Original metadata removed (see JSONLogger doc)","# +
 						#""JSONLogger.LogError":"\#(String(describing: error).safifyForJSON())""# +
 					#"},"# +
+					#""label":"\#(label.safifyForJSON())","# +
 					#""source":"\#(source.safifyForJSON())","# +
 					#""file":"\#(file.safifyForJSON())","# +
 					#""function":"\#(function.safifyForJSON())","# +

Sources/LogLine.swift

@@ -11,15 +11,17 @@ public struct LogLine : Hashable, Codable, Sendable {
 	public var message: String
 	public var metadata: JSON
 
+	public var label: String
 	public var source: String
 	public var file: String
 	public var function: String
 	public var line: UInt
 
-	public init(level: Logger.Level, message: String, metadata: JSON, source: String, file: String, function: String, line: UInt) {
+	public init(level: Logger.Level, message: String, metadata: JSON, label: String, source: String, file: String, function: String, line: UInt) {
 		self.level = level
 		self.message = message
 		self.metadata = metadata
+		self.label = label
 		self.source = source
 		self.file = file
 		self.function = function

Tests/JSONLoggerTests.swift

@@ -8,7 +8,7 @@ import Logging
 final class JSONLoggerTests: XCTestCase {
 
 	override class func setUp() {
-		LoggingSystem.bootstrap{ _ in JSONLogger() }
+		LoggingSystem.bootstrap{ JSONLogger(label: $0) }
 	}
 
 	/* From <https://apple.github.io/swift-log/docs/current/Logging/Protocols/LogHandler.html#treat-log-level-amp-metadata-as-values>. */
@@ -27,5 +27,11 @@ final class JSONLoggerTests: XCTestCase {
 		XCTAssertEqual("second", logger2[metadataKey: "only-on"])
 	}
 
+	func testVisual1() {
+		XCTAssertTrue(true, "We only want to see how the log look, so please see the logs.")
+		
+		let logger = Logger(label: "my logger")
+		logger.info("First log message using JSONLogger")
+	}
 
 }