apple/swift-log (apple/swift-log)
### [`v1.5.4`](https://togithub.com/apple/swift-log/releases/tag/1.5.4)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.5.3...1.5.4)
#### What's Changed
##### Cleanups & minor compatibility improvements
- Don't assume localtime() result is non-nil by [@gwynne](https://togithub.com/gwynne) in [https://github.com/apple/swift-log/pull/280](https://togithub.com/apple/swift-log/pull/280)
- Changes to build with Musl. by [@al45tair](https://togithub.com/al45tair) in [https://github.com/apple/swift-log/pull/283](https://togithub.com/apple/swift-log/pull/283)
##### Non code changes
- Add CocoaLumberjack to list of logging backends by [@ffried](https://togithub.com/ffried) in [https://github.com/apple/swift-log/pull/276](https://togithub.com/apple/swift-log/pull/276)
- update CI script by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/281](https://togithub.com/apple/swift-log/pull/281)
- Update README.md by [@0xTim](https://togithub.com/0xTim) in [https://github.com/apple/swift-log/pull/279](https://togithub.com/apple/swift-log/pull/279)
#### New Contributors
- [@ffried](https://togithub.com/ffried) made their first contribution in [https://github.com/apple/swift-log/pull/276](https://togithub.com/apple/swift-log/pull/276)
- [@0xTim](https://togithub.com/0xTim) made their first contribution in [https://github.com/apple/swift-log/pull/279](https://togithub.com/apple/swift-log/pull/279)
- [@al45tair](https://togithub.com/al45tair) made their first contribution in [https://github.com/apple/swift-log/pull/283](https://togithub.com/apple/swift-log/pull/283)
**Full Changelog**: https://github.com/apple/swift-log/compare/1.5.3...1.5.4
### [`v1.5.3`](https://togithub.com/apple/swift-log/releases/tag/1.5.3)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.5.2...1.5.3)
#### What's Changed
##### Cleanups & minor compatibility improvements
- Remove leftover 5.0 Package.swift; not supported since 1.5.0 by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/259](https://togithub.com/apple/swift-log/pull/259)
- Use #if canImport(Darwin) where possible by [@FranzBusch](https://togithub.com/FranzBusch) in [https://github.com/apple/swift-log/pull/269](https://togithub.com/apple/swift-log/pull/269)
- docs: fix typos by [@FannyGautierr](https://togithub.com/FannyGautierr) in [https://github.com/apple/swift-log/pull/272](https://togithub.com/apple/swift-log/pull/272)
##### Non code changes
- Add DiscordBM/DiscordLogger to loggers list by [@MahdiBM](https://togithub.com/MahdiBM) in [https://github.com/apple/swift-log/pull/257](https://togithub.com/apple/swift-log/pull/257)
- Update CI by [@yim-lee](https://togithub.com/yim-lee) in [https://github.com/apple/swift-log/pull/264](https://togithub.com/apple/swift-log/pull/264)
- update code of conduct by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/268](https://togithub.com/apple/swift-log/pull/268)
- Fix DiscordLogger link by [@MahdiBM](https://togithub.com/MahdiBM) in [https://github.com/apple/swift-log/pull/266](https://togithub.com/apple/swift-log/pull/266)
- add kiliankoe/swift-log-matrix to list of backends by [@kiliankoe](https://togithub.com/kiliankoe) in [https://github.com/apple/swift-log/pull/263](https://togithub.com/apple/swift-log/pull/263)
#### New Contributors
- [@MahdiBM](https://togithub.com/MahdiBM) made their first contribution in [https://github.com/apple/swift-log/pull/257](https://togithub.com/apple/swift-log/pull/257)
- [@kiliankoe](https://togithub.com/kiliankoe) made their first contribution in [https://github.com/apple/swift-log/pull/263](https://togithub.com/apple/swift-log/pull/263)
- [@FannyGautierr](https://togithub.com/FannyGautierr) made their first contribution in [https://github.com/apple/swift-log/pull/272](https://togithub.com/apple/swift-log/pull/272)
**Full Changelog**: https://github.com/apple/swift-log/compare/1.5.2...1.5.3
### [`v1.5.2`](https://togithub.com/apple/swift-log/releases/tag/1.5.2)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.5.1...1.5.2)
#### Primary change
Address too aggressive warning logging on LogHandlers that do not support `MetadataProvider`. The warning would be emitted too frequently, resulting in flooding logs with warnings. Instead, the warning is now emitted once per log handler type.
#### What's Changed
- Avoid logging warnings when handler does not support metadataproviders by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/252](https://togithub.com/apple/swift-log/pull/252)
- Handle providers properly in multiplex log handler by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/254](https://togithub.com/apple/swift-log/pull/254)
- Add CI for Swift 5.8 and update nightly to Ubuntu 22.04 by [@yim-lee](https://togithub.com/yim-lee) in [https://github.com/apple/swift-log/pull/255](https://togithub.com/apple/swift-log/pull/255)
**Full Changelog**: https://github.com/apple/swift-log/compare/1.5.1...1.5.2
### [`v1.5.1`](https://togithub.com/apple/swift-log/releases/tag/1.5.1)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.5.0...1.5.1)
#### Summary
This patch release focuses on minor cleanups to ergonomics of setting metadata providers with the default stream log handlers, and fixes a bug in the default handler not printing the provided extra metadata by default (it does now).
Thank you to [@slashmo](https://togithub.com/slashmo) for quickly noticing and providing a patch for the latter!
#### What's Changed
- Allow passing explicit provider into the stream handlers by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/250](https://togithub.com/apple/swift-log/pull/250)
- Emit correct metadata from StreamLogHandler by [@slashmo](https://togithub.com/slashmo) in [https://github.com/apple/swift-log/pull/251](https://togithub.com/apple/swift-log/pull/251)
**Full Changelog**: https://github.com/apple/swift-log/compare/1.5.0...1.5.1
### [`v1.5.0`](https://togithub.com/apple/swift-log/releases/tag/1.5.0)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.4.4...1.5.0)
### Changes
#### Swift version support
This release drops support for Swift 5.0.
Swift 5.1+ remain supported for the time being.
#### Logger.MetadataProvider
This release introduces metadata providers!
They are an additional way to add metadata to your log statements automatically whenever a log statement is about to be made. This works extremely well with systems like distributed tracing, that may pick up trace identifiers and other information from the task-local context from where the log statement is being made.
The feature came with a [swift evolution style proposal](https://togithub.com/apple/swift-log/blob/main/proposals/0001-metadata-providers.md) introduction to the "why?" and "how?" of this feature you may find interesting.
Metadata providers are used like this:
```swift
import Logging
enum Namespace {
@TaskLocal static var simpleTraceID: String?
}
let simpleTraceIDMetadataProvider = Logger.MetadataProvider {
guard let traceID = Namespace.simpleTraceID else {
return [:]
}
return ["simple-trace-id": .string(traceID)]
}
LoggingSystem.bootstrap({ label, metadataProvider in
myCoolLogHandler(label: label, metadataProvider: metadataProvider)
}, metadataProvider: simpleTraceIDMetadataProvider)
```
which in turn makes every `Logger` on this `LoggingSystem` add this contextual metadata to log statements automatically:
```swift
let log = Logger(label: "hello")
Namespace.$simpleTraceID.withValue("1234-5678") {
test()
}
func test() {
log.info("test log statement")
}
// [info] [simple-trace-id: 1234-5678] test log statement
```
##### Adoption in `LogHandler`s
In order to support this new feature in your log handlers, please make it accept a `MetadataProvider?` at creation, and store it as:
```swift
struct MyHandler: LogHandler {
// ...
public var metadataProvider: Logger.MetadataProvider?
// ...
}
```
#### What's Changed
##### Highlight
- Metadata Providers (e.g. for Distributed Tracing) in LogHandlers by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/238](https://togithub.com/apple/swift-log/pull/238)
##### Other changes
- \[docs] Minimal docc setup and landing page by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/226](https://togithub.com/apple/swift-log/pull/226)
- \=docc Make docs use symbol references by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/230](https://togithub.com/apple/swift-log/pull/230)
- \=docc Move to multiple Package.swift files by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/231](https://togithub.com/apple/swift-log/pull/231)
- Undo 5.7 package files, not needed yet by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/232](https://togithub.com/apple/swift-log/pull/232)
- Update README: Add missing Source param by [@Rusik](https://togithub.com/Rusik) in [https://github.com/apple/swift-log/pull/233](https://togithub.com/apple/swift-log/pull/233)
- Fix build for wasm by [@ahti](https://togithub.com/ahti) in [https://github.com/apple/swift-log/pull/236](https://togithub.com/apple/swift-log/pull/236)
- Add .spi.yml for Swift Package Index DocC support by [@yim-lee](https://togithub.com/yim-lee) in [https://github.com/apple/swift-log/pull/240](https://togithub.com/apple/swift-log/pull/240)
- Fixes link to Supabase repository in README.md by [@timobollwerk](https://togithub.com/timobollwerk) in [https://github.com/apple/swift-log/pull/245](https://togithub.com/apple/swift-log/pull/245)
#### New Contributors
- [@Rusik](https://togithub.com/Rusik) made their first contribution in [https://github.com/apple/swift-log/pull/233](https://togithub.com/apple/swift-log/pull/233)
- [@ahti](https://togithub.com/ahti) made their first contribution in [https://github.com/apple/swift-log/pull/236](https://togithub.com/apple/swift-log/pull/236)
- [@timobollwerk](https://togithub.com/timobollwerk) made their first contribution in [https://github.com/apple/swift-log/pull/245](https://togithub.com/apple/swift-log/pull/245)
**Full Changelog**: https://github.com/apple/swift-log/compare/1.4.4...1.5.0
### [`v1.4.4`](https://togithub.com/apple/swift-log/releases/tag/1.4.4)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.4.3...1.4.4)
#### Sendable fixup for 1.4.3
The 1.4.3 release carefully introduced `Sendable` across the library; sadly we missed that `5.6.x` Swift series treat a "missing marker protocol conformance for Sendable" as an *error* while it is intended to be a *warning* as which it is correctly reported in Swift 5.7.
This release fixes this by *not requiring* that values stored in `Logger.MetadataValue.stringConvertible` must be Sendable, however practically speaking they should be thread-safe in any case, as it is not guaranteed in any way when/where this string convertible value will be invoked from.
This release contains no other changes from 1.4.3.
#### What's Changed
- \[sendable] Sendable conformance checks cause errors on 5.6 but warnings on 5.7 by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/229](https://togithub.com/apple/swift-log/pull/229)
**Full Changelog**: https://github.com/apple/swift-log/compare/1.4.3...1.4.4
### [`v1.4.3`](https://togithub.com/apple/swift-log/releases/tag/1.4.3)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.4.2...1.4.3)
#### Highlights
Loggers and all related types are now `Sendable`, including metadata values which have to be Sendable as well.
When using from Swift that is concurrency aware, you may be getting warnings where you didn't before, these are all correct though - you need to be ready for e.g. logger metadata to be accessed from another thread. Thankfully values logged this way should usually be sendable to begin with, preferably value types.
For more details see: [https://github.com/apple/swift-log/pull/218](https://togithub.com/apple/swift-log/pull/218)
#### What's Changed
- Remove references to Swift 4 by [@steipete](https://togithub.com/steipete) in [https://github.com/apple/swift-log/pull/186](https://togithub.com/apple/swift-log/pull/186)
- Include source in StreamLogHandler output by [@slashmo](https://togithub.com/slashmo) in [https://github.com/apple/swift-log/pull/189](https://togithub.com/apple/swift-log/pull/189)
- Improve StdioOutputStream with fwrite ([#180](https://togithub.com/apple/swift-log/issues/180)) by [@felipejinli](https://togithub.com/felipejinli) in [https://github.com/apple/swift-log/pull/188](https://togithub.com/apple/swift-log/pull/188)
- use #fileID for Swift 5.3+ by [@weissi](https://togithub.com/weissi) in [https://github.com/apple/swift-log/pull/187](https://togithub.com/apple/swift-log/pull/187)
- Add `SwiftLogNoOpLogHandler.init(_: String)` by [@glbrntt](https://togithub.com/glbrntt) in [https://github.com/apple/swift-log/pull/194](https://togithub.com/apple/swift-log/pull/194)
- update 5.4 to release docker image by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/196](https://togithub.com/apple/swift-log/pull/196)
- adopt security guidelines by [@weissi](https://togithub.com/weissi) in [https://github.com/apple/swift-log/pull/197](https://togithub.com/apple/swift-log/pull/197)
- Logging: avoid a deprecation warning on Windows by [@compnerd](https://togithub.com/compnerd) in [https://github.com/apple/swift-log/pull/199](https://togithub.com/apple/swift-log/pull/199)
- Tests: enable tests on Windows by [@compnerd](https://togithub.com/compnerd) in [https://github.com/apple/swift-log/pull/198](https://togithub.com/apple/swift-log/pull/198)
- Add swift-log-elk as a new logging backend to the Readme by [@philippzagar](https://togithub.com/philippzagar) in [https://github.com/apple/swift-log/pull/201](https://togithub.com/apple/swift-log/pull/201)
- Add swift-log-SwiftyBeaver as a new logging backend to README.md by [@ShivaHuang](https://togithub.com/ShivaHuang) in [https://github.com/apple/swift-log/pull/203](https://togithub.com/apple/swift-log/pull/203)
- fix jazzy issues on older versions of ubuntu by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/210](https://togithub.com/apple/swift-log/pull/210)
- add docker setup for 5.5 by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/211](https://togithub.com/apple/swift-log/pull/211)
- Android support by [@andriydruk](https://togithub.com/andriydruk) in [https://github.com/apple/swift-log/pull/209](https://togithub.com/apple/swift-log/pull/209)
- update doc generation script by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/213](https://togithub.com/apple/swift-log/pull/213)
- Add 5.6 nightly CI by [@Lukasa](https://togithub.com/Lukasa) in [https://github.com/apple/swift-log/pull/214](https://togithub.com/apple/swift-log/pull/214)
- ci update by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/219](https://togithub.com/apple/swift-log/pull/219)
- Add binaryscraping/swift-log-supabase to README by [@grsouza](https://togithub.com/grsouza) in [https://github.com/apple/swift-log/pull/221](https://togithub.com/apple/swift-log/pull/221)
- better abstration for LoggingSystem state by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/222](https://togithub.com/apple/swift-log/pull/222)
- adopt sendable by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/218](https://togithub.com/apple/swift-log/pull/218)
- minimal DocC markdown to order Logger.Levels by [@heckj](https://togithub.com/heckj) in [https://github.com/apple/swift-log/pull/225](https://togithub.com/apple/swift-log/pull/225)
#### New Contributors
- [@steipete](https://togithub.com/steipete) made their first contribution in [https://github.com/apple/swift-log/pull/186](https://togithub.com/apple/swift-log/pull/186)
- [@slashmo](https://togithub.com/slashmo) made their first contribution in [https://github.com/apple/swift-log/pull/189](https://togithub.com/apple/swift-log/pull/189)
- [@felipejinli](https://togithub.com/felipejinli) made their first contribution in [https://github.com/apple/swift-log/pull/188](https://togithub.com/apple/swift-log/pull/188)
- [@philippzagar](https://togithub.com/philippzagar) made their first contribution in [https://github.com/apple/swift-log/pull/201](https://togithub.com/apple/swift-log/pull/201)
- [@andriydruk](https://togithub.com/andriydruk) made their first contribution in [https://github.com/apple/swift-log/pull/209](https://togithub.com/apple/swift-log/pull/209)
- [@Lukasa](https://togithub.com/Lukasa) made their first contribution in [https://github.com/apple/swift-log/pull/214](https://togithub.com/apple/swift-log/pull/214)
- [@grsouza](https://togithub.com/grsouza) made their first contribution in [https://github.com/apple/swift-log/pull/221](https://togithub.com/apple/swift-log/pull/221)
- [@heckj](https://togithub.com/heckj) made their first contribution in [https://github.com/apple/swift-log/pull/225](https://togithub.com/apple/swift-log/pull/225)
**Full Changelog**: https://github.com/apple/swift-log/compare/1.4.2...1.4.3
### [`v1.4.2`](https://togithub.com/apple/swift-log/releases/tag/1.4.2)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.4.1...1.4.2)
This release fixes a single bug in the propagation of the `function` parameter in the source-less `Logger.trace` function.
For more details refer to [https://github.com/apple/swift-log/pull/185](https://togithub.com/apple/swift-log/pull/185) - thank you noticing and fixing the issue [@saulbaro](https://togithub.com/saulbaro)!
You can find additional details on all changes in this release in the [1.4.2 milestone](https://togithub.com/apple/swift-log/milestone/8?closed=1).
### [`v1.4.1`](https://togithub.com/apple/swift-log/releases/tag/1.4.1)
[Compare Source](https://togithub.com/apple/swift-log/compare/1.4.0...1.4.1)
This patch release fixes some compatibility issues, including a Windows compatibility issue as well as wrongly removed APIs in the 1.3.0->1.4.0 transition.
No new features were added in this release.
You can refer to the detailed changes by inspecting the issues linked form the [1.4.1 milestone](https://togithub.com/apple/swift-log/milestone/7?closed=1).
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR has been generated by Mend Renovate. View repository job log here.
This PR contains the following updates:
from: "1.4.0"->from: "1.5.4"Release Notes
apple/swift-log (apple/swift-log)
### [`v1.5.4`](https://togithub.com/apple/swift-log/releases/tag/1.5.4) [Compare Source](https://togithub.com/apple/swift-log/compare/1.5.3...1.5.4) #### What's Changed ##### Cleanups & minor compatibility improvements - Don't assume localtime() result is non-nil by [@gwynne](https://togithub.com/gwynne) in [https://github.com/apple/swift-log/pull/280](https://togithub.com/apple/swift-log/pull/280) - Changes to build with Musl. by [@al45tair](https://togithub.com/al45tair) in [https://github.com/apple/swift-log/pull/283](https://togithub.com/apple/swift-log/pull/283) ##### Non code changes - Add CocoaLumberjack to list of logging backends by [@ffried](https://togithub.com/ffried) in [https://github.com/apple/swift-log/pull/276](https://togithub.com/apple/swift-log/pull/276) - update CI script by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/281](https://togithub.com/apple/swift-log/pull/281) - Update README.md by [@0xTim](https://togithub.com/0xTim) in [https://github.com/apple/swift-log/pull/279](https://togithub.com/apple/swift-log/pull/279) #### New Contributors - [@ffried](https://togithub.com/ffried) made their first contribution in [https://github.com/apple/swift-log/pull/276](https://togithub.com/apple/swift-log/pull/276) - [@0xTim](https://togithub.com/0xTim) made their first contribution in [https://github.com/apple/swift-log/pull/279](https://togithub.com/apple/swift-log/pull/279) - [@al45tair](https://togithub.com/al45tair) made their first contribution in [https://github.com/apple/swift-log/pull/283](https://togithub.com/apple/swift-log/pull/283) **Full Changelog**: https://github.com/apple/swift-log/compare/1.5.3...1.5.4 ### [`v1.5.3`](https://togithub.com/apple/swift-log/releases/tag/1.5.3) [Compare Source](https://togithub.com/apple/swift-log/compare/1.5.2...1.5.3) #### What's Changed ##### Cleanups & minor compatibility improvements - Remove leftover 5.0 Package.swift; not supported since 1.5.0 by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/259](https://togithub.com/apple/swift-log/pull/259) - Use #if canImport(Darwin) where possible by [@FranzBusch](https://togithub.com/FranzBusch) in [https://github.com/apple/swift-log/pull/269](https://togithub.com/apple/swift-log/pull/269) - docs: fix typos by [@FannyGautierr](https://togithub.com/FannyGautierr) in [https://github.com/apple/swift-log/pull/272](https://togithub.com/apple/swift-log/pull/272) ##### Non code changes - Add DiscordBM/DiscordLogger to loggers list by [@MahdiBM](https://togithub.com/MahdiBM) in [https://github.com/apple/swift-log/pull/257](https://togithub.com/apple/swift-log/pull/257) - Update CI by [@yim-lee](https://togithub.com/yim-lee) in [https://github.com/apple/swift-log/pull/264](https://togithub.com/apple/swift-log/pull/264) - update code of conduct by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/268](https://togithub.com/apple/swift-log/pull/268) - Fix DiscordLogger link by [@MahdiBM](https://togithub.com/MahdiBM) in [https://github.com/apple/swift-log/pull/266](https://togithub.com/apple/swift-log/pull/266) - add kiliankoe/swift-log-matrix to list of backends by [@kiliankoe](https://togithub.com/kiliankoe) in [https://github.com/apple/swift-log/pull/263](https://togithub.com/apple/swift-log/pull/263) #### New Contributors - [@MahdiBM](https://togithub.com/MahdiBM) made their first contribution in [https://github.com/apple/swift-log/pull/257](https://togithub.com/apple/swift-log/pull/257) - [@kiliankoe](https://togithub.com/kiliankoe) made their first contribution in [https://github.com/apple/swift-log/pull/263](https://togithub.com/apple/swift-log/pull/263) - [@FannyGautierr](https://togithub.com/FannyGautierr) made their first contribution in [https://github.com/apple/swift-log/pull/272](https://togithub.com/apple/swift-log/pull/272) **Full Changelog**: https://github.com/apple/swift-log/compare/1.5.2...1.5.3 ### [`v1.5.2`](https://togithub.com/apple/swift-log/releases/tag/1.5.2) [Compare Source](https://togithub.com/apple/swift-log/compare/1.5.1...1.5.2) #### Primary change Address too aggressive warning logging on LogHandlers that do not support `MetadataProvider`. The warning would be emitted too frequently, resulting in flooding logs with warnings. Instead, the warning is now emitted once per log handler type. #### What's Changed - Avoid logging warnings when handler does not support metadataproviders by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/252](https://togithub.com/apple/swift-log/pull/252) - Handle providers properly in multiplex log handler by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/254](https://togithub.com/apple/swift-log/pull/254) - Add CI for Swift 5.8 and update nightly to Ubuntu 22.04 by [@yim-lee](https://togithub.com/yim-lee) in [https://github.com/apple/swift-log/pull/255](https://togithub.com/apple/swift-log/pull/255) **Full Changelog**: https://github.com/apple/swift-log/compare/1.5.1...1.5.2 ### [`v1.5.1`](https://togithub.com/apple/swift-log/releases/tag/1.5.1) [Compare Source](https://togithub.com/apple/swift-log/compare/1.5.0...1.5.1) #### Summary This patch release focuses on minor cleanups to ergonomics of setting metadata providers with the default stream log handlers, and fixes a bug in the default handler not printing the provided extra metadata by default (it does now). Thank you to [@slashmo](https://togithub.com/slashmo) for quickly noticing and providing a patch for the latter! #### What's Changed - Allow passing explicit provider into the stream handlers by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/250](https://togithub.com/apple/swift-log/pull/250) - Emit correct metadata from StreamLogHandler by [@slashmo](https://togithub.com/slashmo) in [https://github.com/apple/swift-log/pull/251](https://togithub.com/apple/swift-log/pull/251) **Full Changelog**: https://github.com/apple/swift-log/compare/1.5.0...1.5.1 ### [`v1.5.0`](https://togithub.com/apple/swift-log/releases/tag/1.5.0) [Compare Source](https://togithub.com/apple/swift-log/compare/1.4.4...1.5.0) ### Changes #### Swift version support This release drops support for Swift 5.0. Swift 5.1+ remain supported for the time being. #### Logger.MetadataProvider This release introduces metadata providers! They are an additional way to add metadata to your log statements automatically whenever a log statement is about to be made. This works extremely well with systems like distributed tracing, that may pick up trace identifiers and other information from the task-local context from where the log statement is being made. The feature came with a [swift evolution style proposal](https://togithub.com/apple/swift-log/blob/main/proposals/0001-metadata-providers.md) introduction to the "why?" and "how?" of this feature you may find interesting. Metadata providers are used like this: ```swift import Logging enum Namespace { @TaskLocal static var simpleTraceID: String? } let simpleTraceIDMetadataProvider = Logger.MetadataProvider { guard let traceID = Namespace.simpleTraceID else { return [:] } return ["simple-trace-id": .string(traceID)] } LoggingSystem.bootstrap({ label, metadataProvider in myCoolLogHandler(label: label, metadataProvider: metadataProvider) }, metadataProvider: simpleTraceIDMetadataProvider) ``` which in turn makes every `Logger` on this `LoggingSystem` add this contextual metadata to log statements automatically: ```swift let log = Logger(label: "hello") Namespace.$simpleTraceID.withValue("1234-5678") { test() } func test() { log.info("test log statement") } // [info] [simple-trace-id: 1234-5678] test log statement ``` ##### Adoption in `LogHandler`s In order to support this new feature in your log handlers, please make it accept a `MetadataProvider?` at creation, and store it as: ```swift struct MyHandler: LogHandler { // ... public var metadataProvider: Logger.MetadataProvider? // ... } ``` #### What's Changed ##### Highlight - Metadata Providers (e.g. for Distributed Tracing) in LogHandlers by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/238](https://togithub.com/apple/swift-log/pull/238) ##### Other changes - \[docs] Minimal docc setup and landing page by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/226](https://togithub.com/apple/swift-log/pull/226) - \=docc Make docs use symbol references by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/230](https://togithub.com/apple/swift-log/pull/230) - \=docc Move to multiple Package.swift files by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/231](https://togithub.com/apple/swift-log/pull/231) - Undo 5.7 package files, not needed yet by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/232](https://togithub.com/apple/swift-log/pull/232) - Update README: Add missing Source param by [@Rusik](https://togithub.com/Rusik) in [https://github.com/apple/swift-log/pull/233](https://togithub.com/apple/swift-log/pull/233) - Fix build for wasm by [@ahti](https://togithub.com/ahti) in [https://github.com/apple/swift-log/pull/236](https://togithub.com/apple/swift-log/pull/236) - Add .spi.yml for Swift Package Index DocC support by [@yim-lee](https://togithub.com/yim-lee) in [https://github.com/apple/swift-log/pull/240](https://togithub.com/apple/swift-log/pull/240) - Fixes link to Supabase repository in README.md by [@timobollwerk](https://togithub.com/timobollwerk) in [https://github.com/apple/swift-log/pull/245](https://togithub.com/apple/swift-log/pull/245) #### New Contributors - [@Rusik](https://togithub.com/Rusik) made their first contribution in [https://github.com/apple/swift-log/pull/233](https://togithub.com/apple/swift-log/pull/233) - [@ahti](https://togithub.com/ahti) made their first contribution in [https://github.com/apple/swift-log/pull/236](https://togithub.com/apple/swift-log/pull/236) - [@timobollwerk](https://togithub.com/timobollwerk) made their first contribution in [https://github.com/apple/swift-log/pull/245](https://togithub.com/apple/swift-log/pull/245) **Full Changelog**: https://github.com/apple/swift-log/compare/1.4.4...1.5.0 ### [`v1.4.4`](https://togithub.com/apple/swift-log/releases/tag/1.4.4) [Compare Source](https://togithub.com/apple/swift-log/compare/1.4.3...1.4.4) #### Sendable fixup for 1.4.3 The 1.4.3 release carefully introduced `Sendable` across the library; sadly we missed that `5.6.x` Swift series treat a "missing marker protocol conformance for Sendable" as an *error* while it is intended to be a *warning* as which it is correctly reported in Swift 5.7. This release fixes this by *not requiring* that values stored in `Logger.MetadataValue.stringConvertible` must be Sendable, however practically speaking they should be thread-safe in any case, as it is not guaranteed in any way when/where this string convertible value will be invoked from. This release contains no other changes from 1.4.3. #### What's Changed - \[sendable] Sendable conformance checks cause errors on 5.6 but warnings on 5.7 by [@ktoso](https://togithub.com/ktoso) in [https://github.com/apple/swift-log/pull/229](https://togithub.com/apple/swift-log/pull/229) **Full Changelog**: https://github.com/apple/swift-log/compare/1.4.3...1.4.4 ### [`v1.4.3`](https://togithub.com/apple/swift-log/releases/tag/1.4.3) [Compare Source](https://togithub.com/apple/swift-log/compare/1.4.2...1.4.3) #### Highlights Loggers and all related types are now `Sendable`, including metadata values which have to be Sendable as well. When using from Swift that is concurrency aware, you may be getting warnings where you didn't before, these are all correct though - you need to be ready for e.g. logger metadata to be accessed from another thread. Thankfully values logged this way should usually be sendable to begin with, preferably value types. For more details see: [https://github.com/apple/swift-log/pull/218](https://togithub.com/apple/swift-log/pull/218) #### What's Changed - Remove references to Swift 4 by [@steipete](https://togithub.com/steipete) in [https://github.com/apple/swift-log/pull/186](https://togithub.com/apple/swift-log/pull/186) - Include source in StreamLogHandler output by [@slashmo](https://togithub.com/slashmo) in [https://github.com/apple/swift-log/pull/189](https://togithub.com/apple/swift-log/pull/189) - Improve StdioOutputStream with fwrite ([#180](https://togithub.com/apple/swift-log/issues/180)) by [@felipejinli](https://togithub.com/felipejinli) in [https://github.com/apple/swift-log/pull/188](https://togithub.com/apple/swift-log/pull/188) - use #fileID for Swift 5.3+ by [@weissi](https://togithub.com/weissi) in [https://github.com/apple/swift-log/pull/187](https://togithub.com/apple/swift-log/pull/187) - Add `SwiftLogNoOpLogHandler.init(_: String)` by [@glbrntt](https://togithub.com/glbrntt) in [https://github.com/apple/swift-log/pull/194](https://togithub.com/apple/swift-log/pull/194) - update 5.4 to release docker image by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/196](https://togithub.com/apple/swift-log/pull/196) - adopt security guidelines by [@weissi](https://togithub.com/weissi) in [https://github.com/apple/swift-log/pull/197](https://togithub.com/apple/swift-log/pull/197) - Logging: avoid a deprecation warning on Windows by [@compnerd](https://togithub.com/compnerd) in [https://github.com/apple/swift-log/pull/199](https://togithub.com/apple/swift-log/pull/199) - Tests: enable tests on Windows by [@compnerd](https://togithub.com/compnerd) in [https://github.com/apple/swift-log/pull/198](https://togithub.com/apple/swift-log/pull/198) - Add swift-log-elk as a new logging backend to the Readme by [@philippzagar](https://togithub.com/philippzagar) in [https://github.com/apple/swift-log/pull/201](https://togithub.com/apple/swift-log/pull/201) - Add swift-log-SwiftyBeaver as a new logging backend to README.md by [@ShivaHuang](https://togithub.com/ShivaHuang) in [https://github.com/apple/swift-log/pull/203](https://togithub.com/apple/swift-log/pull/203) - fix jazzy issues on older versions of ubuntu by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/210](https://togithub.com/apple/swift-log/pull/210) - add docker setup for 5.5 by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/211](https://togithub.com/apple/swift-log/pull/211) - Android support by [@andriydruk](https://togithub.com/andriydruk) in [https://github.com/apple/swift-log/pull/209](https://togithub.com/apple/swift-log/pull/209) - update doc generation script by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/213](https://togithub.com/apple/swift-log/pull/213) - Add 5.6 nightly CI by [@Lukasa](https://togithub.com/Lukasa) in [https://github.com/apple/swift-log/pull/214](https://togithub.com/apple/swift-log/pull/214) - ci update by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/219](https://togithub.com/apple/swift-log/pull/219) - Add binaryscraping/swift-log-supabase to README by [@grsouza](https://togithub.com/grsouza) in [https://github.com/apple/swift-log/pull/221](https://togithub.com/apple/swift-log/pull/221) - better abstration for LoggingSystem state by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/222](https://togithub.com/apple/swift-log/pull/222) - adopt sendable by [@tomerd](https://togithub.com/tomerd) in [https://github.com/apple/swift-log/pull/218](https://togithub.com/apple/swift-log/pull/218) - minimal DocC markdown to order Logger.Levels by [@heckj](https://togithub.com/heckj) in [https://github.com/apple/swift-log/pull/225](https://togithub.com/apple/swift-log/pull/225) #### New Contributors - [@steipete](https://togithub.com/steipete) made their first contribution in [https://github.com/apple/swift-log/pull/186](https://togithub.com/apple/swift-log/pull/186) - [@slashmo](https://togithub.com/slashmo) made their first contribution in [https://github.com/apple/swift-log/pull/189](https://togithub.com/apple/swift-log/pull/189) - [@felipejinli](https://togithub.com/felipejinli) made their first contribution in [https://github.com/apple/swift-log/pull/188](https://togithub.com/apple/swift-log/pull/188) - [@philippzagar](https://togithub.com/philippzagar) made their first contribution in [https://github.com/apple/swift-log/pull/201](https://togithub.com/apple/swift-log/pull/201) - [@andriydruk](https://togithub.com/andriydruk) made their first contribution in [https://github.com/apple/swift-log/pull/209](https://togithub.com/apple/swift-log/pull/209) - [@Lukasa](https://togithub.com/Lukasa) made their first contribution in [https://github.com/apple/swift-log/pull/214](https://togithub.com/apple/swift-log/pull/214) - [@grsouza](https://togithub.com/grsouza) made their first contribution in [https://github.com/apple/swift-log/pull/221](https://togithub.com/apple/swift-log/pull/221) - [@heckj](https://togithub.com/heckj) made their first contribution in [https://github.com/apple/swift-log/pull/225](https://togithub.com/apple/swift-log/pull/225) **Full Changelog**: https://github.com/apple/swift-log/compare/1.4.2...1.4.3 ### [`v1.4.2`](https://togithub.com/apple/swift-log/releases/tag/1.4.2) [Compare Source](https://togithub.com/apple/swift-log/compare/1.4.1...1.4.2) This release fixes a single bug in the propagation of the `function` parameter in the source-less `Logger.trace` function. For more details refer to [https://github.com/apple/swift-log/pull/185](https://togithub.com/apple/swift-log/pull/185) - thank you noticing and fixing the issue [@saulbaro](https://togithub.com/saulbaro)! You can find additional details on all changes in this release in the [1.4.2 milestone](https://togithub.com/apple/swift-log/milestone/8?closed=1). ### [`v1.4.1`](https://togithub.com/apple/swift-log/releases/tag/1.4.1) [Compare Source](https://togithub.com/apple/swift-log/compare/1.4.0...1.4.1) This patch release fixes some compatibility issues, including a Windows compatibility issue as well as wrongly removed APIs in the 1.3.0->1.4.0 transition. No new features were added in this release. You can refer to the detailed changes by inspecting the issues linked form the [1.4.1 milestone](https://togithub.com/apple/swift-log/milestone/7?closed=1).Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Mend Renovate. View repository job log here.