mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c9c6bb9d27 | ||
|
|
6404842475 | ||
|
|
fcd893317d | ||
|
|
65b3417512 | ||
|
|
666b45a252 | ||
|
|
4038b6a4f7 |
No files matched your search
@@ -10,7 +10,7 @@ on:
|
||||
jobs:
|
||||
soundness:
|
||||
name: Soundness
|
||||
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.15
|
||||
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.16
|
||||
with:
|
||||
license_header_check_project_name: "Swift Logging API"
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 759,
|
||||
"instructions" : 710,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+2
-2
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"instructions" : 689,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+2
-2
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 803,
|
||||
"instructions" : 750,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 828,
|
||||
"instructions" : 775,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
@@ -144,9 +144,23 @@ public struct MultiplexLogHandler: LogHandler {
|
||||
|
||||
/// Log a message using the log level and source that you provide.
|
||||
///
|
||||
/// Metadata from this handler's metadata provider overrides metadata from
|
||||
/// the underlying handlers and their providers. Explicit metadata in the
|
||||
/// log event takes precedence over this handler's provider.
|
||||
///
|
||||
/// - parameters:
|
||||
/// - event: The log event containing the level, message, metadata, and source location.
|
||||
public func log(event: LogEvent) {
|
||||
var event = event
|
||||
if let provider = self._metadataProvider {
|
||||
var metadata = provider.get()
|
||||
if let explicit = event.metadata {
|
||||
metadata.merge(explicit, uniquingKeysWith: { _, explicit in explicit })
|
||||
}
|
||||
if !metadata.isEmpty {
|
||||
event.metadata = metadata
|
||||
}
|
||||
}
|
||||
for handler in self.handlers where handler.logLevel <= event.level {
|
||||
handler.log(event: event)
|
||||
}
|
||||
|
||||
@@ -57,15 +57,23 @@ public struct Logger {
|
||||
/// This computed property provides access to the `LogHandler`.
|
||||
@inlinable
|
||||
public var handler: any LogHandler {
|
||||
get {
|
||||
self._storage.handler
|
||||
_read {
|
||||
yield self._storage.handler
|
||||
}
|
||||
// Keep a setter for plain assignments, which is cheaper than going through `_modify`.
|
||||
set {
|
||||
if !isKnownUniquelyReferenced(&self._storage) {
|
||||
self._storage = self._storage.copy()
|
||||
}
|
||||
self._storage.handler = newValue
|
||||
}
|
||||
// Yield the stored handler, so a metadata write does not copy the handler's metadata.
|
||||
_modify {
|
||||
if !isKnownUniquelyReferenced(&self._storage) {
|
||||
self._storage = self._storage.copy()
|
||||
}
|
||||
yield &self._storage.handler
|
||||
}
|
||||
}
|
||||
|
||||
/// The metadata provider this logger was created with.
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// This source file is part of the Swift Logging API open source project
|
||||
//
|
||||
// Copyright (c) 2026 Apple Inc. and the Swift Logging API project authors
|
||||
// Licensed under Apache License v2.0
|
||||
//
|
||||
// See LICENSE.txt for license information
|
||||
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import InMemoryLogging
|
||||
import Logging
|
||||
import Testing
|
||||
|
||||
struct MultiplexProviderRegressionTests {
|
||||
@Test(arguments: [1, 2])
|
||||
func constructorProviderReachesEverySink(handlerCount: Int) {
|
||||
let sinks = (0..<handlerCount).map { _ in InMemoryLogHandler() }
|
||||
let handler = MultiplexLogHandler(sinks, metadataProvider: .init { ["trace-id": "123"] })
|
||||
let logger = Logger(label: "test", factory: { _ in handler })
|
||||
#expect(logger.metadataProvider?.get()["trace-id"] == "123")
|
||||
logger.info("hello")
|
||||
for sink in sinks {
|
||||
#expect(sink.entries.count == 1)
|
||||
#expect(sink.entries.first?.metadata["trace-id"] == "123")
|
||||
}
|
||||
}
|
||||
|
||||
@Test func constructorProviderLayersBetweenChildAndExplicitMetadata() {
|
||||
var sink = InMemoryLogHandler()
|
||||
sink.metadataProvider = .init { ["child": "kept", "shared": "child"] }
|
||||
let handler = MultiplexLogHandler(
|
||||
[sink],
|
||||
metadataProvider: .init {
|
||||
["outer": "kept", "shared": "outer"]
|
||||
}
|
||||
)
|
||||
let logger = Logger(label: "test", factory: { _ in handler })
|
||||
logger.info("provided")
|
||||
logger.info("explicit", metadata: ["shared": "explicit"])
|
||||
#expect(sink.entries.first?.metadata == ["child": "kept", "outer": "kept", "shared": "outer"])
|
||||
#expect(sink.entries.last?.metadata == ["child": "kept", "outer": "kept", "shared": "explicit"])
|
||||
}
|
||||
}
|
||||
@@ -1143,6 +1143,23 @@ struct LoggingTest {
|
||||
#expect(.error == logger1.logLevel)
|
||||
#expect(.trace == logger2.logLevel)
|
||||
}
|
||||
|
||||
@Test func loggerMetadataWriteMutatesHandlerInPlace() {
|
||||
var logger1 = Logger(label: "foo", factory: { _ in CopyCountingLogHandler() })
|
||||
for i in 0..<10 {
|
||||
logger1[metadataKey: "key\(i)"] = "\(i)"
|
||||
}
|
||||
#expect(logger1.handlerCopies == 0)
|
||||
|
||||
// The first write to a copy copies the handler once, later writes reuse that copy.
|
||||
var logger2 = logger1
|
||||
for i in 0..<10 {
|
||||
logger2[metadataKey: "key\(i)"] = "changed"
|
||||
}
|
||||
#expect(logger2.handlerCopies == 1)
|
||||
#expect(logger1.handlerCopies == 0)
|
||||
#expect(logger1[metadataKey: "key0"] == "0")
|
||||
}
|
||||
}
|
||||
|
||||
extension Logger {
|
||||
|
||||
@@ -79,6 +79,20 @@ struct TaskLocalLoggerTest {
|
||||
logging.history.assertExist(level: .info, message: "merged", metadata: ["key": "value"])
|
||||
}
|
||||
|
||||
@Test func mergeMetadataCopiesHandlerOnce() {
|
||||
let logger = Logger(label: "test", factory: { _ in CopyCountingLogHandler() })
|
||||
let metadata: Logger.Metadata = ["a": "1", "b": "2", "c": "3", "d": "4", "e": "5"]
|
||||
|
||||
withLogger(logger) { _ in
|
||||
withLogger(mergingMetadata: metadata) { inner in
|
||||
#expect(inner.handler.metadata == metadata)
|
||||
#expect(inner.handlerCopies == 1)
|
||||
}
|
||||
#expect(Logger.current.handler.metadata.isEmpty)
|
||||
#expect(Logger.current.handlerCopies == 0)
|
||||
}
|
||||
}
|
||||
|
||||
@Test func overrideLogLevel() {
|
||||
let logging = TestLogging()
|
||||
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
|
||||
|
||||
@@ -485,9 +485,64 @@ internal struct TestLibrary: Sendable {
|
||||
}
|
||||
}
|
||||
|
||||
/// A log handler that keeps its metadata in a copy-on-write box and counts how often the box was copied.
|
||||
internal struct CopyCountingLogHandler: LogHandler {
|
||||
final class Box {
|
||||
var metadata: Logger.Metadata = [:]
|
||||
var copies = 0
|
||||
}
|
||||
|
||||
private var box = Box()
|
||||
|
||||
var logLevel: Logger.Level = .info
|
||||
|
||||
var copies: Int {
|
||||
self.box.copies
|
||||
}
|
||||
|
||||
var metadata: Logger.Metadata {
|
||||
get {
|
||||
self.box.metadata
|
||||
}
|
||||
set {
|
||||
self.makeUnique()
|
||||
self.box.metadata = newValue
|
||||
}
|
||||
}
|
||||
|
||||
subscript(metadataKey metadataKey: String) -> Logger.Metadata.Value? {
|
||||
get {
|
||||
self.box.metadata[metadataKey]
|
||||
}
|
||||
set {
|
||||
self.makeUnique()
|
||||
self.box.metadata[metadataKey] = newValue
|
||||
}
|
||||
}
|
||||
|
||||
func log(event: LogEvent) {}
|
||||
|
||||
private mutating func makeUnique() {
|
||||
if !isKnownUniquelyReferenced(&self.box) {
|
||||
let copy = Box()
|
||||
copy.metadata = self.box.metadata
|
||||
copy.copies = self.box.copies + 1
|
||||
self.box = copy
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
extension Logger {
|
||||
/// How often the `CopyCountingLogHandler` of this logger copied its box.
|
||||
var handlerCopies: Int? {
|
||||
(self.handler as? CopyCountingLogHandler)?.copies
|
||||
}
|
||||
}
|
||||
|
||||
// MARK: - Sendable
|
||||
|
||||
extension TestLogHandler: @unchecked Sendable {}
|
||||
extension CopyCountingLogHandler.Box: @unchecked Sendable {}
|
||||
extension Recorder: @unchecked Sendable {}
|
||||
extension Config: @unchecked Sendable {}
|
||||
extension MDC: @unchecked Sendable {}
|
||||
Reference in new issue
Block a user