mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c7413d967b | ||
|
|
34b131f794 | ||
|
|
e3da040787 | ||
|
|
209524e4da | ||
|
|
c44b210eee | ||
|
|
d0f784af9e |
No files matched your search
@@ -10,7 +10,7 @@ on:
|
||||
jobs:
|
||||
soundness:
|
||||
name: Soundness
|
||||
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.16
|
||||
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.17
|
||||
with:
|
||||
license_header_check_project_name: "Swift Logging API"
|
||||
|
||||
|
||||
@@ -287,7 +287,7 @@ public struct PrintLogHandler: LogHandler {
|
||||
base: Logger.Metadata,
|
||||
provider: Logger.MetadataProvider?,
|
||||
explicit: Logger.Metadata?
|
||||
) -> Logger.Metadata? {
|
||||
) -> Logger.Metadata {
|
||||
var metadata = base
|
||||
|
||||
let provided = provider?.get() ?? [:]
|
||||
|
||||
@@ -25,3 +25,8 @@
|
||||
- ``logLevel``
|
||||
- ``metadata``
|
||||
- ``metadataProvider``
|
||||
|
||||
### Configuring the timestamp
|
||||
|
||||
- ``timestampPrecision``
|
||||
- ``TimestampPrecision``
|
||||
@@ -105,6 +105,9 @@ public struct MultiplexLogHandler: LogHandler {
|
||||
}
|
||||
|
||||
/// The metadata provider.
|
||||
///
|
||||
/// Setting this property sets the provider on all underlying handlers and replaces
|
||||
/// the provider passed to ``init(_:metadataProvider:)``.
|
||||
public var metadataProvider: Logger.MetadataProvider? {
|
||||
get {
|
||||
if self.handlers.count == 1 {
|
||||
@@ -138,6 +141,9 @@ public struct MultiplexLogHandler: LogHandler {
|
||||
}
|
||||
}
|
||||
set {
|
||||
// Also replace this handler's own provider, otherwise the provider passed to the
|
||||
// initializer keeps overriding the new one, and setting `nil` would not remove it.
|
||||
self._metadataProvider = newValue
|
||||
self.mutatingForEachHandler { $0.metadataProvider = newValue }
|
||||
}
|
||||
}
|
||||
@@ -190,6 +196,10 @@ public struct MultiplexLogHandler: LogHandler {
|
||||
}
|
||||
|
||||
/// Get or set the entire metadata storage as a dictionary.
|
||||
///
|
||||
/// The getter merges the metadata of the underlying handlers in initialization order.
|
||||
/// On a key conflict, the first handler's value wins, as in ``subscript(metadataKey:)``.
|
||||
/// The dictionary does not contain values from metadata providers.
|
||||
public var metadata: Logger.Metadata {
|
||||
get {
|
||||
var effective: Logger.Metadata = [:]
|
||||
@@ -199,14 +209,9 @@ public struct MultiplexLogHandler: LogHandler {
|
||||
// !-safe, we always have at least one handler
|
||||
effective.reserveCapacity(self.handlers.first!.metadata.count)
|
||||
|
||||
// Keep the existing value on a conflict, so the first handler wins.
|
||||
for handler in self.handlers {
|
||||
effective.merge(handler.metadata, uniquingKeysWith: { _, handlerMetadata in handlerMetadata })
|
||||
if let provider = handler.metadataProvider {
|
||||
effective.merge(provider.get(), uniquingKeysWith: { _, provided in provided })
|
||||
}
|
||||
}
|
||||
if let provider = self._metadataProvider {
|
||||
effective.merge(provider.get(), uniquingKeysWith: { _, provided in provided })
|
||||
effective.merge(handler.metadata, uniquingKeysWith: { current, _ in current })
|
||||
}
|
||||
|
||||
return effective
|
||||
|
||||
@@ -80,6 +80,19 @@ public struct StreamLogHandler: LogHandler {
|
||||
/// The metadata provider.
|
||||
public var metadataProvider: Logger.MetadataProvider?
|
||||
|
||||
/// The precision of the timestamp written at the start of each log line.
|
||||
///
|
||||
/// Defaults to ``TimestampPrecision/seconds``, which keeps the output format
|
||||
/// that `StreamLogHandler` has always used, for example `2025-06-01T14:03:07+0000`.
|
||||
/// Some tools parse this output, so the extra precision is opt-in rather than the default.
|
||||
///
|
||||
/// Set it to ``TimestampPrecision/milliseconds`` to include milliseconds,
|
||||
/// for example `2025-06-01T14:03:07.042+0000`.
|
||||
///
|
||||
/// > Note: On WASI the wall clock is only read with second precision, so
|
||||
/// > ``TimestampPrecision/milliseconds`` always prints `.000` there.
|
||||
public var timestampPrecision: TimestampPrecision = .seconds
|
||||
|
||||
private var prettyMetadata: String?
|
||||
/// Get or set the entire metadata storage as a dictionary.
|
||||
public var metadata = Logger.Metadata() {
|
||||
@@ -144,7 +157,7 @@ public struct StreamLogHandler: LogHandler {
|
||||
|
||||
var stream = self.stream
|
||||
stream.write(
|
||||
"\(self.timestamp()) \(event.level)\(self.label.isEmpty ? "" : " ")\(self.label):\(prettyMetadata.map { " \($0)" } ?? "") [\(event.source)] \(event.message)\n"
|
||||
"\(self.timestamp(precision: self.timestampPrecision)) \(event.level)\(self.label.isEmpty ? "" : " ")\(self.label):\(prettyMetadata.map { " \($0)" } ?? "") [\(event.source)] \(event.message)\n"
|
||||
)
|
||||
}
|
||||
|
||||
@@ -210,28 +223,83 @@ public struct StreamLogHandler: LogHandler {
|
||||
}
|
||||
}
|
||||
|
||||
private func timestamp() -> String {
|
||||
private func timestamp(precision: TimestampPrecision) -> String {
|
||||
var buffer = [Int8](repeating: 0, count: 255)
|
||||
var tzBuffer = [Int8](repeating: 0, count: 16)
|
||||
let milliseconds: Int
|
||||
#if os(Windows)
|
||||
var timestamp = __time64_t()
|
||||
_ = _time64(×tamp)
|
||||
|
||||
// _ftime64_s gives wall-clock time with millisecond resolution.
|
||||
var timeBuffer = __timeb64()
|
||||
_ = _ftime64_s(&timeBuffer)
|
||||
var localTime = tm()
|
||||
_ = _localtime64_s(&localTime, ×tamp)
|
||||
|
||||
_ = strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S%z", &localTime)
|
||||
#else
|
||||
_ = _localtime64_s(&localTime, &timeBuffer.time)
|
||||
_ = strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S", &localTime)
|
||||
_ = strftime(&tzBuffer, tzBuffer.count, "%z", &localTime)
|
||||
milliseconds = Int(timeBuffer.millitm)
|
||||
#elseif canImport(WASILibc)
|
||||
// CLOCK_REALTIME isn't importable on WASI (it's a pointer-to-struct macro),
|
||||
// so fall back to time(nil), which only has second resolution.
|
||||
var timestamp = time(nil)
|
||||
guard let localTime = localtime(×tamp) else {
|
||||
return "<unknown>"
|
||||
}
|
||||
strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S%z", localTime)
|
||||
strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S", localTime)
|
||||
strftime(&tzBuffer, tzBuffer.count, "%z", localTime)
|
||||
milliseconds = 0
|
||||
#else
|
||||
var timeSpec = timespec()
|
||||
clock_gettime(CLOCK_REALTIME, &timeSpec)
|
||||
guard let localTime = localtime(&timeSpec.tv_sec) else {
|
||||
return "<unknown>"
|
||||
}
|
||||
strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S", localTime)
|
||||
strftime(&tzBuffer, tzBuffer.count, "%z", localTime)
|
||||
milliseconds = Int(timeSpec.tv_nsec) / 1_000_000
|
||||
#endif
|
||||
return buffer.withUnsafeBufferPointer {
|
||||
let dateTime = buffer.withUnsafeBufferPointer {
|
||||
$0.withMemoryRebound(to: CChar.self) {
|
||||
String(cString: $0.baseAddress!)
|
||||
}
|
||||
}
|
||||
let timeZone = tzBuffer.withUnsafeBufferPointer {
|
||||
$0.withMemoryRebound(to: CChar.self) {
|
||||
String(cString: $0.baseAddress!)
|
||||
}
|
||||
}
|
||||
switch precision {
|
||||
case .seconds:
|
||||
return "\(dateTime)\(timeZone)"
|
||||
case .milliseconds:
|
||||
return "\(dateTime).\(Self.zeroPadded(milliseconds))\(timeZone)"
|
||||
}
|
||||
}
|
||||
|
||||
/// Pads a millisecond value to three digits without pulling in Foundation.
|
||||
internal static func zeroPadded(_ milliseconds: Int) -> String {
|
||||
if milliseconds < 10 {
|
||||
return "00\(milliseconds)"
|
||||
} else if milliseconds < 100 {
|
||||
return "0\(milliseconds)"
|
||||
} else {
|
||||
return "\(milliseconds)"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension StreamLogHandler {
|
||||
/// The precision of the timestamp that a ``StreamLogHandler`` writes at the start of each log line.
|
||||
@nonexhaustive
|
||||
public enum TimestampPrecision: Sendable, Hashable {
|
||||
/// Whole seconds, for example `2025-06-01T14:03:07+0000`.
|
||||
///
|
||||
/// This is the default, and matches the format `StreamLogHandler` has always produced.
|
||||
case seconds
|
||||
|
||||
/// Milliseconds, for example `2025-06-01T14:03:07.042+0000`.
|
||||
///
|
||||
/// > Note: On WASI the wall clock only has second resolution, so the
|
||||
/// > millisecond field is always `.000`.
|
||||
case milliseconds
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1395,7 +1395,18 @@ extension Logger {
|
||||
@inlinable
|
||||
internal static func currentModule(fileID: String = #fileID) -> String {
|
||||
let utf8All = fileID.utf8
|
||||
if let slashIndex = utf8All.firstIndex(of: UInt8(ascii: "/")) {
|
||||
let searchStart: String.UTF8View.Index
|
||||
if utf8All.first == UInt8(ascii: "`") {
|
||||
guard let closingBacktickIndex = utf8All.dropFirst().firstIndex(of: UInt8(ascii: "`")) else {
|
||||
// It should be impossible for a well-formed module to get here, so treat it as an "n/a" case.
|
||||
return "n/a"
|
||||
}
|
||||
// Backticks are part of raw-identifier module names as written in source and mangled, so preserve them.
|
||||
searchStart = utf8All.index(after: closingBacktickIndex)
|
||||
} else {
|
||||
searchStart = utf8All.startIndex
|
||||
}
|
||||
if let slashIndex = utf8All[searchStart...].firstIndex(of: UInt8(ascii: "/")) {
|
||||
return String(fileID[..<slashIndex])
|
||||
} else {
|
||||
return "n/a"
|
||||
|
||||
@@ -45,4 +45,52 @@ struct MultiplexProviderRegressionTests {
|
||||
#expect(sink.entries.first?.metadata == ["child": "kept", "outer": "kept", "shared": "outer"])
|
||||
#expect(sink.entries.last?.metadata == ["child": "kept", "outer": "kept", "shared": "explicit"])
|
||||
}
|
||||
|
||||
@Test(arguments: [1, 2])
|
||||
func settingProviderReplacesConstructorProvider(handlerCount: Int) {
|
||||
let sinks = (0..<handlerCount).map { _ in InMemoryLogHandler() }
|
||||
let handler = MultiplexLogHandler(sinks, metadataProvider: .init { ["trace-id": "constructor"] })
|
||||
var logger = Logger(label: "test", factory: { _ in handler })
|
||||
|
||||
logger.handler.metadataProvider = .init { ["trace-id": "replaced"] }
|
||||
#expect(logger.metadataProvider?.get() == ["trace-id": "replaced"])
|
||||
logger.info("replaced")
|
||||
|
||||
logger.handler.metadataProvider = nil
|
||||
#expect(logger.metadataProvider == nil)
|
||||
logger.info("cleared")
|
||||
|
||||
for sink in sinks {
|
||||
#expect(sink.entries.map(\.metadata) == [["trace-id": "replaced"], [:]])
|
||||
}
|
||||
}
|
||||
|
||||
@Test func settingProviderReachesHandlersWithoutProviderSupport() {
|
||||
let sink = InMemoryLogHandler()
|
||||
var handler = MultiplexLogHandler(
|
||||
[HandlerWithoutProviderSupport(sink: sink)],
|
||||
metadataProvider: .init { ["trace-id": "constructor"] }
|
||||
)
|
||||
handler.metadataProvider = .init { ["trace-id": "replaced"] }
|
||||
let logger = Logger(label: "test", factory: { _ in handler })
|
||||
logger.info("hello")
|
||||
// Debug builds may also record a one-time warning about the unsupported provider.
|
||||
#expect(sink.entries.filter { $0.message == "hello" }.map(\.metadata) == [["trace-id": "replaced"]])
|
||||
}
|
||||
}
|
||||
|
||||
/// Uses the default `metadataProvider` implementation, so it ignores providers set on it.
|
||||
private struct HandlerWithoutProviderSupport: LogHandler {
|
||||
let sink: InMemoryLogHandler
|
||||
var metadata: Logger.Metadata = [:]
|
||||
var logLevel: Logger.Level = .info
|
||||
|
||||
subscript(metadataKey key: String) -> Logger.Metadata.Value? {
|
||||
get { self.metadata[key] }
|
||||
set { self.metadata[key] = newValue }
|
||||
}
|
||||
|
||||
func log(event: LogEvent) {
|
||||
self.sink.log(event: event)
|
||||
}
|
||||
}
|
||||
@@ -278,7 +278,8 @@ struct LoggingTest {
|
||||
multiplexLogger.handler.metadata == [
|
||||
"one": "111",
|
||||
"two": "222",
|
||||
"in": "in-2",
|
||||
// First handler wins on conflicting keys (see issue #498):
|
||||
"in": "in-1",
|
||||
]
|
||||
)
|
||||
}
|
||||
@@ -315,21 +316,17 @@ struct LoggingTest {
|
||||
}
|
||||
)
|
||||
|
||||
// The subscript and `metadata` agree on conflicting keys.
|
||||
#expect(multiplexLogger[metadataKey: "one"] == "111")
|
||||
#expect(multiplexLogger[metadataKey: "two"] == "222")
|
||||
#expect(multiplexLogger[metadataKey: "in"] == "in-1")
|
||||
|
||||
// Provider values are not part of `metadata`.
|
||||
#expect(
|
||||
multiplexLogger.handler.metadata == [
|
||||
"one": "111",
|
||||
"two": "222",
|
||||
"in": "in-2",
|
||||
"provider-1": "provided-111",
|
||||
"provider-2": "provided-222",
|
||||
"provider-overlap": "provided-222",
|
||||
]
|
||||
)
|
||||
#expect(
|
||||
multiplexLogger.handler.metadataProvider?.get() == [
|
||||
"provider-1": "provided-111",
|
||||
"provider-2": "provided-222",
|
||||
"provider-overlap": "provided-222",
|
||||
"in": "in-1",
|
||||
]
|
||||
)
|
||||
}
|
||||
@@ -1160,6 +1157,20 @@ struct LoggingTest {
|
||||
#expect(logger1.handlerCopies == 0)
|
||||
#expect(logger1[metadataKey: "key0"] == "0")
|
||||
}
|
||||
|
||||
@Test func currentModuleFileIDParsing() {
|
||||
#expect(Logger.currentModule(fileID: "MyModule/MyFile.swift") == "MyModule")
|
||||
#expect(Logger.currentModule(fileID: "MyModule/Subdir/MyFile.swift") == "MyModule")
|
||||
#expect(Logger.currentModule(fileID: "`My.Module`/MyFile.swift") == "`My.Module`")
|
||||
#expect(Logger.currentModule(fileID: "`My/Module`/MyFile.swift") == "`My/Module`")
|
||||
#expect(Logger.currentModule(fileID: "`/a/b/c`/MyFile.swift") == "`/a/b/c`")
|
||||
#expect(Logger.currentModule(fileID: "`/a/b/c`/Subdir/MyFile.swift") == "`/a/b/c`")
|
||||
#expect(Logger.currentModule(fileID: "`Module With Spaces`/MyFile.swift") == "`Module With Spaces`")
|
||||
#expect(Logger.currentModule(fileID: "`Unclosed/MyFile.swift") == "n/a")
|
||||
#expect(Logger.currentModule(fileID: "`NoSlash`") == "n/a")
|
||||
#expect(Logger.currentModule(fileID: "NoSlash.swift") == "n/a")
|
||||
#expect(Logger.currentModule(fileID: "") == "n/a")
|
||||
}
|
||||
}
|
||||
|
||||
extension Logger {
|
||||
|
||||
@@ -85,6 +85,45 @@ struct StreamLogHandlerTest {
|
||||
#expect(interceptStream.strings.count == 1)
|
||||
}
|
||||
|
||||
@Test func streamLogHandlerTimestampPrecisionDefaultsToSeconds() {
|
||||
let handler = StreamLogHandler(label: "testLabel", stream: InterceptStream())
|
||||
#expect(handler.timestampPrecision == .seconds)
|
||||
}
|
||||
|
||||
@Test func streamLogHandlerOutputFormatWithMillisecondPrecision() {
|
||||
let interceptStream = InterceptStream()
|
||||
let label = "testLabel"
|
||||
let source = "testSource"
|
||||
let log = Logger(
|
||||
label: label,
|
||||
factory: {
|
||||
var handler = StreamLogHandler(label: $0, stream: interceptStream)
|
||||
handler.timestampPrecision = .milliseconds
|
||||
return handler
|
||||
}
|
||||
)
|
||||
|
||||
let testString = "my message is better than yours"
|
||||
log.critical("\(testString)", source: source)
|
||||
|
||||
let pattern =
|
||||
"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}(\\+|-)\\d{4}\\s\(Logger.Level.critical)\\s\(label):\\s\\[\(source)\\]\\s\(testString)$"
|
||||
|
||||
let messageSucceeded =
|
||||
interceptStream.interceptedText?.trimmingCharacters(in: .whitespacesAndNewlines).range(
|
||||
of: pattern,
|
||||
options: .regularExpression
|
||||
) != nil
|
||||
|
||||
#expect(messageSucceeded)
|
||||
#expect(interceptStream.strings.count == 1)
|
||||
}
|
||||
|
||||
@Test(arguments: [(0, "000"), (7, "007"), (42, "042"), (999, "999")])
|
||||
func streamLogHandlerMillisecondsAreZeroPadded(milliseconds: Int, expected: String) {
|
||||
#expect(StreamLogHandler.zeroPadded(milliseconds) == expected)
|
||||
}
|
||||
|
||||
@Test func streamLogHandlerOutputFormatWithEmptyLabel() {
|
||||
let interceptStream = InterceptStream()
|
||||
let source = "testSource"
|
||||
|
||||
Reference in new issue
Block a user