MultiplexLogHandler.metadataProvider setter replace the initializer's provider (#537)
### Motivation: `MultiplexLogHandler.metadataProvider`'s setter only forwards the new provider to the underlying handlers. Since #522, `log(event:)` also merges the provider passed to `init(_:metadataProvider:)` on top of the underlying handlers' metadata, so after a set that old provider still overrides the new one for conflicting keys, setting `nil` doesn't remove it, and the getter keeps returning it. This shows up through `Logger(label:metadataProvider:)`, which calls the factory and then sets `handler.metadataProvider`. If the bootstrapped factory returns a `MultiplexLogHandler` with its own provider, the provider the library passed is silently overridden. With a plain handler the same code uses the library's provider, which is what `Logger(label:metadataProvider:)` documents ("the custom metadata provider this logger should invoke, instead of the system wide bootstrapped one"). ### Modifications: - In the setter, also replace the multiplex handler's own provider with the new value. It is still forwarded to the underlying handlers as before. - Document the setter. - Add regression tests: setting a provider replaces the initializer's provider for one and two handlers, and setting `nil` clears it (both the getter and emitted logs). Another test covers an underlying handler that doesn't support metadata providers. I kept forwarding to the underlying handlers and replace the multiplex handler's own provider as well, rather than clearing it. Clearing it would drop provider metadata for underlying handlers that use the default `metadataProvider` implementation in the `Logger(label:metadataProvider:)` case, which works today. ### Result: After `handler.metadataProvider = p`, logs and the getter use `p`. After `handler.metadataProvider = nil`, no provider metadata is added. In the common setup where the factory passes its provider into the `MultiplexLogHandler` initializer, the number of provider calls per log stays the same. When the multiplex handler had no provider of its own, a set now also applies the provider once at the multiplex level, so underlying handlers without provider support get its metadata too. The new tests fail on main and pass with this change. All tests pass locally on macOS (Swift 6.3.3), and `swift format lint` is clean on the changed files. I couldn't run the benchmarks locally. This change was drafted with Claude Code (claude-opus-5-5); the test results above are from the runs described.
SwiftLog
This repository contains a logging API implementation for Swift. SwiftLog provides a unified, performant, and ergonomic logging API that can be adopted by libraries and applications across the Swift ecosystem.
- 📚 Documentation and tutorials are available on the Swift Package Index
- 🚀 Contributions are welcome, please see CONTRIBUTING.md
- 🪪 License is Apache 2.0, repeated in LICENSE.txt
- 🔒 Security issues should be reported via the process in Security
- 🔀 Available Logging Backends: SwiftLog is an API package - you'll want to choose from the many community-maintained logging backends for production use
Quick Start
The following snippet shows how to add SwiftLog to your Swift Package:
// swift-tools-version: 6.2
import PackageDescription
let package = Package(
name: "YourApp",
dependencies: [
.package(url: "https://github.com/apple/swift-log", from: "1.6.0")
],
targets: [
.target(
name: "YourApp",
dependencies: [
.product(name: "Logging", package: "swift-log")
]
)
]
)
Then start logging:
import Logging
// Create a logger
let logger = Logger(label: "com.example.YourApp")
// Log at different levels
logger.info("Application started")
logger.warning("This is a warning")
logger.error("Something went wrong", metadata: ["error": "\(error)"])
// Add metadata for context
var requestLogger = logger
requestLogger[metadataKey: "request-id"] = "\(UUID())"
requestLogger.info("Processing request")
Available log handler backends
The community has built numerous specialized logging backends.
A great way to discover available log backend implementations is searching the
Swift Package Index
for the swift-log keyword.
Building with CMake
While Swift Package Manager (SPM) is the primary build system for development and testing, CMake build support is also available for integrated or mixed build environments if needed. Note that tests are not included in the CMake build, they are managed through Swift Package Manager with swift test.