Compare commits

..
42 Commits
Author SHA1 Message Date
Luc Talatinian 82cf87d893 bump minimum Swift tools version to 6.2.3 (#534)
closes #533
2026-11-20 11:36:25 +00:00
Vladimir Kukushkin 47655e0c23 Adopt /swiftlang CI workflows (#536)
Switch from swift-nio to swiftlang CI workflows. As there is no tag yet
available, let's use the latest hash for now.

### Motivation:

Modernize and unify workflows with swiftlang.

### Modifications:

CI configuration updated.

### Result:

No swift-nio references in CI workflows.
Additionally, Swift tools version triplet is now supported to unblock
#534
2026-11-19 15:36:41 +00:00
Honza Dvorsky d05c8efdae Make benchmarks more reliable by using the scale factor (#539)
### Motivation:

Currently the benchmark machinery overhead is causing a lot of noise in
benchmarks of very efficient/fast code.

### Modifications:

Use the scaling factor to amortize the fixed overhead and let the actual
tested code account for most of the measured metrics.

### Result:

More reliable benchmarks that don't fail 20% of the time.
2026-11-19 09:59:58 +00:00
0z5a c7413d967b Make 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.
2026-11-17 13:24:42 +00:00
Tony Allevato 34b131f794 Support raw-identifier module names in Logger.currentModule. (#535)
When a module name (via `-module-alias`) is a raw identifier (SE-0451),
`#fileID` formats the module component enclosed in backticks (for
example, `` `/a/b/c`/File.swift ``). If the raw identifier contains '/',
splitting on the first '/' in `#fileID` truncates the module name at the
slash inside the backticks.

When `#fileID` starts with a backtick, advance past the matching closing
backtick before searching for the '/' separator that ends the module
name, preserving the enclosing backticks.
2026-11-10 14:27:30 +00:00
e3da040787 Fix metadata priority in MultiplexLogHandler.metadata (#530)
Fixes #498

## Problem

`MultiplexLogHandler` had inconsistent metadata priority:

- `subscript(metadataKey:)` reads the value from the **first** handler
that has the key (documented: "the first handler's values are more
important")
- `metadata` (full dictionary) merged handlers **last-wins**, so the
value came from the **last** handler with that key

## Fix

The `metadata` getter now merges handlers in their initialization order,
keeping the already-stored value on conflicts — the **first handler
wins**, matching the subscript and the docs.

The multiplex handler's own `metadataProvider` still takes priority over
all underlying handlers/providers, matching its documented role ("runs
after all metadata providers of the multiplexed handlers").

## Testing

- Updated `multiplexLogHandlerMetadata_readingHandlerMetadata` and
`multiplexMetadataProviderSet`, which encoded the last-wins behavior
- Extended `multiplexMetadataProviderSet` with subscript-vs-dictionary
consistency checks (both must give the first handler's value on
conflicting keys, including provider-provided metadata)
- Full suite: 174 tests in 17 suites, all passing

---------

Co-authored-by: awaisdev <awais@airtechsolutions.pk>
Co-authored-by: awaisdev5765 <awaisdev5765@users.noreply.github.com>
Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>
2026-11-03 10:57:38 +00:00
Matt Massicotte 209524e4da Remove unnecessary optional so example compiles (#501)
There's an unnecessary optional return here that prevents the example
from compiling.

### Motivation:

It took me a moment to figure out how to fix this, but in the end it was
very straightforward. The `prepareMetadata` doesn't ever need to return
nil.

### Modifications:

A small type change fixes the compilation errors in `log(event:)`

### Result:

The example in the documentation can now be used unmodified.
2026-11-03 10:14:16 +00:00
Krishna Permi c44b210eee Add opt-in millisecond precision to StreamLogHandler timestamp (#483)
`StreamLogHandler` timestamps only have second precision, so when
several log lines land in the same second you can't tell what order they
happened in.

This adds an **opt-in** setting for millisecond precision. The default
output doesn't change, since some users parse it.

**Changes**
- Adds `public var timestampPrecision: TimestampPrecision = .seconds` to
`StreamLogHandler`.
- Adds a nested `TimestampPrecision` enum (`@nonexhaustive`, `Sendable`)
with `.seconds` and `.milliseconds`.
- With `.milliseconds`, the timestamp includes a 3-digit millisecond
field:
  - default (`.seconds`): `2021-11-06T18:47:14+0300 info myapp: message`
  - `.milliseconds`: `2021-11-06T18:47:14.123+0300 info myapp: message`
- How each platform reads the time:
  - Darwin, Linux and Android use `clock_gettime(CLOCK_REALTIME)`.
  - Windows uses `_ftime64_s`.
- WASI only has second resolution (`CLOCK_REALTIME` isn't importable
there), so `.milliseconds` always prints `.000`. The doc comments say
so.
- Both new symbols are added to the DocC reference page.

**Tests**
- The default precision is `.seconds`.
- `.milliseconds` produces the expected format (checked with a regex).
- Milliseconds are always zero-padded to 3 digits.
- The existing output-format tests are unchanged and still pass, which
confirms the default format.

Fixes #212
2026-11-03 09:56:27 +00:00
dependabot[bot] d0f784af9e Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.16 to 0.0.17 (#531)
Bumps
[swiftlang/github-workflows/.github/workflows/soundness.yml](https://github.com/swiftlang/github-workflows)
from 0.0.16 to 0.0.17.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/swiftlang/github-workflows/releases">swiftlang/github-workflows/.github/workflows/soundness.yml's
releases</a>.</em></p>
<blockquote>
<h2>0.0.17</h2>
<h2>What's Changed</h2>
<ul>
<li>Add embedded_wasm_sdk_build_command option to swift_package_test by
<a href="https://github.com/jmschonfeld"><code>@​jmschonfeld</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/323">swiftlang/github-workflows#323</a></li>
<li>Update proposal validation workflow to use Swift 6.4 by <a
href="https://github.com/dempseyatgithub"><code>@​dempseyatgithub</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/328">swiftlang/github-workflows#328</a></li>
<li>Soundness: add additional tool arguments input to API breakage check
by <a href="https://github.com/bkhouri"><code>@​bkhouri</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/324">swiftlang/github-workflows#324</a></li>
<li>Add documentation for the Soundness API breakage check by <a
href="https://github.com/bkhouri"><code>@​bkhouri</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/325">swiftlang/github-workflows#325</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a
href="https://github.com/jmschonfeld"><code>@​jmschonfeld</code></a>
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/323">swiftlang/github-workflows#323</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.16...0.0.17">https://github.com/swiftlang/github-workflows/compare/0.0.16...0.0.17</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/87329d126a6992483ba89aabefa1eaef1e5b0aad"><code>87329d1</code></a>
Add documentation for the Soundness API breakage check (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/325">#325</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/f2b93cfd0a54ad78f875a58c846180f6729f7e28"><code>f2b93cf</code></a>
Soundness: add additional tool arguments input to API breakage check (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/324">#324</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/3a7b5fccc7bb752a47c9ea0a0e605bb774077bc3"><code>3a7b5fc</code></a>
Update proposal validation workflow to use Swift 6.4 (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/328">#328</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/c80652d51ee2b4df69e8d0d26d78a9d2ff466ecd"><code>c80652d</code></a>
Add embedded_wasm_sdk_build_command option to swift_package_test (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/323">#323</a>)</li>
<li>See full diff in <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.16...0.0.17">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=swiftlang/github-workflows/.github/workflows/soundness.yml&package-manager=github_actions&previous-version=0.0.16&new-version=0.0.17)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-26 17:39:20 +00:00
om singhal c9c6bb9d27 Mutate the logger's handler in place on metadata writes (#529)
Give `Logger.handler` a `_modify` accessor and replace its `get` with
`_read`, so metadata writes update the stored handler instead of a copy.

### Motivation:

`Logger.handler` only has `get` and `set`. A write such as
`logger[metadataKey: "k"] = "v"` gets a copy of the handler, writes to
it while the stored handler still shares the metadata dictionary, and
sets it back. So every write copies the whole dictionary, and
`withLogger(mergingMetadata:)` does that once per key.

### Modifications:

- Give `Logger.handler` `_read`, `set` and `_modify` accessors. `_read`
yields the stored handler. `_modify` keeps the existing uniqueness check
on the storage and then yields the stored handler, so metadata and log
level writes change it in place. `set` keeps the same check for plain
`logger.handler = newHandler` assignments, which are cheaper through a
setter than through `_modify`.
- Add a test handler that counts copies of its metadata, with tests for
direct writes and for `withLogger(mergingMetadata:)`. Without the change
they report 10 copies instead of 0, and 5 instead of 1.

### Result:

A metadata write on a logger that owns its storage no longer copies the
dictionary. A copied logger still copies once on its first write, so
value semantics are unchanged.

1,000 metadata writes with a handler that keeps metadata in a plain
dictionary, debug build, three runs each:

| Keys on the logger | Before | After |
|---|---|---|
| 10 | 7.2 to 8.1 ms | 0.46 to 0.50 ms |
| 1,000 | 20.2 to 20.6 ms | 0.46 to 0.55 ms |
| 10,000 | 134.0 to 134.4 ms | 0.47 to 0.50 ms |
| 100,000 | 1.29 to 1.30 s | 0.32 to 0.35 ms |

`withLogger(mergingMetadata:)` with 10,000 keys went from 0.64 to 0.65 s
down to 2.9 to 3.1 ms. `StreamLogHandler` still rebuilds its pretty
metadata string on every write; this change does not touch that.

All 176 tests pass on macOS with Swift 6.4, and `swift format lint
--strict` and `swift package diagnose-api-breaking-changes` are clean.
Once yielding accessors land, `_read` and `_modify` can become `yielding
borrow` and `yielding mutate`.

Fixes #526.
2026-10-22 10:30:03 +01:00
dependabot[bot] 6404842475 Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.15 to 0.0.16 (#528)
Bumps
[swiftlang/github-workflows/.github/workflows/soundness.yml](https://github.com/swiftlang/github-workflows)
from 0.0.15 to 0.0.16.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/swiftlang/github-workflows/releases">swiftlang/github-workflows/.github/workflows/soundness.yml's
releases</a>.</em></p>
<blockquote>
<h2>0.0.16</h2>
<h2>What's Changed</h2>
<ul>
<li>sha-pin for dependencies-action by <a
href="https://github.com/madrob"><code>@​madrob</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/317">swiftlang/github-workflows#317</a></li>
<li>Update all Swift package test defaults to 6.4 by <a
href="https://github.com/finagolfin"><code>@​finagolfin</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/319">swiftlang/github-workflows#319</a></li>
<li>Fix check-docs.sh failing on macOS when an option has no values by
<a
href="https://github.com/jakepetroules"><code>@​jakepetroules</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/320">swiftlang/github-workflows#320</a></li>
<li>Make CONTRIBUTORS.txt optional in license headers by <a
href="https://github.com/crleonard"><code>@​crleonard</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/268">swiftlang/github-workflows#268</a></li>
<li>Add configurable timeouts for Linux, Static SDK, Wasm, and Android
builds by <a
href="https://github.com/austenstone"><code>@​austenstone</code></a> in
<a
href="https://redirect.github.com/swiftlang/github-workflows/pull/321">swiftlang/github-workflows#321</a></li>
<li>Use the new LTS Android NDK alone for both testing packages and for
workflow pulls here by <a
href="https://github.com/finagolfin"><code>@​finagolfin</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/315">swiftlang/github-workflows#315</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a href="https://github.com/crleonard"><code>@​crleonard</code></a>
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/268">swiftlang/github-workflows#268</a></li>
<li><a
href="https://github.com/austenstone"><code>@​austenstone</code></a>
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/321">swiftlang/github-workflows#321</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.15...0.0.16">https://github.com/swiftlang/github-workflows/compare/0.0.15...0.0.16</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/3137ed1a48293ae9f4312fce349ed6210251db89"><code>3137ed1</code></a>
Use the new LTS Android NDK alone for both testing packages and for
workflow ...</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/b9dfa3cb6e7361cac9170478c8569df324683ce6"><code>b9dfa3c</code></a>
Add configurable step timeouts for Linux, Static SDK, Wasm, and Android
build...</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/a0e26726cfe9f46c9eec63f7af64060bb733761f"><code>a0e2672</code></a>
Make CONTRIBUTORS.txt optional in license headers (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/268">#268</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/b9633883fec533530ebd7d5e82ef8ca832c2035f"><code>b963388</code></a>
Fix check-docs.sh failing on macOS when an option has no values (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/320">#320</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/fa1e46cf0f07ffde2de131e9ed5bd66a488c289c"><code>fa1e46c</code></a>
Update all Swift package test defaults to 6.4 (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/319">#319</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/81d865a4ea288ffefb0055d23ce4a748a845db20"><code>81d865a</code></a>
sha-pin for dependencies-action (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/317">#317</a>)</li>
<li>See full diff in <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.15...0.0.16">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=swiftlang/github-workflows/.github/workflows/soundness.yml&package-manager=github_actions&previous-version=0.0.15&new-version=0.0.16)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-19 17:33:54 +00:00
Azeem Jiva fcd893317d Update benchmark expectations (#527)
_[One line description of your change]_

### Motivation: 

Update benchmark expectations, with the updated performance level

### Modifications:

Update json file with the new instruction count

### Result:

passing test
2026-10-15 14:56:54 +00:00
Azeem Jiva 65b3417512 Update threshold for GH runner (#525)
_[One line description of your change]_

### Motivation: Update threshold

This allows the faster GitHub runners to pass the benchmark tests.

### Modifications:

Updated threshold to a lower value

### Result:

Passing test
2026-10-13 13:23:02 +00:00
Vladimir Kukushkin 666b45a252 Adjust benchmark expectations (#523)
### Motivation:

Benchmarks CI has been failing recently on Swift 6.3 and 6.4, for
example: https://github.com/apple/swift-log/actions/runs/38083241726.
The results are actually better than expected in the thresholds.

### Modifications:

- Swift 6.3
MaxLogLevelNone.critical_log_with_critical_log_level_metadata_set.p90.json
threshold reduced
- Swift 6.4
MaxLogLevelWarning.notice_log_with_notice_log_level_attributed_generic.p90.json
threshold reduced

### Result:

CI should not fail anymore.
2026-10-13 12:03:23 +01:00
Chris Leonard 4038b6a4f7 Fix metadata provider handling when multiplexing log events (#522)
Ensure metadata from the multiplex handler’s own provider reaches
emitted logs.

Fixes #521.

## Motivation

`MultiplexLogHandler` accepts a metadata provider in its initializer,
but `log(event:)` never invokes it. Provider values such as trace IDs
are therefore missing from downstream logs.

## Modifications

- Merge the multiplex provider’s metadata into the event before
forwarding it.
- Preserve explicit per-message metadata overrides.
- Add regression tests covering one and two downstream handlers and
metadata precedence.

## Result

The supplied provider’s metadata is included in emitted logs.

Regression tests fail before the fix and pass afterward. All 174 tests
pass on macOS with Swift 6.4. Formatting and `git diff --check` also
pass.
2026-10-07 15:03:40 +00:00
Chris Leonard 109c380c23 Fix explicit log level when replacing a task-local logger's handler (#520)
Fixes #519.

## Motivation

When both `logLevel` and `handler` are provided, `withLogger` sets the
level on the current handler before replacing it. Since
`Logger.logLevel` forwards to the handler, the replacement discards the
requested level and uses its own instead.

## Modifications

- Install the replacement handler before applying the explicit log level
in both sync and async overloads.
- Add regression tests for `.debug` and `.warning` in both overloads,
covering filtering and scope isolation.

## Result

The scoped logger filters messages at the requested level.

Regression tests fail before the fix and pass afterward. All 172 tests
pass on macOS with Swift 6.4. Formatting and `git diff --check` also
pass.
2026-10-07 10:47:39 +01:00
Vladimir Kukushkin c29472f010 Bump minimal Swift tools version to 6.2 (#518)
The support window is 3 latest minor Swift versions. CI i already
running for Swift 6.2, 6.3 and 6.4 only. Updating the Swift tools and
the package to match this.
2026-10-02 16:39:23 +00:00
dependabot[bot] bca880e799 Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.13 to 0.0.15 (#502)
Bumps
[swiftlang/github-workflows/.github/workflows/soundness.yml](https://github.com/swiftlang/github-workflows)
from 0.0.13 to 0.0.15.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/swiftlang/github-workflows/releases">swiftlang/github-workflows/.github/workflows/soundness.yml's
releases</a>.</em></p>
<blockquote>
<h2>0.0.15</h2>
<h2>What's Changed</h2>
<ul>
<li>Add install cmake action by <a
href="https://github.com/etcwilde"><code>@​etcwilde</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/310">swiftlang/github-workflows#310</a></li>
<li>Increase PR url download retry by <a
href="https://github.com/bkhouri"><code>@​bkhouri</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/311">swiftlang/github-workflows#311</a></li>
<li>Make Windows CI fail when command fails to launch by <a
href="https://github.com/snprajwal"><code>@​snprajwal</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/307">swiftlang/github-workflows#307</a></li>
<li>Adding Reusable CMake build workflow by <a
href="https://github.com/etcwilde"><code>@​etcwilde</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/313">swiftlang/github-workflows#313</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a href="https://github.com/etcwilde"><code>@​etcwilde</code></a>
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/310">swiftlang/github-workflows#310</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.14...0.0.15">https://github.com/swiftlang/github-workflows/compare/0.0.14...0.0.15</a></p>
<h2>0.0.14</h2>
<h2>What's Changed</h2>
<ul>
<li>Group dependabot updates for GHA workflows by <a
href="https://github.com/snprajwal"><code>@​snprajwal</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/302">swiftlang/github-workflows#302</a></li>
<li>Run linux pre-build commands as part of the API breakage step by <a
href="https://github.com/josephnoir"><code>@​josephnoir</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/304">swiftlang/github-workflows#304</a></li>
<li>swift_package_test: Switch to using Swift version-based symlinks by
<a href="https://github.com/lorentey"><code>@​lorentey</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/309">swiftlang/github-workflows#309</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a
href="https://github.com/josephnoir"><code>@​josephnoir</code></a> made
their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/304">swiftlang/github-workflows#304</a></li>
<li><a href="https://github.com/lorentey"><code>@​lorentey</code></a>
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/309">swiftlang/github-workflows#309</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.13...0.0.14">https://github.com/swiftlang/github-workflows/compare/0.0.13...0.0.14</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/9a10bfdc569159a3463f1273fbd7ed5f97fbe598"><code>9a10bfd</code></a>
Adding Reusable CMake build workflow (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/313">#313</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/baf2598563ae0cadfebf37e353f13bf3db3702b1"><code>baf2598</code></a>
Fix Windows CI passing when a command fails to launch (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/307">#307</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/455afa1d1d36cb7e8884553ea5d808117f8786af"><code>455afa1</code></a>
Increase PR url download retry (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/311">#311</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/f8c5dc13ff142addb79fb622d4a6e2802b26cf38"><code>f8c5dc1</code></a>
Add install cmake action (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/310">#310</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/152252f6e4b45fa96d48f1cbefaa351a7389fc2c"><code>152252f</code></a>
swift_package_test: Switch to using Swift version-based symlinks (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/309">#309</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/497d9ab8410e69981b3b2f28da24cf7bf4b8733d"><code>497d9ab</code></a>
Inline pre-build command into API breakage check step (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/304">#304</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/6af5655d925c8ff204383ff0a22e9baea895c4c5"><code>6af5655</code></a>
Group dependabot updates for GHA workflows (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/302">#302</a>)</li>
<li>See full diff in <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.13...0.0.15">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=swiftlang/github-workflows/.github/workflows/soundness.yml&package-manager=github_actions&previous-version=0.0.13&new-version=0.0.15)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-10-01 12:43:23 +00:00
Vladimir Kukushkin c581740960 Add Swift 6.4 and disable 6.1 in CI configuration (#517)
Add Swift 6.4 and disable 6.1 in CI configuration.
2026-10-01 13:13:54 +02:00
Vladimir Kukushkin 9c9acde6dc Fix nested metadata values handling (#516)
Only quote leaf metadata values.

### Motivation:

There are several issues with how nested `MetadataValue`s are handled:
1. For highly nested (10k+) metadata, `.description` and `==` operator
hit stack overflow. This is probably not very realistic depth, but
still.
2. For not so highly nested metadata (starting at about 20)
`.description` and `==` operator get very computationally intensive
because of re-escaping of the already escaped children. This makes the
above stack overflow crash not reachable in practice.
3. This also results in simple structured metadata to be rendered
something like
`["[\"[\\\"[\\\\\\\"[\\\\\\\\\\\\\\\"leaf\\\\\\\\\\\\\\\"]\\\\\\\"]\\\"]\"]"]`.
4. Finally, even after solving the re-quoting and stack over flow on
rendering, there is still an issue of [recursion in
`.deinit`](https://github.com/swiftlang/swift/issues/58080), resulting
in a _different_ stack overflow crash.

This PR provides a fix for 2 and 3, leaving 1 and 4 out because there is
no practical way of fixing it in this package, while the case is
borderline unrealistic.

### Modifications:

- Only quote left `String` and `StringRepresentable` values in
`Logger.MetadataValue.description`.
- Add benchmarks for metadata values description rendering.

### Result:

100 nested metadata values render cleanly. 

Resolves #515 

### Alternatives

This is discussable if this fix is really necessary. Iterative approach,
because of allocations, is slower than recursion.
- Is it worth fixing the recursion, or a metadata depth check is enough?
- Is it worth fixing the nested metadata formatting?
2026-09-23 10:13:24 +01:00
mitra cf3e828428 Remove invalid exclude statements from testTarget (#514)
I removed the stale exclude statements from `Package.swift` and
`Package@swift-6.1.swift`

### Motivation:

In #485, CMake build support was added, as part of it, 99c554b added
`exclude: ["CMakeLists.txt"]` to all four SwiftPM targets, including
tests, but the CI was revealing some issues with CMake test-targets. So
after review, in 4a81108 the CMake build files were removed from the
`/Tests` directory but I accidentally left behind the exclusions in the
package manifests.

### Modifications:

Removed the exclude statements from Package.swift and
Package@swift-6.1.swift.

### Result:

No SwiftPM errors!

Fixes: #513
2026-09-17 16:31:04 +00:00
mitraandVladimir Kukushkin 3be27be290 Update stale package names and broken ordo-one/benchmark documentation links (#511)
I updated the `CONTRIBUTING.md` documentation to fix the outdated name
for the benchmarking plugin. The instructions now reference the
`benchmark` plugin instead of the previously outdated
`package-benchmark` plugin, and associated links and descriptions have
been updated accordingly. Previously these were leading to `404 Not
Found` errors.

No code changes were made in this PR.

Fixes: #510

---------

Co-authored-by: Vladimir Kukushkin <kukushechkin@mac.com>
2026-09-16 14:51:18 +00:00
Honza Dvorsky 9c6fb14227 Fix referencing WASILibc.stdout/stderr in Swift 6.5+ (#507)
### Motivation:

Nightly CI on nightly-main toolchains started failing on August 11, when
we started downloading swift-DEVELOPMENT-SNAPSHOT-2026-08-08 instead of
swift-DEVELOPMENT-SNAPSHOT-2026-07-11.

Appears to be fallout from
https://github.com/swiftlang/swift/commit/73fee3394d3102847fef26c1bdea49a67061f043
improving the optionality and concurrency of stdout/stderr/stdin on the
various platforms.

### Modifications:

Adapted Swift Log code to handle both the existing and behavior, guarded
by a `compiler(>=6.5)`

Also enabled nightly-next, which tracks the pre-release 6.4 right now,
but hasn't received this change.

### Result:

Passing CI, hopefully :)
2026-09-08 11:02:37 +01:00
Jeff LenamonandVladimir Kukushkin 53d00853e6 Route the SwiftLog 1.0 default log method to log(event:) (#503)
### Motivation:

The two deprecated `LogHandler` defaults forward to each other: the
source-carrying `log(level:message:metadata:source:file:function:line:)`
default calls `log(event:)`, whose default calls the source-carrying
method, and the SwiftLog 1.0
`log(level:message:metadata:file:function:line:)` default calls the
source-carrying method. A handler that implements only `log(event:)`, as
the protocol documentation asks, therefore recurses until the stack
overflows whenever anything calls the 1.0 method on it. Handlers written
against SwiftLog 1.0 that wrap another handler and forward through the
1.0 method reach this path.

Differs from #248, where the handler implemented no log method at all.

### Modifications:

The 1.0 default builds a `LogEvent` and calls `log(event:)` directly.
The source is still the module derived from `file`, as before. Two tests
in `CompatibilityTest`: the 1.0 method reaching an event-only handler
(SIGSEGV at `main` before the change) and reaching a source-only
handler.

### Result:

A `LogHandler` implementing only `log(event:)` can be called through
every deprecated entry point. No source-breaking change; both deprecated
defaults remain.

Verified on Linux with Swift 6.1.2: `swift test -Xswiftc
-warnings-as-errors --explicit-target-dependency-import-check error
-Xswiftc -require-explicit-sendable` (166 tests) and `swift-format lint
--strict` on the changed files.

Found by an automated audit loop (Claude); patch and description
reviewed by me.

---------

Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>
2026-09-07 13:29:33 +01:00
Jeff Lenamon c5ece24786 Document that setting attributes on a collection value is a programmer error (#504)
### Motivation:

`Logger.MetadataValue.attributes` documents the setter as a no-op for
`.dictionary` and `.array`, but it calls `assertionFailure` there. Debug
builds trap, release builds do the documented no-op.

### Modifications:

Doc comment only. The assertion stays; the comment now says setting
attributes on a collection value is a programmer error, that debug
builds assert and release builds leave the value unchanged, and to set
attributes on the leaf values instead.

### Result:

The documentation matches the code. No behaviour change.

Found by an automated audit loop (Claude); patch and description
reviewed by me.
2026-09-04 09:08:57 +00:00
Honza Dvorsky 172948a4b5 Disable simulator testing due to instability (#505)
### Motivation:

Unblock nightly CI runs on main by disabling non-macOS Apple platform
simulator testing due to instability.

### Modifications:

Disabled that CI for now. We'll re-enable when we can make it pass
reliably.

### Result:

Bring nightly CI back to green.
2026-09-03 16:56:49 +00:00
mitra 47a917767f Add CMake build instructions to README (#493)
Add CMake build instructions for macOS, Windows and Linux including
requirements and installation steps.

### Motivation:

Document how to build SwiftLog with CMake for projects that use mixed
build systems and need integration outside of Swift Package Manager.

### Modifications:

- Added a new “Building with CMake” section to `README.md`
- Documented minimum requirements:
  - Swift 6.1+
  - CMake 3.19+
  - Ninja 1.10+
- Added macOS build examples for both Xcode and Ninja generators
- Added Windows build instructions using Ninja
- Added install instructions and notes about shared vs. static builds
- Clarified that tests are not included in the CMake build and are still
managed through Swift Package Manager


### Result:

Users now have platform-specific guidance for building SwiftLog with
CMake on macOS, Windows and Linux.

Fixes #492
2026-08-12 13:49:22 +00:00
Vladimir Kukushkin f054da4c19 Update benchmark thresholds values to match the CI (#497)
### Motivation:

Swift 6.3 benchmarks have been failing for a while now

### Modifications:

- Update 2 benchmark thresholds to match values for Swift 6.3.
- Update thresholds files formatting to reduce noise in the output diff.

### Result:

Benchmarks should not fail sporadically.
2026-08-05 13:35:50 +01:00
Vladimir Kukushkin 3ffafb9722 Make ReadWriteLock.init internal (#496)
### Motivation:

`public` init has no effect for an `internal` class.

### Modifications:

Removed `public` from the `ReadWriteLock.init`.

### Result:

`ReadWriteLock.init` is now `internal`, matching class visibility.
2026-08-04 14:02:34 +02:00
Vladimir KukushkinandJoseph Heck 7af2de138f Document how to construct log handlers that need more than a label (#490)
Document best practice for creating complex `LogHandlers`. 

### Motivation:

`LogHandler`s often need an expensive resource to write or export log
events. This pattern should be documented.

### Modifications:

Add "Constructing handlers that need more than a label" section to
`ImplementingALogHandler.md` guide.

### Result:

Closes #80.

---------

Co-authored-by: Joseph Heck <j_heck@apple.com>
2026-07-24 17:59:05 +01:00
mitraandVladimir Kukushkin e83726cb15 Add CMake support for Swift targets and test configurations (#485)
Add CMake build support to the project to enable toolchain integration
and bootstrapping compatibility.

### Motivation:

Currently, swift-log does not support building with CMake. This addition
resolves issue #484, allowing swift-log to be resolved and compiled
within CMake-based environments (like the repos swift-certificates and
swift-argument-parser which aer mentioned in the issue).

### Modifications:

1. **Project Root Config:** Added
[CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/CMakeLists.txt)
configuring the CMake project with Swift 6 and C, alongside setting up
compiler flags for MSVC runtime library on Windows.
2. **Helper Modules:** Added the `cmake/` folder:
- `SwiftSupport.cmake`: dylib/module installations and triple detection
helper.
   - `SwiftLogConfig.cmake.in`: package config export templates.
3. **Target CMake Configurations:** Created
[Sources/Logging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/Logging/CMakeLists.txt)
&
[Sources/InMemoryLogging/CMakeLists.txt](file:///Users/adityamitra/Developer/swift-log/Sources/InMemoryLogging/CMakeLists.txt)
to define the library targets. Included generator expressions pointing
`INTERFACE_INCLUDE_DIRECTORIES` to target output directories for Xcode
generator support.
4. **SwiftPM Exclusions:** Excluded the new CMake files from target
targets inside
[Package.swift](file:///Users/adityamitra/Developer/swift-log/Package.swift)
and
[Package@swift-6.1.swift](file:///Users/adityamitra/Developer/swift-log/Package@swift-6.1.swift)
to keep SwiftPM targets warning-free.
5. **Compile Options Variable:** Consolidates compile options under a
single global definition `SWIFT_LOG_COMMON_COMPILE_OPTIONS` in the root
configuration, enabling Swift 6 compiler features (`ExistentialAny`,
`MemberImportVisibility`, `InternalImportsByDefault`,
`NonisolatedNonsendingByDefault`, and explicit Sendable checks) across
all targets.
6. **CI Integration & Workflow:** Integrated CMake CI validation in
`.github/workflows/pull_request.yml` using the shared workflow from
`apple/swift-nio/.github/workflows/cmake_tests.yml@main` running in a
`swift:6.1-jammy` container. This job compiles the core libraries and
verifies the validity of the CMake files.
7. **License Header Compliance:** Cleaned up license headers across all
CMake files

### Result:

* **SwiftPM:** All 164 unit tests compile and pass successfully under
`swift test` with no warnings.
* **CMake:** Successfully compiles (`** BUILD SUCCEEDED **`) under Xcode
generator (`cmake -B build -G Xcode && cmake --build build`).

### Issue Tracking:
Fixes #484

---------

Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>
2026-07-22 17:25:43 +01:00
dependabot[bot] 8056dbfb08 Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.12 to 0.0.13 (#486) 2026-07-14 17:36:30 +00:00
dependabot[bot] 1032aed8a5 Bump swiftlang/github-workflows/.github/workflows/soundness.yml from 0.0.11 to 0.0.12 (#480)
Bumps
[swiftlang/github-workflows/.github/workflows/soundness.yml](https://github.com/swiftlang/github-workflows)
from 0.0.11 to 0.0.12.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/swiftlang/github-workflows/releases">swiftlang/github-workflows/.github/workflows/soundness.yml's
releases</a>.</em></p>
<blockquote>
<h2>0.0.12</h2>
<h2>What's Changed</h2>
<ul>
<li>Bump gregsdennis/dependencies-action from 1.4.1 to 1.4.2 by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/266">swiftlang/github-workflows#266</a></li>
<li>extract PR Dependency Check for github-workflows into its own file
by <a
href="https://github.com/justice-adams-apple"><code>@​justice-adams-apple</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/270">swiftlang/github-workflows#270</a></li>
<li>Remove workaround for bug triggered by Android environment variable
by <a href="https://github.com/finagolfin"><code>@​finagolfin</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/246">swiftlang/github-workflows#246</a></li>
<li>Change default Android SDK build command by <a
href="https://github.com/jakepetroules"><code>@​jakepetroules</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/269">swiftlang/github-workflows#269</a></li>
<li>[static sdk] build with sdk triple by <a
href="https://github.com/justice-adams-apple"><code>@​justice-adams-apple</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/274">swiftlang/github-workflows#274</a></li>
<li>[freebsd] cd into the proper dir to run package test by <a
href="https://github.com/justice-adams-apple"><code>@​justice-adams-apple</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/275">swiftlang/github-workflows#275</a></li>
<li>Update Wasm build command in workflow by <a
href="https://github.com/jakepetroules"><code>@​jakepetroules</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/272">swiftlang/github-workflows#272</a></li>
<li>Android: Add support for .bundle files in emulator tests by <a
href="https://github.com/jakepetroules"><code>@​jakepetroules</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/276">swiftlang/github-workflows#276</a></li>
<li>Update Swift nightly to 6.4.x in workflow file by <a
href="https://github.com/shahmishal"><code>@​shahmishal</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/278">swiftlang/github-workflows#278</a></li>
<li>Parametrize swift format binary by <a
href="https://github.com/rnro"><code>@​rnro</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/285">swiftlang/github-workflows#285</a></li>
<li>Extend ignore list in flake8 config by <a
href="https://github.com/snprajwal"><code>@​snprajwal</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/279">swiftlang/github-workflows#279</a></li>
<li>Fix Android build for non-default NDKs with new swift-build build
system, by updating ANDROID_NDK_ROOT too by <a
href="https://github.com/finagolfin"><code>@​finagolfin</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/280">swiftlang/github-workflows#280</a></li>
<li>docs: add missing closing backtick in error message by <a
href="https://github.com/Avicennasis"><code>@​Avicennasis</code></a> in
<a
href="https://redirect.github.com/swiftlang/github-workflows/pull/286">swiftlang/github-workflows#286</a></li>
<li>Add retry when retrieving PR information by <a
href="https://github.com/bkhouri"><code>@​bkhouri</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/284">swiftlang/github-workflows#284</a></li>
<li>Docs: provide option to skip analysis in doc-check by <a
href="https://github.com/bkhouri"><code>@​bkhouri</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/282">swiftlang/github-workflows#282</a></li>
<li>Add proposal validation workflow and documentation by <a
href="https://github.com/dempseyatgithub"><code>@​dempseyatgithub</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/288">swiftlang/github-workflows#288</a></li>
<li>Update dock check syntax issue by <a
href="https://github.com/bkhouri"><code>@​bkhouri</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/290">swiftlang/github-workflows#290</a></li>
<li>Update actions/checkout to v7 by <a
href="https://github.com/shahmishal"><code>@​shahmishal</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/294">swiftlang/github-workflows#294</a></li>
<li>Update default Xcode versions in workflow to Xcode 27 Beta 2 by <a
href="https://github.com/shahmishal"><code>@​shahmishal</code></a> in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/293">swiftlang/github-workflows#293</a></li>
<li>Add GITHUB_TOKEN env variable for use by extraction tool by <a
href="https://github.com/dempseyatgithub"><code>@​dempseyatgithub</code></a>
in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/295">swiftlang/github-workflows#295</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/266">swiftlang/github-workflows#266</a></li>
<li><a href="https://github.com/snprajwal"><code>@​snprajwal</code></a>
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/279">swiftlang/github-workflows#279</a></li>
<li><a
href="https://github.com/Avicennasis"><code>@​Avicennasis</code></a>
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/286">swiftlang/github-workflows#286</a></li>
<li><a
href="https://github.com/dempseyatgithub"><code>@​dempseyatgithub</code></a>
made their first contribution in <a
href="https://redirect.github.com/swiftlang/github-workflows/pull/288">swiftlang/github-workflows#288</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.11...0.0.12">https://github.com/swiftlang/github-workflows/compare/0.0.11...0.0.12</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/07936268efedce0a6650c75a00150b820f53f384"><code>0793626</code></a>
Add GITHUB_TOKEN env variable for use by extraction tool (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/295">#295</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/1ec62c90c3b8a07150ec8233eb4cb170aeee7eab"><code>1ec62c9</code></a>
Update default Xcode versions in workflow to Xcode 27 Beta 2 (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/293">#293</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/fda56f671cbba58575549aedd1f07ff75a28949b"><code>fda56f6</code></a>
Update actions/checkout to v7 (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/294">#294</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/60789377b41faf8c0f0aa6e42948b5fa3131a4d9"><code>6078937</code></a>
Update dock check syntax issue (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/290">#290</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/d65527ae024104f80c3c9a204e2255ff6e6dbf24"><code>d65527a</code></a>
Add proposal validation workflow and documentation (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/288">#288</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/b080ab5eaa2d71849e212ec6ffed6e2757791c3d"><code>b080ab5</code></a>
Docs: provide option to skip analysis in doc-check (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/282">#282</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/9abcbf258bca0c8d2157b1bdad4193381f97a866"><code>9abcbf2</code></a>
Add retry when retrieving PR information (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/284">#284</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/8a9e053779acdc244e72dc947fa17c620f671235"><code>8a9e053</code></a>
docs: add missing closing backtick in error message (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/286">#286</a>)</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/0a4e35d4b3892988d1b6a24c1fb4281800e5a6d4"><code>0a4e35d</code></a>
Fix Android build for non-default NDKs with new swift-build build
system, by ...</li>
<li><a
href="https://github.com/swiftlang/github-workflows/commit/cad6f2b75ecfb5813ed8210678c12d307090d930"><code>cad6f2b</code></a>
Extend ignore list in flake8 config (<a
href="https://redirect.github.com/swiftlang/github-workflows/issues/279">#279</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/swiftlang/github-workflows/compare/0.0.11...0.0.12">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=swiftlang/github-workflows/.github/workflows/soundness.yml&package-manager=github_actions&previous-version=0.0.11&new-version=0.0.12)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-06-30 11:31:35 +02:00
Subhramit BasuandVladimir Kukushkin 1895d78a91 Make StreamLogHandler initializers public (#477)
Make `StreamLogHandler` initializers public.

### Motivation:

Closes https://github.com/apple/swift-log/issues/273

### Modifications:

Promote the two stream-accepting initializers from `internal` to
`public`. Also as a result, their stream parameter is spelled out as
`any TextOutputStream & Sendable` rather than the internal
`_SendableTextOutputStream` typealias, which cannot appear in a public
signature. ~The private stored property and the internal typealias are
otherwise unchanged.~ The internal typealias has been completely removed
as it was only used to store the stream, and the private stored property
is updated to use the spelled-out type.

Also updates the docc documentation accordingly.

### Result:

Users would be able to construct a `StreamLogHandler` with their own
`TextOutputStream` implementation, reusing the existing logic to format
log messages and prettify metadata instead of reimplementing them.

---------

Signed-off-by: subhramit <subhramit.bb@live.in>
Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>
2026-06-25 16:24:26 +01:00
Vladimir KukushkinandJoseph Heck 8a6b9eab84 Add testing logs best practice (#475)
Add a Best Practice guide on how to test logging.

### Motivation:

There are 2 recommended ways of propagating logs in components, both are
testable. But there is no any kind of documentation on how to do it.

### Modifications:

Add a "Testing code that logs" Best Practice guide.

### Result:

Logs testing is now documented.

---------

Co-authored-by: Joseph Heck <j_heck@apple.com>
2026-06-25 11:23:03 +01:00
Joseph HeckandVladimir Kukushkin c4e96785bf Add missing api refs (#478)
Expands on @kukushechkin #474 (add-missing API) and tacks in some
additional work

### Motivation:

resolve the DocC warnings

### Modifications:

- resolves docc warnings for soundness checks 
- updates curation to drop the task-local logger updates into the
correct areas
- updates curation to collect the implemented proposals together

### Result:

Hopefully no issues with soundness checks

---------

Co-authored-by: Vladimir Kukushkin <kukushechkin@apple.com>
2026-06-25 11:00:42 +01:00
Vladimir Kukushkin 54ec9e35cd Update implemented proposals status (#476)
Match proposals status in the docs and the implementation reality.
2026-06-24 16:51:39 +01:00
Vladimir Kukushkin e3b5d65fc9 Enable Xcode tests (#473)
Simulators seem to have stabilized in CI, we can enabled the tests.

### Motivation:

`swift-log` is expected to be used on various platforms, we should run
tests against them.

### Modifications:

- Run tests on various tests in simulators in PRs and nightly.
- Fix tests to actually compile there.

### Result:

Tests are now running in simulators. Supersedes #431.
2026-06-24 13:42:03 +02:00
Vladimir KukushkinandFranz Busch a878e7f8f4 [SLG-0006]: task-local logger implementation (#459)
This proposal adds task-local logger storage so that metadata can
accumulate across async
call stacks without threading a `Logger` through every function
signature.

### Motivation:

Metadata propagation requires threading a logger through every layer.
Every function on
the path from request ingress to the bottom of the call stack has to
accept, mutate, and
forward a `Logger`. Libraries must choose between polluting their public
API with a `logger:` parameter and
losing all the caller's context. There is no third option today.

### Modifications:

- New API surface for reading and modifying the `@TaskLocal` `Logger`
instance added.
- Best practices on how to correctly propagate logger into libraries
updated with `Logger.current` API.

### Result:

Users can now automatically propagate accumulated metadata into
libraries without explicitly passing loggers through the API boundaries.

---------

Co-authored-by: Franz Busch <privat@franz-busch.de>
2026-06-23 15:15:37 +01:00
dependabot[bot] 2c52ee25d2 Bump actions/checkout from 6 to 7 (#472)
Bumps [actions/checkout](https://github.com/actions/checkout) from 6 to
7.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/actions/checkout/releases">actions/checkout's
releases</a>.</em></p>
<blockquote>
<h2>v7.0.0</h2>
<h2>What's Changed</h2>
<ul>
<li>block checking out fork pr for pull_request_target and workflow_run
by <a href="https://github.com/aiqiaoy"><code>@​aiqiaoy</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2454">actions/checkout#2454</a></li>
<li>Bump actions/publish-immutable-action from 0.0.3 to 0.0.4 in the
minor-actions-dependencies group across 1 directory by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2458">actions/checkout#2458</a></li>
<li>Bump flatted from 3.3.1 to 3.4.2 by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2460">actions/checkout#2460</a></li>
<li>Bump js-yaml from 4.1.0 to 4.2.0 by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2461">actions/checkout#2461</a></li>
<li>Bump <code>@​actions/core</code> and
<code>@​actions/tool-cache</code> and Remove uuid by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2459">actions/checkout#2459</a></li>
<li>upgrade module to esm and update dependencies by <a
href="https://github.com/aiqiaoy"><code>@​aiqiaoy</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2463">actions/checkout#2463</a></li>
<li>Bump the minor-npm-dependencies group across 1 directory with 3
updates by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2462">actions/checkout#2462</a></li>
<li>getting ready for checkout v7 release by <a
href="https://github.com/aiqiaoy"><code>@​aiqiaoy</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2464">actions/checkout#2464</a></li>
<li>update error wording by <a
href="https://github.com/aiqiaoy"><code>@​aiqiaoy</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2467">actions/checkout#2467</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a href="https://github.com/aiqiaoy"><code>@​aiqiaoy</code></a> made
their first contribution in <a
href="https://redirect.github.com/actions/checkout/pull/2454">actions/checkout#2454</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/actions/checkout/compare/v6.0.3...v7.0.0">https://github.com/actions/checkout/compare/v6.0.3...v7.0.0</a></p>
<h2>v6.0.3</h2>
<h2>What's Changed</h2>
<ul>
<li>Update changelog by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2357">actions/checkout#2357</a></li>
<li>fix: expand merge commit SHA regex and add SHA-256 test cases by <a
href="https://github.com/yaananth"><code>@​yaananth</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2414">actions/checkout#2414</a></li>
<li>Fix checkout init for SHA-256 repositories by <a
href="https://github.com/yaananth"><code>@​yaananth</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2439">actions/checkout#2439</a></li>
<li>Update changelog for v6.0.3 by <a
href="https://github.com/yaananth"><code>@​yaananth</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2446">actions/checkout#2446</a></li>
</ul>
<h2>New Contributors</h2>
<ul>
<li><a href="https://github.com/yaananth"><code>@​yaananth</code></a>
made their first contribution in <a
href="https://redirect.github.com/actions/checkout/pull/2414">actions/checkout#2414</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/actions/checkout/compare/v6...v6.0.3">https://github.com/actions/checkout/compare/v6...v6.0.3</a></p>
<h2>v6.0.2</h2>
<h2>What's Changed</h2>
<ul>
<li>Add orchestration_id to git user-agent when ACTIONS_ORCHESTRATION_ID
is set by <a
href="https://github.com/TingluoHuang"><code>@​TingluoHuang</code></a>
in <a
href="https://redirect.github.com/actions/checkout/pull/2355">actions/checkout#2355</a></li>
<li>Fix tag handling: preserve annotations and explicit fetch-tags by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2356">actions/checkout#2356</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/actions/checkout/compare/v6.0.1...v6.0.2">https://github.com/actions/checkout/compare/v6.0.1...v6.0.2</a></p>
<h2>v6.0.1</h2>
<h2>What's Changed</h2>
<ul>
<li>Update all references from v5 and v4 to v6 by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2314">actions/checkout#2314</a></li>
<li>Add worktree support for persist-credentials includeIf by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2327">actions/checkout#2327</a></li>
<li>Clarify v6 README by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2328">actions/checkout#2328</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/actions/checkout/compare/v6...v6.0.1">https://github.com/actions/checkout/compare/v6...v6.0.1</a></p>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/actions/checkout/blob/main/CHANGELOG.md">actions/checkout's
changelog</a>.</em></p>
<blockquote>
<h1>Changelog</h1>
<h2>v7.0.0</h2>
<ul>
<li>Block checking out fork PR for pull_request_target and workflow_run
by <a href="https://github.com/aiqiaoy"><code>@​aiqiaoy</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2454">actions/checkout#2454</a></li>
<li>Bump actions/publish-immutable-action from 0.0.3 to 0.0.4 in the
minor-actions-dependencies group across 1 directory by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2458">actions/checkout#2458</a></li>
<li>Bump flatted from 3.3.1 to 3.4.2 by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2460">actions/checkout#2460</a></li>
<li>Bump js-yaml from 4.1.0 to 4.2.0 by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2461">actions/checkout#2461</a></li>
<li>Bump <code>@​actions/core</code> and
<code>@​actions/tool-cache</code> and Remove uuid by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2459">actions/checkout#2459</a></li>
<li>upgrade module to esm and update dependencies by <a
href="https://github.com/aiqiaoy"><code>@​aiqiaoy</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2463">actions/checkout#2463</a></li>
<li>Bump the minor-npm-dependencies group across 1 directory with 3
updates by <a
href="https://github.com/dependabot"><code>@​dependabot</code></a>[bot]
in <a
href="https://redirect.github.com/actions/checkout/pull/2462">actions/checkout#2462</a></li>
</ul>
<h2>v6.0.3</h2>
<ul>
<li>Fix checkout init for SHA-256 repositories by <a
href="https://github.com/yaananth"><code>@​yaananth</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2439">actions/checkout#2439</a></li>
<li>fix: expand merge commit SHA regex and add SHA-256 test cases by <a
href="https://github.com/yaananth"><code>@​yaananth</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2414">actions/checkout#2414</a></li>
</ul>
<h2>v6.0.2</h2>
<ul>
<li>Fix tag handling: preserve annotations and explicit fetch-tags by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2356">actions/checkout#2356</a></li>
</ul>
<h2>v6.0.1</h2>
<ul>
<li>Add worktree support for persist-credentials includeIf by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2327">actions/checkout#2327</a></li>
</ul>
<h2>v6.0.0</h2>
<ul>
<li>Persist creds to a separate file by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2286">actions/checkout#2286</a></li>
<li>Update README to include Node.js 24 support details and requirements
by <a href="https://github.com/salmanmkc"><code>@​salmanmkc</code></a>
in <a
href="https://redirect.github.com/actions/checkout/pull/2248">actions/checkout#2248</a></li>
</ul>
<h2>v5.0.1</h2>
<ul>
<li>Port v6 cleanup to v5 by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2301">actions/checkout#2301</a></li>
</ul>
<h2>v5.0.0</h2>
<ul>
<li>Update actions checkout to use node 24 by <a
href="https://github.com/salmanmkc"><code>@​salmanmkc</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2226">actions/checkout#2226</a></li>
</ul>
<h2>v4.3.1</h2>
<ul>
<li>Port v6 cleanup to v4 by <a
href="https://github.com/ericsciple"><code>@​ericsciple</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2305">actions/checkout#2305</a></li>
</ul>
<h2>v4.3.0</h2>
<ul>
<li>docs: update README.md by <a
href="https://github.com/motss"><code>@​motss</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/1971">actions/checkout#1971</a></li>
<li>Add internal repos for checking out multiple repositories by <a
href="https://github.com/mouismail"><code>@​mouismail</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/1977">actions/checkout#1977</a></li>
<li>Documentation update - add recommended permissions to Readme by <a
href="https://github.com/benwells"><code>@​benwells</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2043">actions/checkout#2043</a></li>
<li>Adjust positioning of user email note and permissions heading by <a
href="https://github.com/joshmgross"><code>@​joshmgross</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2044">actions/checkout#2044</a></li>
<li>Update README.md by <a
href="https://github.com/nebuk89"><code>@​nebuk89</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2194">actions/checkout#2194</a></li>
<li>Update CODEOWNERS for actions by <a
href="https://github.com/TingluoHuang"><code>@​TingluoHuang</code></a>
in <a
href="https://redirect.github.com/actions/checkout/pull/2224">actions/checkout#2224</a></li>
<li>Update package dependencies by <a
href="https://github.com/salmanmkc"><code>@​salmanmkc</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/2236">actions/checkout#2236</a></li>
</ul>
<h2>v4.2.2</h2>
<ul>
<li><code>url-helper.ts</code> now leverages well-known environment
variables by <a href="https://github.com/jww3"><code>@​jww3</code></a>
in <a
href="https://redirect.github.com/actions/checkout/pull/1941">actions/checkout#1941</a></li>
<li>Expand unit test coverage for <code>isGhes</code> by <a
href="https://github.com/jww3"><code>@​jww3</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/1946">actions/checkout#1946</a></li>
</ul>
<h2>v4.2.1</h2>
<ul>
<li>Check out other refs/* by commit if provided, fall back to ref by <a
href="https://github.com/orhantoy"><code>@​orhantoy</code></a> in <a
href="https://redirect.github.com/actions/checkout/pull/1924">actions/checkout#1924</a></li>
</ul>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/actions/checkout/commit/9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0"><code>9c091bb</code></a>
update error wording (<a
href="https://redirect.github.com/actions/checkout/issues/2467">#2467</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/1044a6dea927916f2c38ba5aeffbc0a847b1221a"><code>1044a6d</code></a>
getting ready for checkout v7 release (<a
href="https://redirect.github.com/actions/checkout/issues/2464">#2464</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/f0282184c7ce73ab54c7e4ab5a617122602e575f"><code>f028218</code></a>
Bump the minor-npm-dependencies group across 1 directory with 3 updates
(<a
href="https://redirect.github.com/actions/checkout/issues/2462">#2462</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/d914b262ffc244530a203ab40decab34c3abf34d"><code>d914b26</code></a>
upgrade module to esm and update dependencies (<a
href="https://redirect.github.com/actions/checkout/issues/2463">#2463</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/537c7ef99cef6e5ddb5e7ff5d16d14510503801d"><code>537c7ef</code></a>
Bump <code>@​actions/core</code> and <code>@​actions/tool-cache</code>
and Remove uuid (<a
href="https://redirect.github.com/actions/checkout/issues/2459">#2459</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/130a169078a413d3a5246a393625e8e742f387f6"><code>130a169</code></a>
Bump js-yaml from 4.1.0 to 4.2.0 (<a
href="https://redirect.github.com/actions/checkout/issues/2461">#2461</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/7d09575332117a40b46e5e020664df234cd416f3"><code>7d09575</code></a>
Bump flatted from 3.3.1 to 3.4.2 (<a
href="https://redirect.github.com/actions/checkout/issues/2460">#2460</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/0f9f3aa320cb53abeb534aeb54048075d9697a0e"><code>0f9f3aa</code></a>
Bump actions/publish-immutable-action (<a
href="https://redirect.github.com/actions/checkout/issues/2458">#2458</a>)</li>
<li><a
href="https://github.com/actions/checkout/commit/f9e715a95fcd1f9253f77dd28f11e88d2d6460c7"><code>f9e715a</code></a>
block checking out fork pr for pull_request_target and workflow_run (<a
href="https://redirect.github.com/actions/checkout/issues/2454">#2454</a>)</li>
<li>See full diff in <a
href="https://github.com/actions/checkout/compare/v6...v7">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=actions/checkout&package-manager=github_actions&previous-version=6&new-version=7)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2026-06-22 10:15:12 +01:00
Vladimir Kukushkin ca61184698 [SLG-0006]: task-local logger proposal (#460)
This proposal adds task-local logger storage so that metadata can
accumulate across async
call stacks without threading a `Logger` through every function
signature.

### Motivation:

Metadata propagation requires threading a logger through every layer.
Every function on
the path from request ingress to the bottom of the call stack has to
accept, mutate, and
forward a `Logger`. Libraries must choose between polluting their public
API with a `logger:` parameter and
losing all the caller's context. There is no third option today.

### Modifications:

SLG-0006 proposal is added.

### Result:

Proposal is ready for review.
2026-06-11 06:47:52 -07:00
Vladimir Kukushkin 92448c359f Add (default:) string interpolation overloads (#471)
Add [Default String
Interpolation](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0477-default-interpolation-values.md)
overloads for `MetadataValue` to restore compatibility with
`\(default:)` interpolation.

### Motivation:

1.13.0 introduced a breaking change to the default string interpolation
compatibility. We do not want to revert the custom string interpolation,
but can fix compatibility with the default string interpolation as much
as possible.

### Modifications:

Add `\(default:)` overloads to `MetadataValue.StringInterpolation`,
similar to the once in `DefaultStringInterpolation`.

### Result:

Compatibility with `logger.info("Log message", metadata: ["value":
"\(value, default: "none")"])` is restored.
2026-06-09 17:01:25 +02:00
98 changed files with 2954 additions and 358 deletions

No files matched your search

+53 -61
View File
@@ -10,72 +10,64 @@ on:
- cron: "0 8,20 * * *"
jobs:
unit-tests:
name: Unit tests
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
tests:
name: Tests
uses: swiftlang/github-workflows/.github/workflows/package_test.yml@0.0.18
with:
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_1_enabled: true
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
windows_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
# After https://github.com/swiftlang/github-workflows/pull/362 fix is available, this can be simplified to:
# windows_command: |
# Debug-Test: swift test
# Release-Build: swift build -c release
# windows_version_overrides: |
# default: -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
# nightly-release: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
# nightly-main: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
windows_env_vars: '{"COMMON_SWIFT_FLAGS": "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"}'
windows_command: |
Debug-Test:
command: swift test -Xswiftc -warnings-as-errors %COMMON_SWIFT_FLAGS%
versions: ["current-2", "current-1", "current"]
Release-Build:
command: swift build -c release -Xswiftc -warnings-as-errors %COMMON_SWIFT_FLAGS%
versions: ["current-2", "current-1", "current"]
Debug-Test-Nightly:
command: swift test %COMMON_SWIFT_FLAGS%
versions: ["nightly-release", "nightly-main"]
Release-Build-Nightly:
command: swift build -c release %COMMON_SWIFT_FLAGS%
versions: ["nightly-release", "nightly-main"]
# The Windows runner installs a pinned Swift patch release. The container image tracks the newest patch release.
# Context: https://github.com/swiftlang/github-workflows/issues/356
windows_use_docker: true
# Strict flags for the release toolchains. The nightly toolchains skip -warnings-as-errors.
linux_version_overrides: |
default: -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
nightly-release: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
nightly-main: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
macos_runner_pool: nightly
xcode_scheme: swift-log-Package
xcode_targets: |
macOS:
build: true
test: true
wasm_sdk_versions: '["current", "nightly-main"]'
enable_embedded_wasm_sdk_build: false
enable_macos_swiftly: false
enable_freebsd: false
macos-benchmarks:
name: macOS benchmarks
uses: apple/swift-nio/.github/workflows/macos_benchmarks.yml@main
uses: swiftlang/github-workflows/.github/workflows/benchmarks.yml@0.0.18
with:
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
macos_swift_6_3_enabled: true
enable_linux: false
enable_macos: true
macos_swift_versions: '["current-1", "current"]'
macos_runner_pool: nightly
cxx-interop:
name: Cxx interop
uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
static-linux:
name: Static Linux Swift SDK
# Workaround https://github.com/nektos/act/issues/1875
uses: apple/swift-nio/.github/workflows/static_sdk.yml@main
macos-tests:
name: macOS tests
uses: apple/swift-nio/.github/workflows/macos_tests.yml@main
cmake-build:
name: CMake build
uses: swiftlang/github-workflows/.github/workflows/cmake_build.yml@0.0.18
with:
runner_pool: nightly
build_scheme: swift-log-Package
debug_output_enabled: true
macos_xcode_test_enabled: false
ios_xcode_test_enabled: false
watchos_xcode_test_enabled: false
tvos_xcode_test_enabled: false
visionos_xcode_test_enabled: false
wasm:
name: Wasm Swift SDK
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
with:
nightly_next_enabled: false
android:
name: Android Swift SDK
# Workaround https://github.com/nektos/act/issues/1875
uses: apple/swift-nio/.github/workflows/android_swift_sdk.yml@main
release-builds:
name: Release builds
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
with:
windows_6_1_enabled: true
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
enable_windows_checks: false
linux_pre_build_command: apt-get update && apt-get install -y ninja-build
+53 -57
View File
@@ -10,72 +10,68 @@ on:
jobs:
soundness:
name: Soundness
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.11
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.18
with:
license_header_check_project_name: "Swift Logging API"
unit-tests:
name: Unit tests
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
tests:
name: Tests
uses: swiftlang/github-workflows/.github/workflows/package_test.yml@0.0.18
with:
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_1_enabled: true
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
windows_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
# After https://github.com/swiftlang/github-workflows/pull/362 fix is available, this can be simplified to:
# windows_command: |
# Debug-Test: swift test
# Release-Build: swift build -c release
# windows_version_overrides: |
# default: -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
# nightly-release: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
# nightly-main: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
windows_env_vars: '{"COMMON_SWIFT_FLAGS": "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"}'
windows_command: |
Debug-Test:
command: swift test -Xswiftc -warnings-as-errors %COMMON_SWIFT_FLAGS%
versions: ["current-2", "current-1", "current"]
Release-Build:
command: swift build -c release -Xswiftc -warnings-as-errors %COMMON_SWIFT_FLAGS%
versions: ["current-2", "current-1", "current"]
Debug-Test-Nightly:
command: swift test %COMMON_SWIFT_FLAGS%
versions: ["nightly-release", "nightly-main"]
Release-Build-Nightly:
command: swift build -c release %COMMON_SWIFT_FLAGS%
versions: ["nightly-release", "nightly-main"]
# The Windows runner installs a pinned Swift patch release. The container image tracks the newest patch release.
# Context: https://github.com/swiftlang/github-workflows/issues/356
windows_use_docker: true
# Strict flags for the release toolchains. The nightly toolchains skip -warnings-as-errors.
linux_version_overrides: |
default: -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
nightly-release: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
nightly-main: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
macos_runner_pool: general
xcode_scheme: swift-log-Package
xcode_targets: |
macOS:
build: true
test: true
wasm_sdk_versions: '["current", "nightly-main"]'
enable_embedded_wasm_sdk_build: false
enable_macos_swiftly: false
enable_freebsd: false
macos-benchmarks:
name: macOS benchmarks
uses: apple/swift-nio/.github/workflows/macos_benchmarks.yml@main
uses: swiftlang/github-workflows/.github/workflows/benchmarks.yml@0.0.18
with:
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
enable_linux: false
enable_macos: true
macos_swift_versions: '["current-1", "current"]'
macos_runner_pool: general
macos_swift_6_3_enabled: true
cxx-interop:
name: Cxx interop
uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
static-linux:
name: Static Linux Swift SDK
# Workaround https://github.com/nektos/act/issues/1875
uses: apple/swift-nio/.github/workflows/static_sdk.yml@main
macos-tests:
name: macOS tests
uses: apple/swift-nio/.github/workflows/macos_tests.yml@main
cmake-build:
name: CMake build
uses: swiftlang/github-workflows/.github/workflows/cmake_build.yml@0.0.18
with:
runner_pool: general
build_scheme: swift-log-Package
swift_test_enabled: true
android:
name: Android Swift SDK
# Workaround https://github.com/nektos/act/issues/1875
uses: apple/swift-nio/.github/workflows/android_swift_sdk.yml@main
release-builds:
name: Release builds
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
with:
windows_6_1_enabled: true
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
wasm:
name: Wasm Swift SDK
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
with:
nightly_next_enabled: false
enable_windows_checks: false
linux_pre_build_command: apt-get update && apt-get install -y ninja-build
+2 -9
View File
@@ -2,6 +2,7 @@ name: PR label
permissions:
contents: read
pull-requests: read
on:
pull_request:
@@ -10,12 +11,4 @@ on:
jobs:
semver-label-check:
name: Semantic version label check
runs-on: ubuntu-latest
timeout-minutes: 1
steps:
- name: Checkout repository
uses: actions/checkout@v6
with:
persist-credentials: false
- name: Check for Semantic Version label
uses: apple/swift-nio/.github/actions/pull_request_semver_label_checker@main
uses: swiftlang/github-workflows/.github/workflows/pull_request_label.yml@0.0.18
+4 -4
View File
@@ -1,4 +1,4 @@
// swift-tools-version: 6.2
// swift-tools-version: 6.2.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
@@ -19,19 +19,19 @@ let package = Package(
),
// Parent Benchmarks
.package(name: "Benchmarks", path: "../"),
.package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"),
.package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"),
],
targets: [
.executableTarget(
name: "MaxLogLevelNone",
dependencies: [
.product(name: "BenchmarksFactory", package: "Benchmarks"),
.product(name: "Benchmark", package: "package-benchmark"),
.product(name: "Benchmark", package: "benchmark"),
.product(name: "Logging", package: "swift-log"),
],
path: "Benchmarks/MaxLogLevelNoneBenchmarks",
plugins: [
.plugin(name: "BenchmarkPlugin", package: "package-benchmark")
.plugin(name: "BenchmarkPlugin", package: "benchmark")
]
)
]
@@ -0,0 +1,4 @@
{
"instructions" : 6875,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6879,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6895,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6867,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 5851,
"objectAllocCount" : 2
}
@@ -1,4 +0,0 @@
{
"instructions" : 7055,
"objectAllocCount" : 3
}
+4 -4
View File
@@ -1,4 +1,4 @@
// swift-tools-version: 6.2
// swift-tools-version: 6.2.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
@@ -19,19 +19,19 @@ let package = Package(
),
// Parent Benchmarks
.package(name: "Benchmarks", path: "../"),
.package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"),
.package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"),
],
targets: [
.executableTarget(
name: "MaxLogLevelWarning",
dependencies: [
.product(name: "BenchmarksFactory", package: "Benchmarks"),
.product(name: "Benchmark", package: "package-benchmark"),
.product(name: "Benchmark", package: "benchmark"),
.product(name: "Logging", package: "swift-log"),
],
path: "Benchmarks/MaxLogLevelWarningBenchmarks",
plugins: [
.plugin(name: "BenchmarkPlugin", package: "package-benchmark")
.plugin(name: "BenchmarkPlugin", package: "benchmark")
]
)
]
@@ -0,0 +1,4 @@
{
"instructions" : 6847,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6863,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6871,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1189887,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1189887,
"objectAllocCount" : 0
}
@@ -18,12 +18,38 @@ import Foundation
import Logging
public let benchmarks: @Sendable () -> Void = {
makeBenchmark(loggerLevel: .error, logLevel: .error, "_generic") { logger in
logger.log(level: .error, "hello, benchmarking world")
}
makeBenchmark(loggerLevel: .error, logLevel: .debug, "_generic") { logger in
logger.log(level: .debug, "hello, benchmarking world")
}
// MARK: - Task-local logger benchmarks
makeBenchmark(loggerLevel: .error, logLevel: .error, "_current_read_fallback") { _ in
blackHole(Logger.current)
}
makeBenchmark(loggerLevel: .error, logLevel: .error, setScopedLogger: true, "_current_read_inside_scope") {
logger in
blackHole(Logger.current)
}
makeBenchmark(loggerLevel: .error, logLevel: .error, setScopedLogger: true, "_withLogger_mergingMetadata") {
logger in
withLogger(mergingMetadata: ["key": "value"]) { inner in
blackHole(inner)
}
}
makeBenchmark(loggerLevel: .error, logLevel: .error, setScopedLogger: true, "_withLogger_handler") { logger in
withLogger(handler: logger.handler) { inner in
blackHole(inner)
}
}
makeBenchmark(loggerLevel: .error, logLevel: .error, "_1_attribute") { logger in
logger.log(
level: .error,
@@ -60,4 +86,21 @@ public let benchmarks: @Sendable () -> Void = {
]
)
}
// MARK: - metadata serialization performance
func nestedArrayMetadataValue(depth: Int) -> Logger.MetadataValue {
var value: Logger.MetadataValue = .string("leaf")
for _ in 0..<depth {
value = .array([value])
}
return value
}
for depth in [1, 5, 20, 1_000] {
let nested = nestedArrayMetadataValue(depth: depth)
makeBenchmark(loggerLevel: .info, logLevel: .debug, "_metadata_nesting_depth_\(depth)") { _ in
blackHole(nested.description)
}
}
}
+4 -4
View File
@@ -1,4 +1,4 @@
// swift-tools-version:6.2
// swift-tools-version:6.2.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
@@ -18,19 +18,19 @@ let package = Package(
),
// Parent Benchmarks
.package(name: "Benchmarks", path: "../"),
.package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"),
.package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"),
],
targets: [
.executableTarget(
name: "NoTraits",
dependencies: [
.product(name: "BenchmarksFactory", package: "Benchmarks"),
.product(name: "Benchmark", package: "package-benchmark"),
.product(name: "Benchmark", package: "benchmark"),
.product(name: "Logging", package: "swift-log"),
],
path: "Benchmarks/NoTraitsBenchmarks",
plugins: [
.plugin(name: "BenchmarkPlugin", package: "package-benchmark")
.plugin(name: "BenchmarkPlugin", package: "benchmark")
]
)
]
@@ -0,0 +1,4 @@
{
"instructions" : 4751359,
"objectAllocCount" : 1000
}
@@ -0,0 +1,4 @@
{
"instructions" : 5039157355,
"objectAllocCount" : 2016000
}
@@ -0,0 +1,4 @@
{
"instructions" : 81723391,
"objectAllocCount" : 37000
}
@@ -0,0 +1,4 @@
{
"instructions" : 17661951,
"objectAllocCount" : 6000
}
@@ -0,0 +1,4 @@
{
"instructions" : 5644287,
"objectAllocCount" : 2000
}
@@ -0,0 +1,4 @@
{
"instructions" : 7065599,
"objectAllocCount" : 3000
}
@@ -0,0 +1,4 @@
{
"instructions" : 272895,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 284927,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 3273000,
"objectAllocCount" : 1000
}
@@ -0,0 +1,4 @@
{
"instructions" : 9117695,
"objectAllocCount" : 4000
}
@@ -0,0 +1,4 @@
{
"instructions" : 323071,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 4415487,
"objectAllocCount" : 1000
}
@@ -0,0 +1,4 @@
{
"instructions" : 4322989256,
"objectAllocCount" : 2016000
}
@@ -0,0 +1,4 @@
{
"instructions" : 68354047,
"objectAllocCount" : 37000
}
@@ -0,0 +1,4 @@
{
"instructions" : 14581759,
"objectAllocCount" : 6000
}
@@ -0,0 +1,4 @@
{
"instructions" : 5795839,
"objectAllocCount" : 2000
}
@@ -0,0 +1,4 @@
{
"instructions" : 7192575,
"objectAllocCount" : 3000
}
@@ -0,0 +1,4 @@
{
"instructions" : 301055,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 243967,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1189887,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 2841000,
"objectAllocCount" : 1000
}
@@ -0,0 +1,4 @@
{
"instructions" : 8929279,
"objectAllocCount" : 4000
}
@@ -1,4 +0,0 @@
{
"instructions" : 5855,
"objectAllocCount" : 2
}
@@ -1,4 +0,0 @@
{
"instructions" : 7075,
"objectAllocCount" : 3
}
+3 -3
View File
@@ -1,4 +1,4 @@
// swift-tools-version:6.2
// swift-tools-version:6.2.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
@@ -12,14 +12,14 @@ let package = Package(
.library(name: "BenchmarksFactory", targets: ["BenchmarksFactory"])
],
dependencies: [
.package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"),
.package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"),
.package(path: "../"), // swift-log
],
targets: [
.target(
name: "BenchmarksFactory",
dependencies: [
.product(name: "Benchmark", package: "package-benchmark"),
.product(name: "Benchmark", package: "benchmark"),
.product(name: "Logging", package: "swift-log"),
]
)
@@ -19,6 +19,7 @@ import Logging
public func makeBenchmark(
loggerLevel: Logger.Level,
logLevel: Logger.Level,
setScopedLogger: Bool = false,
_ suffix: String = "",
_ body: @escaping (Logger) -> Void
) {
@@ -35,6 +36,7 @@ public func makeBenchmark(
"\(logLevel)_log_with_\(loggerLevel)_log_level\(suffix)",
configuration: .init(
metrics: metrics,
scalingFactor: .kilo,
maxIterations: iterations,
thresholds: [
.instructions: BenchmarkThresholds(
@@ -49,7 +51,21 @@ public func makeBenchmark(
),
]
)
) { _ in
body(logger)
) { benchmark in
if setScopedLogger {
withLogger(logger) { logger in
benchmark.startMeasurement()
for _ in benchmark.scaledIterations {
body(logger)
}
benchmark.stopMeasurement()
}
} else {
benchmark.startMeasurement()
for _ in benchmark.scaledIterations {
body(logger)
}
benchmark.stopMeasurement()
}
}
}
+72
View File
@@ -0,0 +1,72 @@
#===----------------------------------------------------------------------===#
#
# This source file is part of the Swift Logging API open source project
#
# Copyright (c) 2018-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
#
#===----------------------------------------------------------------------===#
cmake_minimum_required(VERSION 3.19)
# Initialize C language first to inspect the compiler environment
project(swift-log LANGUAGES C)
# Set Swift compiler target from C compiler target if not manually set for Windows
if(WIN32 AND NOT CMAKE_Swift_COMPILER_TARGET)
if(CMAKE_C_COMPILER_ARCHITECTURE_ID MATCHES "(ARM64|arm64|aarch64)")
set(CMAKE_Swift_COMPILER_TARGET "aarch64-unknown-windows-msvc" CACHE STRING "Swift compiler target triple")
elseif(CMAKE_C_COMPILER_ARCHITECTURE_ID MATCHES "(X86|x64|AMD64|x86_64)")
set(CMAKE_Swift_COMPILER_TARGET "x86_64-unknown-windows-msvc" CACHE STRING "Swift compiler target triple")
endif()
endif()
# Enable Swift after C defines the architecture
enable_language(Swift)
option(BUILD_SHARED_LIBS "Build shared libraries by default" YES)
set(CMAKE_Swift_LANGUAGE_VERSION 6)
if(CMAKE_Swift_COMPILER_VERSION VERSION_LESS "6.2.3")
message(FATAL_ERROR "swift-log requires Swift compiler version 6.2.3 or newer. Detected version: ${CMAKE_Swift_COMPILER_VERSION}")
endif()
set(SWIFT_LOG_COMMON_COMPILE_OPTIONS
"SHELL:-enable-upcoming-feature ExistentialAny"
"SHELL:-enable-upcoming-feature MemberImportVisibility"
"SHELL:-enable-upcoming-feature InternalImportsByDefault"
"SHELL:-enable-upcoming-feature NonisolatedNonsendingByDefault"
"SHELL:-Xfrontend -require-explicit-sendable"
"SHELL:-package-name swift_log")
list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
set(CMAKE_Swift_MODULE_DIRECTORY ${CMAKE_BINARY_DIR}/swift)
if(MSVC)
message(STATUS "MSVC condition triggered successfully!")
set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
set(CMAKE_Swift_COMPILE_OPTIONS_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
endif()
include(GNUInstallDirs)
include(SwiftSupport)
if(NOT APPLE)
find_package(dispatch QUIET)
find_package(Foundation QUIET)
endif()
add_subdirectory(Sources)
add_subdirectory(cmake/modules)
+4 -4
View File
@@ -87,15 +87,15 @@ directory, for example:
## Benchmarks
Benchmarks for `swift-log` are in a separate Swift Package in the `Benchmarks` subfolder of this repository.
They use the [`package-benchmark`](https://github.com/ordo-one/package-benchmark) plugin.
Benchmarks depends on the [`jemalloc`](https://jemalloc.net) memory allocation library, which is used by `package-benchmark` to capture memory allocation statistics.
An installation guide can be found in the [Getting Started article](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark/gettingstarted#Installing-Prerequisites-and-Platform-Support) of `package-benchmark`.
They use the [`benchmark`](https://github.com/ordo-one/benchmark) plugin.
On Swift versions prior to 6.3 Benchmarks depends on the [`jemalloc`](https://jemalloc.net) memory allocation library, which is used by `benchmark` to capture memory allocation statistics.
An installation guide can be found in the [Getting Started article](https://swiftpackageindex.com/ordo-one/benchmark/documentation/benchmark/gettingstarted#Installing-Prerequisites-and-Platform-Support) of `benchmark`.
Afterwards you can run the benchmarks from CLI by going to the `Benchmarks` subfolder (e.g. `cd Benchmarks`) and invoking:
```
swift package benchmark
```
For more information please refer to `swift package benchmark --help` or the [documentation of `package-benchmark`](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark).
For more information please refer to `swift package benchmark --help` or the [documentation of `benchmark`](https://swiftpackageindex.com/ordo-one/benchmark/documentation/benchmark).
## How to contribute your work
+5 -3
View File
@@ -1,4 +1,4 @@
// swift-tools-version:6.2
// swift-tools-version:6.2.3
import PackageDescription
@@ -29,11 +29,13 @@ let package = Package(
targets: [
.target(
name: "Logging",
dependencies: []
dependencies: [],
exclude: ["CMakeLists.txt"]
),
.target(
name: "InMemoryLogging",
dependencies: ["Logging"]
dependencies: ["Logging"],
exclude: ["CMakeLists.txt"]
),
.testTarget(
name: "LoggingTests",
-66
View File
@@ -1,66 +0,0 @@
// swift-tools-version:6.1
import PackageDescription
let package = Package(
name: "swift-log",
products: [
.library(name: "Logging", targets: ["Logging"]),
.library(name: "InMemoryLogging", targets: ["InMemoryLogging"]),
],
traits: [
.trait(name: "MaxLogLevelDebug", description: "Debug and above available (compiles out trace)"),
.trait(name: "MaxLogLevelInfo", description: "Info and above available (compiles out trace, debug)"),
.trait(name: "MaxLogLevelNotice", description: "Notice and above available (compiles out trace, debug, info)"),
.trait(
name: "MaxLogLevelWarning",
description: "Warning and above available (compiles out trace, debug, info, notice)"
),
.trait(
name: "MaxLogLevelError",
description: "Error and above available (compiles out trace, debug, info, notice, warning)"
),
.trait(name: "MaxLogLevelCritical", description: "Only critical available (compiles out all except critical)"),
.trait(name: "MaxLogLevelNone", description: "All logging compiled out (no log levels available)"),
// By default, no traits are enabled (all log levels available)
.default(enabledTraits: []),
],
targets: [
.target(
name: "Logging",
dependencies: []
),
.target(
name: "InMemoryLogging",
dependencies: ["Logging"]
),
.testTarget(
name: "LoggingTests",
dependencies: ["Logging"]
),
.testTarget(
name: "InMemoryLoggingTests",
dependencies: ["InMemoryLogging", "Logging"]
),
]
)
for target in package.targets
where [.executable, .test, .regular].contains(
target.type
) {
var settings = target.swiftSettings ?? []
// https://github.com/apple/swift-evolution/blob/main/proposals/0335-existential-any.md
// Require `any` for existential types.
settings.append(.enableUpcomingFeature("ExistentialAny"))
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0444-member-import-visibility.md
settings.append(.enableUpcomingFeature("MemberImportVisibility"))
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0409-access-level-on-imports.md
settings.append(.enableUpcomingFeature("InternalImportsByDefault"))
target.swiftSettings = settings
}
+6 -1
View File
@@ -22,7 +22,7 @@ choose from the many
The following snippet shows how to add SwiftLog to your Swift Package:
```swift
// swift-tools-version: 6.1
// swift-tools-version: 6.2.3
import PackageDescription
let package = Package(
@@ -67,3 +67,8 @@ The community has built numerous specialized logging backends.
A great way to discover available log backend implementations is searching the
[Swift Package Index](https://swiftpackageindex.com/search?query=swift-log)
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`.
+16
View File
@@ -0,0 +1,16 @@
#===----------------------------------------------------------------------===#
#
# This source file is part of the Swift Logging API open source project
#
# Copyright (c) 2018-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
#
#===----------------------------------------------------------------------===#
add_subdirectory(Logging)
add_subdirectory(InMemoryLogging)
+28
View File
@@ -0,0 +1,28 @@
#===----------------------------------------------------------------------===#
#
# This source file is part of the Swift Logging API open source project
#
# Copyright (c) 2018-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
#
#===----------------------------------------------------------------------===#
add_library(InMemoryLogging
"InMemoryLogHandler.swift"
)
set_target_properties(InMemoryLogging PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES "$<BUILD_INTERFACE:$<TARGET_PROPERTY:Swift_MODULE_DIRECTORY>>;$<BUILD_INTERFACE:$<TARGET_FILE_DIR:InMemoryLogging>>")
target_compile_options(InMemoryLogging PRIVATE
${SWIFT_LOG_COMMON_COMPILE_OPTIONS})
target_link_libraries(InMemoryLogging PRIVATE Logging)
_install_target(InMemoryLogging)
set_property(GLOBAL APPEND PROPERTY SwiftLog_EXPORTS InMemoryLogging)
+36
View File
@@ -0,0 +1,36 @@
#===----------------------------------------------------------------------===#
#
# This source file is part of the Swift Logging API open source project
#
# Copyright (c) 2018-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
#
#===----------------------------------------------------------------------===#
add_library(Logging
"Handlers/MultiplexLogHandler.swift"
"Handlers/StreamLogHandler.swift"
"Handlers/SwiftLogNoOpLogHandler.swift"
"Locks.swift"
"LogEvent.swift"
"LogHandler.swift"
"Logger+Attributes.swift"
"Logger+With.swift"
"Logger.swift"
"LoggingSystem.swift"
"MetadataProvider.swift"
)
set_target_properties(Logging PROPERTIES
INTERFACE_INCLUDE_DIRECTORIES "$<BUILD_INTERFACE:$<TARGET_PROPERTY:Swift_MODULE_DIRECTORY>>;$<BUILD_INTERFACE:$<TARGET_FILE_DIR:Logging>>")
target_compile_options(Logging PRIVATE
${SWIFT_LOG_COMMON_COMPILE_OPTIONS})
_install_target(Logging)
set_property(GLOBAL APPEND PROPERTY SwiftLog_EXPORTS Logging)
@@ -1,29 +1,88 @@
# 003: Accepting loggers in libraries
# 003: Logger propagation in libraries
Accept loggers through method parameters to ensure proper metadata propagation.
Propagate caller context by accepting a `Logger` parameter or reading the task-local
``Logger/current`` — never by constructing your own logger.
## Overview
Libraries should accept logger instances through method parameters rather than
storing them as instance variables. This practice ensures metadata (such as
correlation IDs) is properly propagated down the call stack, while giving
applications control over logging configuration.
Libraries should obtain a `Logger` in one of two ways: accept one through a method
parameter or read ``Logger/current`` from the task-local. Both approaches
preserve the caller's metadata, log level, and handler choice. Constructing a logger
inside a library — via ``Logger/init(label:)`` — takes those choices away from the
application and breaks metadata propagation.
### Motivation
When libraries accept loggers as method parameters, they enable automatic
propagation of contextual metadata attached to the logger instance. This is
especially important for distributed systems where correlation IDs must flow
through the entire request processing pipeline.
The application controls logging: which backend, which log level, which metadata
travels with each request. Libraries that participate in this picture obtain a logger
the application has set up, rather than constructing their own from scratch. This
ensures correlation IDs and other contextual metadata flow through the entire call
stack, and gives the application a single place to redirect or filter all log output.
Two propagation mechanisms are available, and they coexist. Choose the explicit
parameter when the library's API already accepts a `Logger` (or it's natural to add
one) — the call site stays declarative about what gets logged where. Choose the
task-local when adding a `logger:` parameter would pollute an API that otherwise has
no logging concern in its signature. Application code binds the initial task-local;
library code reads it and updates the metadata.
### Example
#### Recommended: Accept logger through method parameters
#### Recommended: Read ``Logger/current`` from the task-local
When there is no `logger:` parameter in the API, read the
task-local. The application's accumulated metadata (`request.id`, etc.) flows in
automatically without an explicit hand-off.
```swift
// ✅ Good: Pass the logger through method parameters.
// ✅ Good: Library reads Logger.current; caller scopes context via withLogger.
public struct AnalyticsClient {
public func track(_ event: String) {
Logger.current.info("event", metadata: ["event.name": "\(event)"])
}
}
// Application binds at @main and scopes per-request metadata.
@main
struct MyServer {
static func main() async throws {
let logger = Logger(label: "my-server")
try await withLogger(logger) { _ in
try await runServices()
}
}
}
func handleRequest(_ req: HTTPRequest) async throws {
try await withLogger(mergingMetadata: ["request.id": "\(req.id)"]) { _ in
AnalyticsClient().track("request.received") // sees request.id automatically
}
}
```
For per-statement metadata, pass it via the `metadata:` parameter on the log call:
```swift
Logger.current.info("step", metadata: ["step.name": "validate"])
```
For a few back-to-back lines, take a local copy and stamp metadata there — also no
propagation:
```swift
var local = Logger.current
local[metadataKey: "step.name"] = "validate"
local.info("entering")
local.info("done")
```
#### Alternative: Accept logger through method parameters
```swift
// ✅ Good: Pass the logger through method parameters,
// default to Logger.current in the public API.
struct RequestProcessor {
func processRequest(_ request: HTTPRequest, logger: Logger) async throws -> HTTPResponse {
func processRequest(_ request: HTTPRequest, logger: Logger = Logger.current) async throws -> HTTPResponse {
// Add structured metadata that every log statement should contain.
var logger = logger
logger[metadataKey: "request.method"] = "\(request.method)"
@@ -31,44 +90,40 @@ struct RequestProcessor {
logger[metadataKey: "request.id"] = "\(request.id)"
logger.debug("Processing request")
// Pass the logger down to maintain metadata context.
let validatedData = try validateRequest(request, logger: logger)
let result = try await executeBusinessLogic(validatedData, logger: logger)
logger.debug("Request processed successfully")
return result
}
private func validateRequest(_ request: HTTPRequest, logger: Logger) throws -> ValidatedRequest {
logger.debug("Validating request parameters")
// Include validation logic that uses the same logger context.
return ValidatedRequest(request)
}
private func executeBusinessLogic(_ data: ValidatedRequest, logger: Logger) async throws -> HTTPResponse {
logger.debug("Executing business logic")
// Further propagate the logger to other services.
let dbResult = try await databaseService.query(data.query, logger: logger)
logger.debug("Business logic completed")
return HTTPResponse(data: dbResult)
}
}
```
#### Alternative: Accept logger through initializer when appropriate
#### Alternative: Accept logger through initializer for long-lived components
```swift
// ✅ Acceptable: Logger through initializer for long-lived components
// ⚠️ Acceptable: Logger through initializer for long-lived components
final class BackgroundJobProcessor {
private let logger: Logger
init(logger: Logger) {
self.logger = logger
}
func run() async {
// Execute some long running work
logger.debug("Update about long running work")
@@ -79,22 +134,52 @@ final class BackgroundJobProcessor {
#### Avoid: Libraries creating their own loggers
Libraries might create their own loggers; however, this leads to two problems.
First, users of the library can't inject their own loggers which means they have
no control in customizing the log level or log handler. Secondly, it breaks the
metadata propagation since users can't pass in a logger with already attached
metadata.
Constructing ``Logger/init(label:)`` inside a library takes control over the handler, log
level, and base metadata away from the application. The application cannot redirect,
filter, or silence the library's output.
```swift
// ❌ Bad: Library creates its own logger
// ❌ Bad: Library creates its own logger — loses caller's context.
final class MyLibrary {
private let logger = Logger(label: "MyLibrary") // Loses all context
}
// ✅ Good: Library accepts logger from caller
final class MyLibrary {
func operation(logger: Logger) {
// Maintains caller's context and metadata
}
private let logger = Logger(label: "MyLibrary")
}
```
``Logger/init(label:)`` is for the application — typically at `@main` paired with `.withLogger()`.
Library code, including internal application modules, should not construct loggers.
If they do, setting up the global factory with ``LoggingSystem/bootstrap(_:)`` allows
enforcing a specific factory on all the loggers constructed in the process. This
does not necessary need to be the same factory as was used to create the task-local
logger.
#### Avoid: Relying on ``Logger/current`` across non-Task boundaries
``Logger/current`` is backed by a `TaskLocal` and propagates through Swift's structured
concurrency model only. Callbacks invoked on non-Task threads — GCD blocks,
`URLSession` completion handlers, delegate methods dispatched onto specific queues,
`NotificationCenter` observers, C-API callbacks — see the *default* fallback logger,
not the bound one. Metadata bound by the calling `Task` is invisible inside those
callbacks.
```swift
// ❌ Bad: completion handler runs without the Task context; Logger.current is the fallback.
try await withLogger(mergingMetadata: ["request.id": "r1"]) { _ in
URLSession.shared.dataTask(with: req) { data, _, _ in
Logger.current.info("response") // empty-label fallback, no request.id
}.resume()
}
```
For libraries with async completion-handler APIs, accept an explicit `Logger` parameter.
If capturing and rebinding across the boundary is the only option:
```swift
// ✅ Good: capture before the boundary, rebind on the other side.
try await withLogger(mergingMetadata: ["request.id": "r1"]) { captured in
URLSession.shared.dataTask(with: req) { data, _, _ in
withLogger(captured) { _ in // Bind Logger.current inside the callback
Logger.current.info("response") // Logger.current now has request.id
}
}.resume()
}
```
@@ -0,0 +1,81 @@
# 004: Testing code that logs
Validate what you code logs by capturing entries in memory rather than bootstrapping a process-wide backend.
## Overview
Import and use `InMemoryLogging`, which provides an `InMemoryLogHandler` that collects every emitted record into an array you can inspect.
Keep a handler you create local to each test.
Each handler that you create in a test has no shared state, so the test stays isolated is safe to run on parallel with other tests.
Don't use ``LoggingSystem/bootstrap(_:)`` in a test, it sets one process-wide backend and traps if called twice.
Add the product to your test target:
```swift
.product(name: "InMemoryLogging", package: "swift-log")
```
### Capture logs from a logger you pass in
When the code under test accepts a `Logger` (see <doc:003-AcceptingLoggers>), back it with
an `InMemoryLogHandler` and validate the results on `entries`.
The following code illustrates how to set up and validate a handler using `InMemoryLogging` to check the expected results:
```swift
import InMemoryLogging
import Logging
import Testing
struct RequestProcessor {
func handle(id: String, logger: Logger) {
logger.info("request received", metadata: ["request.id": "\(id)"])
}
}
@Test
func stampsRequestID() {
let handler = InMemoryLogHandler()
let logger = Logger(label: "test", factory: { _ in handler })
RequestProcessor().handle(id: "42", logger: logger)
#expect(handler.entries.count == 1)
#expect(handler.entries[0].message == "request received")
#expect(handler.entries[0].metadata["request.id"] == "42")
}
```
Each `Entry` is equatable and exposes `level`, `message`, `metadata`, and `error`.
The handler log level defaults to ``Logger/Level/info``; set `handler.logLevel = .trace` before you use it to
capture lower levels.
### Capture logs from code that reads `Logger.current`
When the code you want to test reads the task-local ``Logger/current`` instead of taking a parameter, bind an `InMemoryLogHandler` for the scope of that by using ``withLogger(logLevel:handler:metadata:_:)-2pd9p``.
The handler shares its storage by reference, so the copy you hold sees what was logged.
Bind the handler for the scope of the call and validate the captured entry:
```swift
import InMemoryLogging
import Logging
import Testing
struct AnalyticsClient {
func track(_ event: String) {
Logger.current.info("event", metadata: ["event.name": "\(event)"])
}
}
@Test
func tracksEvent() {
let handler = InMemoryLogHandler()
withLogger(handler: handler) { _ in
AnalyticsClient().track("signup") // calls Logger.current.info(...)
}
#expect(handler.entries.count == 1)
#expect(handler.entries[0].metadata["event.name"] == "signup")
}
```
@@ -102,6 +102,136 @@ public struct PrintLogHandler: LogHandler {
```
### Constructing handlers that need more than a label
Many log handler backends need more than a `label` in order to construct them: a file path, a remote address, credentials, or
a buffer. A handler is an ordinary value that you construct, so nothing constrains its
initializer — it can take any parameters it needs, and it can `throw`. There is no
protocol-required `init(label:)`. The single `label` argument on factory methods such as
`StreamLogHandler.standardOutput(label:)` is a convention, not a requirement.
Open expensive or fallible resources, such as a file, a socket, early and up front in your own initializer that can `throw`, so that failures surface at setup time.
``LogHandler/log(event:)`` cannot throw, so an error deferred to logging time has nowhere to go.
Keep the handler `struct` cheap and copyable by placing any shared resource behind a thread-safe reference type.
Value semantics apply to a handler's *configuration* — its level and metadata — not its *destination*, so copies writing to
the same file are correct and expected.
The `FileLogHandler` below opens its file once, in an initializer that throws and exception when you create it with an overlapping `Destination`.
The handler `struct` itself stays a cheap, copyable value:
```swift
import Foundation
import Logging
import Synchronization
/// A log handler that appends formatted log lines to a file on disk.
public struct FileLogHandler: LogHandler {
/// The shared, thread-safe destination. Open it once, then share it across handlers: because
/// the destination is a reference type, all those value-semantic handlers write through a single
/// locked file handle.
public final class Destination: @unchecked Sendable {
private let fileHandle: Mutex<FileHandle>
/// Opens `url` for appending. All validation happens here, at setup time.
public init(writingTo url: URL) throws {
let fileManager = FileManager.default
if !fileManager.fileExists(atPath: url.path) {
guard fileManager.createFile(atPath: url.path, contents: nil) else {
throw Failure.cannotCreateFile(url)
}
}
self.fileHandle = .init(try FileHandle(forWritingTo: url))
_ = try self.fileHandle.withLock { try $0.seekToEnd() }
}
func write(_ line: String) {
// `log(event:)` cannot throw, so a write failure is handled here, not propagated.
do {
try self.fileHandle.withLock { try $0.write(contentsOf: Data(line.utf8)) }
} catch {
// Surface the failure without crashing the application.
try? FileHandle.standardError.write(contentsOf: Data("FileLogHandler: \(error)\n".utf8))
}
}
/// Flushes and closes the file. Call this during shutdown.
public func close() {
self.fileHandle.withLock { try? $0.close() }
}
}
/// Errors thrown while opening a ``Destination``.
public enum Failure: Error {
case cannotCreateFile(URL)
}
private let label: String
private let destination: Destination
// Per-logger configuration — this is what must carry value semantics.
public var logLevel: Logger.Level = .info
public var metadata: Logger.Metadata = [:]
public var metadataProvider: Logger.MetadataProvider?
/// Cheap and non-throwing, so it is safe to call from a bootstrap factory closure per label.
public init(label: String, destination: Destination, metadataProvider: Logger.MetadataProvider? = nil) {
self.label = label
self.destination = destination
self.metadataProvider = metadataProvider
}
public func log(event: LogEvent) {
var merged = self.metadata
if let provided = self.metadataProvider?.get() {
merged.merge(provided, uniquingKeysWith: { _, new in new })
}
if let explicit = event.metadata {
merged.merge(explicit, uniquingKeysWith: { _, new in new })
}
let renderedMetadata =
merged.isEmpty
? ""
: " " + merged.sorted { $0.key < $1.key }.map { "\($0.key)=\($0.value)" }.joined(separator: " ")
self.destination.write("\(event.level) \(self.label):\(renderedMetadata) \(event.message)\n")
}
public subscript(metadataKey key: String) -> Logger.Metadata.Value? {
get { self.metadata[key] }
set { self.metadata[key] = newValue }
}
}
```
#### Using your log handler
Construct the destination where you can use `try` to build a logger backed by your handler, then bind it
as ``Logger/current`` for the application's lifetime using `withLogger`:
```swift
// Open the file once, where setup can throw.
let destination = try FileLogHandler.Destination(writingTo: URL(fileURLWithPath: "/var/log/myapp.log"))
defer { destination.close() }
// Build a logger backed by the handler, then bind it for the scope.
let logger = Logger(label: "app") { label in
FileLogHandler(label: label, destination: destination)
}
try await withLogger(logger) { logger in
logger.info("Application started")
// Code in this scope reads the handler through Logger.current.
}
```
The `try` on `Destination` is where setup fails if the path is unwritable: validation happens
before the logger is constructed, so you never need a throwing factory overload.
Use the same pattern for handlers that connect to a remote service:
- validate and connect up front
- keep ``LogHandler/log(event:)`` non-blocking by buffering onto a background task
- provide a `close()` or `shutdown()` (or use [Swift Service Lifecycle](https://github.com/swift-server/swift-service-lifecycle) service) to flush on shutdown
For runtime failures the handler can't avoid, such as a full disk or a broken pipe, degrade gracefully inside `log(event:)` by dropping the log message, retrying, or reporting to `stderr`.
Never call `fatalError` on the logging path.
### Advanced features
#### Metadata providers
@@ -157,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() ?? [:]
@@ -41,3 +41,4 @@ practice includes:
- <doc:001-ChoosingLogLevels>
- <doc:002-StructuredLogging>
- <doc:003-AcceptingLoggers>
- <doc:004-TestingLogging>
@@ -35,4 +35,15 @@ If you have any questions, ask in an issue on GitHub.
## Topics
### Implemented Proposals
- <doc:SLG-0001-metadata-providers>
- <doc:SLG-0002>
- <doc:SLG-0003>
- <doc:SLG-0004-metadata-value-attributes>
- <doc:SLG-0005-log-event-LogHandler-API>
- <doc:SLG-0006-task-local-logger>
### Proposal Template
- <doc:SLG-NNNN>
@@ -6,7 +6,7 @@ Add an extensible per-value attribute mechanism for metadata.
- Proposal: SLG-0004
- Author(s): [Vladimir Kukushkin](https://github.com/kukushechkin)
- Status: **Ready for Implementation**
- Status: **Approved**
- Issue: [apple/swift-log#204](https://github.com/apple/swift-log/issues/204)
- Implementation:
- [apple/swift-log#453](https://github.com/apple/swift-log/pull/453)
@@ -0,0 +1,439 @@
# SLG-0006: Task-local logger with automatic metadata propagation
Accumulate structured logging metadata across async call stacks using task-local storage.
## Overview
- Proposal: SLG-0006
- Author(s): [Vladimir Kukushkin](https://github.com/kukushechkin)
- Status: **Approved**
- Issue: [apple/swift-log#261](https://github.com/apple/swift-log/issues/261)
- Implementation: [apple/swift-log#459](https://github.com/apple/swift-log/pull/459)
- Feature flag: none
- Related links:
- [Lightweight proposals process description](https://github.com/apple/swift-log/blob/main/Sources/Logging/Docs.docc/Proposals/Proposals.md)
### Introduction
This proposal adds task-local logger storage so that metadata can accumulate across async
call stacks without threading a `Logger` through every function signature.
### Motivation
Metadata propagation requires threading a logger through every layer. Every function on
the path from request ingress to the bottom of the call stack has to accept, mutate, and
forward a `Logger`:
```swift
func handleHTTPRequest(_ request: HTTPRequest, logger: Logger) async throws {
var logger = logger
logger[metadataKey: "request.id"] = "\(request.id)"
try await processBusinessLogic(request, logger: logger)
}
```
Libraries must choose between polluting their public API with a `logger:` parameter and
losing all the caller's context. There is no third option today.
### Proposed solution
Use Swift's `@TaskLocal` to propagate a logger with accumulated metadata. The caller sets up
a scope, callees read `Logger.current`:
```swift
func handleRequest(_ request: HTTPRequest) async throws -> HTTPResponse {
try await withLogger(mergingMetadata: ["request.id": "\(request.id)"]) { logger in
logger.info("Handling request") // Has request.id automatically
return try await processRequest(request) // no logger parameter needed
}
}
func processRequest(_ request: HTTPRequest) async throws -> User {
Logger.current.debug("Processing...") // Has request.id automatically
DatabaseClient.query(request.sqlQuery)
}
```
Libraries keep their APIs clean while still emitting logs with the caller's full context.
A library reads `Logger.current` directly — the caller's accumulated metadata flows in
automatically without a `logger:` parameter:
```swift
public struct DatabaseClient {
public static func query(_ sql: String) async throws -> [Row] {
Logger.current.debug("Executing", metadata: ["sql": "\(sql)"])
return try await performQuery(sql)
}
}
```
**Wiring it up with swift-service-lifecycle.** At the application entry point, bind the
bootstrapped logger once; service lifecycle propagates the task-local through the
`ServiceGroup` and into every task spawned from its `run()`:
```swift
@main
struct MyServer {
static func main() async throws {
let logger = Logger(label: "my-server")
try await withLogger(logger) { _ in
let serviceGroup = ServiceGroup(
configuration: .init(
services: [HTTPServer(), BackgroundWorker()],
gracefulShutdownSignals: [.sigint],
cancellationSignals: [.sigterm],
logger: logger
)
)
try await serviceGroup.run()
}
}
}
```
Metadata accumulates through nesting and task-local values propagate through structured
concurrency (`async let`, `withTaskGroup`, child `Task {}`). `Task.detached` does not
inherit context — capture the logger explicitly if needed.
### Detailed design
#### `Logger.current`
Returns the logger bound by the nearest enclosing `withLogger` scope. If none is active,
returns the process-wide unbound default: a `Logger(label: "")` constructed via
`LoggingSystem.factory` the first time the task-local is touched.
```swift
extension Logger {
/// The current task-local logger.
///
/// Returns the logger bound by the nearest enclosing ``withLogger(_:_:)`` scope.
/// If none is active, returns the process-wide unbound default: a
/// `Logger(label: "")` cached from the first time the task-local is touched.
///
/// Task-local values propagate through structured concurrency (`async let`,
/// `withTaskGroup`, child `Task {}`) but are **not** inherited by `Task.detached`.
/// Capture the logger explicitly across detached boundaries.
///
/// For many log calls in a tight scope, prefer extracting the logger once —
/// either `let logger = Logger.current` or the closure's `logger` parameter
/// from `withLogger { logger in ... }` — instead of re-reading the task-local
/// on every call.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
public static var current: Logger { get }
}
```
The per-symbol `@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)` mirrors
`@TaskLocal`'s own runtime availability.
#### `withLogger` free functions
Three overload groups, each with sync and async variants. The closure receives the logger
as a parameter to avoid repeated task-local lookups inside the closure body.
**Bind a specific logger:**
```swift
/// Runs `operation` with `logger` bound to the task-local context.
///
/// Code called within `operation` can read the logger via ``Logger/current`` without an
/// explicit parameter. Binding a different logger with this overload **replaces** the
/// current task-local logger; any metadata accumulated by an outer
/// ``withLogger(mergingMetadata:_:)`` or
/// ``withLogger(logLevel:handler:metadata:_:)`` scope is not carried over.
///
/// This overload is the application-bootstrap binding mechanism: pass a `Logger`
/// constructed via ``Logger/init(label:)`` at your application entry point. Because
/// ``Logger/init(label:)`` consults ``LoggingSystem/factory``, the constructed `Logger`
/// only carries a useful handler once ``LoggingSystem/bootstrap(_:)`` has been called.
/// For mid-call-tree backend swaps that should work without bootstrap (tests, scoped
/// routing), use ``withLogger(logLevel:handler:metadata:_:)`` instead — it modifies the
/// current logger's handler in place without constructing a new one.
///
/// let logger = Logger(label: "app")
/// await withLogger(logger) { logger in
/// logger.info("Application started")
/// await handleRequests() // reads Logger.current
/// }
///
/// - Parameters:
/// - logger: The logger to bind for the duration of `operation`.
/// - operation: The closure to run with `logger` bound. Receives `logger` as a
/// parameter so the body does not need to re-read ``Logger/current``.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public func withLogger<Result, Failure: Error>(
_ logger: Logger,
_ operation: (Logger) throws(Failure) -> Result
) throws(Failure) -> Result
/// Runs `operation` with `logger` bound to the task-local context. Async variant of
/// ``withLogger(_:_:)``; see that function for full semantics.
///
/// - Parameters:
/// - logger: The logger to bind for the duration of `operation`.
/// - operation: The async closure to run with `logger` bound. Receives `logger` as
/// a parameter so the body does not need to re-read ``Logger/current``.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
_ logger: Logger,
_ operation: nonisolated(nonsending) (Logger) async throws(Failure) -> Result
) async throws(Failure) -> Result
```
**Append metadata for a scope:**
```swift
/// Runs `operation` with a copy of ``Logger/current`` that has `metadata` **layered on
/// top of** the inherited base metadata. Keys present in `metadata` override existing
/// keys with the same name; other inherited metadata is preserved. Handler and log
/// level are unchanged.
///
/// Use this overload at request boundaries and any point where context should
/// accumulate. Nested ``withLogger(mergingMetadata:_:)`` scopes layer on top of each
/// other.
///
/// withLogger(mergingMetadata: ["request.id": "\(request.id)"]) { logger in
/// logger.info("Handling request")
/// withLogger(mergingMetadata: ["user.id": "\(user.id)"]) { logger in
/// logger.info("Authenticated") // sees both request.id and user.id
/// }
/// }
///
/// - Parameters:
/// - metadata: Metadata keys merged onto the inherited base metadata for the scope.
/// Keys override existing values with the same name.
/// - operation: The closure to run with the merged logger bound. Receives the
/// merged logger as a parameter.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public func withLogger<Result, Failure: Error>(
mergingMetadata metadata: @autoclosure () -> Logger.Metadata,
_ operation: (Logger) throws(Failure) -> Result
) throws(Failure) -> Result
/// Runs `operation` with a copy of ``Logger/current`` that has `metadata` layered on
/// top of the inherited base metadata. Async variant of ``withLogger(mergingMetadata:_:)``;
/// see that function for full semantics.
///
/// - Parameters:
/// - metadata: Metadata keys merged onto the inherited base metadata for the scope.
/// Keys override existing values with the same name.
/// - operation: The async closure to run with the merged logger bound. Receives the
/// merged logger as a parameter.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
mergingMetadata metadata: @autoclosure () -> Logger.Metadata,
_ operation: nonisolated(nonsending) (Logger) async throws(Failure) -> Result
) async throws(Failure) -> Result
```
**Replace aspects of the current logger:**
```swift
/// Runs `operation` with a copy of ``Logger/current`` whose aspects are **replaced** by
/// the provided arguments. `nil` parameters leave the corresponding aspect unchanged.
///
/// Unlike ``withLogger(mergingMetadata:_:)``, which layers metadata on top of the
/// inherited base, this overload **replaces** the base metadata when `metadata` is
/// non-nil. Pass `metadata: [:]` to wipe the inherited metadata entirely.
///
/// With no arguments, this overload re-binds ``Logger/current`` unchanged — a convenient
/// way to extract it into a local variable for repeated use inside the closure.
///
/// withLogger(mergingMetadata: ["request.id": "\(request.id)"]) { _ in
/// // Background job: start a scope with metadata unrelated to the request.
/// withLogger(metadata: ["job.id": "\(job.id)"]) { logger in
/// logger.info("running") // metadata: job.id only — request.id wiped
/// }
/// }
///
/// - Parameters:
/// - logLevel: When non-nil, replaces the current log level for the scope. When
/// `nil`, the inherited log level is preserved.
/// - handler: When non-nil, replaces the current logger's handler for the scope.
/// Useful in tests to route logs through an `InMemoryLogHandler` or similar while
/// keeping the caller's label. When `nil`, the inherited handler is preserved.
/// - metadata: When non-nil, replaces the handler's base metadata dictionary for
/// the scope. Pass `[:]` to erase inherited metadata; pass a fresh dictionary to
/// start a scope from a known state. When `nil`, the inherited base metadata is
/// preserved.
/// - operation: The closure to run with the modified logger bound. Receives the
/// modified logger as a parameter.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public func withLogger<Result, Failure: Error>(
logLevel: Logger.Level? = nil,
handler: (any LogHandler)? = nil,
metadata: @autoclosure () -> Logger.Metadata? = nil,
_ operation: (Logger) throws(Failure) -> Result
) throws(Failure) -> Result
/// Runs `operation` with a copy of ``Logger/current`` whose aspects are replaced by
/// the provided arguments. Async variant of
/// ``withLogger(logLevel:handler:metadata:_:)``; see that function for full semantics.
///
/// - Parameters:
/// - logLevel: When non-nil, replaces the current log level for the scope. When
/// `nil`, the inherited log level is preserved.
/// - handler: When non-nil, replaces the current logger's handler for the scope.
/// Useful in tests to route logs through an `InMemoryLogHandler` or similar while
/// keeping the caller's label. When `nil`, the inherited handler is preserved.
/// - metadata: When non-nil, replaces the handler's base metadata dictionary for
/// the scope. Pass `[:]` to erase inherited metadata; pass a fresh dictionary to
/// start a scope from a known state. When `nil`, the inherited base metadata is
/// preserved.
/// - operation: The async closure to run with the modified logger bound. Receives
/// the modified logger as a parameter.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
logLevel: Logger.Level? = nil,
handler: (any LogHandler)? = nil,
metadata: @autoclosure () -> Logger.Metadata? = nil,
_ operation: nonisolated(nonsending) (Logger) async throws(Failure) -> Result
) async throws(Failure) -> Result
```
Calling `withLogger { logger in ... }` with no arguments is the single-lookup idiom for
extracting `Logger.current` into a local variable for repeated use inside the closure —
analogous to `withSpan { span in ... }` in `swift-distributed-tracing`.
#### Relationship to `MetadataProvider`
Metadata merged via `withLogger(mergingMetadata:)` is written into the handler's base
metadata on the per-task logger copy. If a handler has a `MetadataProvider` attached — for
example a bootstrapped OpenTelemetry provider that reads `trace.id` from `ServiceContext` —
the provider still runs at log-emission time and follows the handler's conventional merge
order (base < provider < per-statement).
This proposal does **not** add a `metadataProvider:` parameter to the modifying overload.
Application code that wants to swap the provider for a scope should construct a new `Logger`
and use the binding overload. Keeping the two concerns separate avoids shipping the
replace-vs-compose question as part of the core API.
### API stability
**For existing `Logger` users:** no changes. The new API is purely additive.
**For existing `LogHandler` implementations:** no changes required. Task-local loggers use
the same `LogHandler` interface; no new protocol requirements are added.
**Package platform minimums.** `Package.swift` intentionally does not gain a `platforms:`
clause. Each new symbol carries `@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)`
to match `@TaskLocal`'s runtime availability. Callers targeting older deployment versions
keep working; they just can't call the task-local API.
**ABI and resilience.** The `withLogger` overloads are `@inlinable`: their bodies are thin
glue — read `Logger.current`, copy-and-modify the logger, then bind it for the scope — so
inlining them removes a cross-module call at each scope entry. The internal
`withTaskLocalLogger` bridge over `TaskLocal.withValue` is `@usableFromInline` (not
`@inlinable`), letting the inlinable bodies reach it without exposing the `@TaskLocal`
storage. That storage, the bridge, and `Logger.current` all stay non-`@inlinable`, so the
genuinely evolvable state — how the task-local is stored and how the unbound default is
resolved — remains behind a resilient boundary and can change without breaking
already-compiled clients. Only the small, settled control flow of the wrappers is committed
to ABI.
**Source compatibility caveat.** The name `withLogger` is added at the top-level namespace.
Codebases that previously defined their own free `withLogger` function may need to
fully-qualify calls (`Logging.withLogger(...)`) or rename their own.
### Future directions
- **`Logger.withMetadata(merging:) -> Logger` and `Logger.withMetadata(replacing:) -> Logger`
value-level instance methods.** Construct a derived `Logger` value (not a scope) with
metadata layered onto or wholly replacing the receiver's metadata. The scope-level
equivalents (`withLogger(mergingMetadata:)` and `withLogger(metadata:)`) ship in this
proposal; the value-level forms are useful for per-statement metadata that should not
propagate via the task-local — for example, a library that wants to stamp a key on its
own log lines without pushing it onto `Logger.current` (avoiding leakage into downstream
callees).
### Alternatives considered
#### Task-local metadata dictionary instead of task-local logger
Make only the metadata dictionary task-local, so ad-hoc `Logger(label:)` calls automatically
merge it. Rejected because it changes default behavior for all existing logger creation
(breaking semantic change) and overlaps with `swift-distributed-tracing`'s
`ServiceContext`.
#### Static methods on `Logger` instead of free functions
`Logger.withCurrent(...)` instead of `withLogger(...)`. Rejected — inconsistent with
`withSpan(...)` from `swift-distributed-tracing` and `withMetricsFactory(...)` from
`swift-metrics`. Free functions follow the established ecosystem convention.
#### Use `ServiceContext` from swift-distributed-tracing instead of a new task-local
Store metadata in the existing `ServiceContext` — propagated by `swift-service-context`,
the leaf package already designed as a shared propagation primitive — rather than
introducing a second `@TaskLocal`. Rejected because the two propagation channels serve
different use cases: `ServiceContext` carries *distributed* correlation (trace/span IDs,
baggage) that flows across process boundaries, while `withLogger(mergingMetadata:)`
accumulates *local* per-scope logger configuration (log level, handler, and application
metadata like `request.id`) that is meaningful only within a single process. The
task-local logger also carries more than metadata — it holds the `LogHandler`, log
level, and label, none of which belong in a context intended for cross-process propagation.
The existing `MetadataProvider` already bridges the two systems at log-emission time:
handlers read trace/span IDs from `ServiceContext` without swift-log depending on it.
#### No closure parameter — require `Logger.current` inside the closure
`withLogger(logger) { ... }` without a parameter, reading `Logger.current` inside. Rejected
because passing the logger avoids repeated task-local lookups, follows the `withSpan`
convention, and makes it obvious at the call site which logger is in use.
#### Not propagating metadata across module boundaries by default
Expose a public `TaskLocal<Logger>` extension surface so that each module can declare
its own scoped logger and stay structurally isolated from other modules — pushes on one
module's task-local would be invisible to another's reads. Rejected for two reasons.
First, the public surface cost: `@TaskLocal`-declared task-locals require the `$logger`
projection syntax for the scope methods (`MyApp.$logger.withMetadata(merging: …) { … }`),
which is unfamiliar and easy to get wrong; alternatively, exposing `TaskLocal<Logger>`
typed properties would leak a stdlib type into the swift-log surface that we'd rather
keep internal. Hiding the task-local behind `Logger.current` and the `withLogger` free
functions trades isolation for a cleaner API.
Second, the leak case is disciplinable. The only way library code propagates its own
metadata downstream through `Logger.current` is by calling `withLogger(mergingMetadata:)`
or `withLogger(metadata:)`. The documented contract is that those overloads are
application-side APIs: libraries read `Logger.current` and use per-statement `metadata:`
or a local copy for their own context; they do not push. Per-module isolation would make
the leak impossible *by construction* even when discipline fails, but it would also
fragment cross-cutting metadata propagation (`request.id` accumulated at the application
layer would not appear on library log lines without an explicit bridge from one
task-local to another) — which is the propagation we most want by default.
If structural isolation turns out to matter for specific use cases, the public
`TaskLocal<Logger>` extension surface can be added as a non-breaking follow-up.
#### Use another third-party dependency management package
Swift packages ecosystem has packages for managing dependencies, one of those can
be used to handle a task-local `Logger` instance. Rejected because if a library
wants to benefit from a common logger without adding it to its API surface,
it would have to depend on that extra package, effectively imposing that choice on
the application. But the dependency mechanism is an application-level decision,
an app may prefer a different approach, which leads to fragmentation or extra solutions
to bridge them.
#### Let applications create their own task-local logger objects
Applications can declare their own task-local `Logger` instance and API explicitly,
or via another dependency mechanism package. Rejected because it leaves library
dependencies out of the picture and hurts discoverability and composability
of the solution.
@@ -4,7 +4,7 @@
### Creating a metadata provider
- ``init(_:)-(()->Logger.Metadata)``
- ``init(_:)``
### Invoking the provider
@@ -9,3 +9,8 @@
- ``array(_:)``
- ``dictionary(_:)``
### Working with attributes
- ``attributed(_:attributes:)``
- ``attributes``
@@ -10,6 +10,16 @@
- ``init(label:factory:)-6iktu``
- ``MetadataProvider``
### Task-local logger
- ``current``
- ``withLogger(_:_:)-3dt06``
- ``withLogger(_:_:)-70nli``
- ``withLogger(mergingMetadata:_:)-2c7dy``
- ``withLogger(mergingMetadata:_:)-3eduo``
- ``withLogger(logLevel:handler:metadata:_:)-2pd9p``
- ``withLogger(logLevel:handler:metadata:_:)-5nmw6``
### Sending trace log messages
- ``trace(_:metadata:file:function:line:)``
@@ -8,6 +8,8 @@
- ``standardOutput(label:metadataProvider:)``
- ``standardError(label:)``
- ``standardError(label:metadataProvider:)``
- ``init(label:stream:)``
- ``init(label:stream:metadataProvider:)``
### Sending log messages
@@ -23,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,15 +141,32 @@ 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 }
}
}
/// 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)
}
@@ -176,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 = [:]
@@ -185,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
+107 -20
View File
@@ -38,8 +38,6 @@ import WASILibc
/// 2. The handler's ``metadataProvider`` is invoked, overriding any existing keys.
/// 3. The per-log-statement metadata is merged, overriding any previously set keys.
public struct StreamLogHandler: LogHandler {
internal typealias _SendableTextOutputStream = TextOutputStream & Sendable
/// Creates a stream log handler that directs its output to STDOUT.
public static func standardOutput(label: String) -> StreamLogHandler {
StreamLogHandler(
@@ -68,7 +66,7 @@ public struct StreamLogHandler: LogHandler {
StreamLogHandler(label: label, stream: StdioOutputStream.stderr, metadataProvider: metadataProvider)
}
private let stream: any _SendableTextOutputStream
private let stream: any TextOutputStream & Sendable
private let label: String
/// Get the log level configured for this `Logger`.
@@ -82,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() {
@@ -102,13 +113,24 @@ public struct StreamLogHandler: LogHandler {
}
}
// internal for testing only
internal init(label: String, stream: any _SendableTextOutputStream) {
/// Creates a ``StreamLogHandler`` that directs its output to the stream you provide,
/// using the global metadata provider from ``LoggingSystem``.
///
/// - parameters:
/// - label: The label for this log handler.
/// - stream: The stream to write log output to.
public init(label: String, stream: any TextOutputStream & Sendable) {
self.init(label: label, stream: stream, metadataProvider: LoggingSystem.metadataProvider)
}
// internal for testing only
internal init(label: String, stream: any _SendableTextOutputStream, metadataProvider: Logger.MetadataProvider?) {
/// Creates a ``StreamLogHandler`` that directs its output to the stream you provide,
/// using the metadata provider you provide.
///
/// - parameters:
/// - label: The label for this log handler.
/// - stream: The stream to write log output to.
/// - metadataProvider: The metadata provider to use, or `nil` for no provider.
public init(label: String, stream: any TextOutputStream & Sendable, metadataProvider: Logger.MetadataProvider?) {
self.label = label
self.stream = stream
self.metadataProvider = metadataProvider
@@ -135,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"
)
}
@@ -201,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(&timestamp)
// _ftime64_s gives wall-clock time with millisecond resolution.
var timeBuffer = __timeb64()
_ = _ftime64_s(&timeBuffer)
var localTime = tm()
_ = _localtime64_s(&localTime, &timestamp)
_ = 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(&timestamp) 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
}
}
@@ -336,8 +413,13 @@ internal struct StdioOutputStream: TextOutputStream, @unchecked Sendable {
)
#elseif canImport(WASILibc)
// no file locking on WASI
#if compiler(>=6.5)
let file = WASILibc.stderr
#else
let file = WASILibc.stderr!
#endif
return StdioOutputStream(
file: WASILibc.stderr!,
file: file,
flushMode: .always,
lock: nil,
unlock: nil,
@@ -408,8 +490,13 @@ internal struct StdioOutputStream: TextOutputStream, @unchecked Sendable {
)
#elseif canImport(WASILibc)
// no file locking on WASI
#if compiler(>=6.5)
let file = WASILibc.stdout
#else
let file = WASILibc.stdout!
#endif
return StdioOutputStream(
file: WASILibc.stdout!,
file: file,
flushMode: .always,
lock: nil,
unlock: nil,
+11 -11
View File
@@ -61,7 +61,7 @@ package final class Lock {
#elseif os(FreeBSD) || os(OpenBSD)
fileprivate let mutex: UnsafeMutablePointer<pthread_mutex_t?> =
UnsafeMutablePointer.allocate(capacity: 1)
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
fileprivate let mutex: UnsafeMutablePointer<pthread_mutex_t> =
UnsafeMutablePointer.allocate(capacity: 1)
#endif
@@ -70,7 +70,7 @@ package final class Lock {
package init() {
#if os(Windows)
InitializeSRWLock(self.mutex)
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
#if os(FreeBSD) || os(OpenBSD)
var attr = pthread_mutexattr_t(bitPattern: 0)
#else
@@ -100,7 +100,7 @@ package final class Lock {
deinit {
#if os(Windows)
mutex.deallocate()
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
let err = pthread_mutex_destroy(self.mutex)
precondition(err == 0, "\(#function) failed in pthread_mutex with error \(err)")
mutex.deallocate()
@@ -114,7 +114,7 @@ package final class Lock {
package func lock() {
#if os(Windows)
AcquireSRWLockExclusive(self.mutex)
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
let err = pthread_mutex_lock(self.mutex)
precondition(err == 0, "\(#function) failed in pthread_mutex with error \(err)")
#endif
@@ -127,7 +127,7 @@ package final class Lock {
package func unlock() {
#if os(Windows)
ReleaseSRWLockExclusive(self.mutex)
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
let err = pthread_mutex_unlock(self.mutex)
precondition(err == 0, "\(#function) failed in pthread_mutex with error \(err)")
#endif
@@ -196,10 +196,10 @@ internal final class ReadWriteLock: @unchecked Sendable {
#endif
/// Create a new lock.
public init() {
init() {
#if os(Windows)
InitializeSRWLock(self.rwlock)
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
let err = pthread_rwlock_init(self.rwlock, nil)
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
#endif
@@ -208,7 +208,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
deinit {
#if os(Windows)
self.rwlock.deallocate()
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
let err = pthread_rwlock_destroy(self.rwlock)
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
self.rwlock.deallocate()
@@ -223,7 +223,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
#if os(Windows)
AcquireSRWLockShared(self.rwlock)
self.shared = true
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
let err = pthread_rwlock_rdlock(self.rwlock)
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
#endif
@@ -237,7 +237,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
#if os(Windows)
AcquireSRWLockExclusive(self.rwlock)
self.shared = false
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
let err = pthread_rwlock_wrlock(self.rwlock)
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
#endif
@@ -255,7 +255,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
} else {
ReleaseSRWLockExclusive(self.rwlock)
}
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
#elseif _runtime(_multithreaded)
let err = pthread_rwlock_unlock(self.rwlock)
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
#endif
+13 -7
View File
@@ -280,6 +280,10 @@ extension LogHandler {
}
/// A default implementation for the SwiftLog 1.0 log message handler.
///
/// Forwards to ``log(event:)`` directly. Forwarding to the source-carrying deprecated
/// method closed a cycle with its own default, so a handler implementing only
/// ``log(event:)`` overflowed the stack when called through this entry point.
@available(*, deprecated, renamed: "log(event:)")
public func log(
level: Logging.Logger.Level,
@@ -290,13 +294,15 @@ extension LogHandler {
line: UInt
) {
self.log(
level: level,
message: message,
metadata: metadata,
source: Logger.currentModule(filePath: file),
file: file,
function: function,
line: line
event: LogEvent(
level: level,
message: message,
metadata: metadata,
source: Logger.currentModule(filePath: file),
file: file,
function: function,
line: line
)
)
}
}
+56 -1
View File
@@ -262,7 +262,9 @@ extension Logger.MetadataValue {
///
/// **Setting:** Replaces the value with `.stringConvertible(AttributedStringCarrier(...))`
/// carrying the given attributes. For `.string` and `.stringConvertible` cases the string
/// representation is preserved. For `.dictionary` and `.array` cases the setter is a no-op.
/// representation is preserved. Setting attributes on a `.dictionary` or `.array` value is a
/// programmer error: it triggers an assertion in debug builds and leaves the value unchanged in
/// release builds. Set attributes on the leaf values instead.
///
/// Only handlers that inspect attributes pay the cost of the getter check.
@inlinable
@@ -391,6 +393,59 @@ extension Logger.MetadataValue: ExpressibleByStringInterpolation {
self.output.append(String(describing: value))
}
// MARK: Optional interpolation with a default
// The four overloads below mirror `DefaultStringInterpolation`'s `default:`
// shape so that `"\(optional, default: "none")"` keeps working when the
// literal is inferred as a `Logger.MetadataValue`.
@inlinable
public mutating func appendInterpolation<T: TextOutputStreamable & CustomStringConvertible>(
_ value: T?,
default defaultValue: @autoclosure () -> some StringProtocol
) {
if let value {
self.appendInterpolation(value)
} else {
self.output.append(String(defaultValue()))
}
}
@inlinable
public mutating func appendInterpolation<T: TextOutputStreamable>(
_ value: T?,
default defaultValue: @autoclosure () -> some StringProtocol
) {
if let value {
self.appendInterpolation(value)
} else {
self.output.append(String(defaultValue()))
}
}
@inlinable
public mutating func appendInterpolation<T: CustomStringConvertible>(
_ value: T?,
default defaultValue: @autoclosure () -> some StringProtocol
) {
if let value {
self.appendInterpolation(value)
} else {
self.output.append(String(defaultValue()))
}
}
@inlinable
public mutating func appendInterpolation<T>(
_ value: T?,
default defaultValue: @autoclosure () -> some StringProtocol
) {
if let value {
self.appendInterpolation(value)
} else {
self.output.append(String(defaultValue()))
}
}
// MARK: Interpolation with a custom attributes closure
//
// ```swift
+325
View File
@@ -0,0 +1,325 @@
//===----------------------------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
// MARK: - withLogger() free functions for task-local logger
/// Runs `operation` with `logger` bound to the task-local context.
///
/// Code called within `operation` can read the logger via ``Logger/current`` without an
/// explicit parameter. Binding a different logger with this overload **replaces** the
/// current task-local logger; any metadata accumulated by an outer
/// ``withLogger(mergingMetadata:_:)-2c7dy`` or
/// ``withLogger(logLevel:handler:metadata:_:)-2pd9p``
/// scope is not carried over. Use the modifying overloads to layer or replace aspects
/// of the current logger instead.
///
/// This overload is the application-bootstrap binding mechanism: pass a `Logger`
/// constructed via ``Logger/init(label:)`` at your application entry point. Because
/// ``Logger/init(label:)`` consults `LoggingSystem.factory`, the constructed `Logger`
/// only carries a useful handler once ``LoggingSystem/bootstrap(_:)`` has been called.
/// For mid-call-tree backend swaps that should work without bootstrap (tests, scoped
/// routing), use ``withLogger(logLevel:handler:metadata:_:)-2pd9p``
/// instead — it modifies
/// the current logger's handler in place without constructing a new one.
///
/// ```swift
/// let logger = Logger(label: "app")
/// await withLogger(logger) { logger in
/// logger.info("Application started")
/// await handleRequests() // reads Logger.current
/// }
/// ```
///
/// - Parameters:
/// - logger: The logger to bind for the duration of `operation`.
/// - operation: The closure to run with `logger` bound. Receives `logger` as a
/// parameter so the body does not need to re-read ``Logger/current``.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public func withLogger<Result, Failure: Error>(
_ logger: Logger,
_ operation: (Logger) throws(Failure) -> Result
) throws(Failure) -> Result {
do {
return try Logger.withTaskLocalLogger(logger) {
try operation(logger)
}
} catch {
throw error as! Failure
}
}
/// Runs `operation` with `logger` bound to the task-local context.
///
/// Code called within `operation` can read the logger via ``Logger/current`` without an
/// explicit parameter. Binding a different logger with this overload **replaces** the
/// current task-local logger; any metadata accumulated by an outer
/// ``withLogger(mergingMetadata:_:)-3eduo`` or
/// ``withLogger(logLevel:handler:metadata:_:)-5nmw6``
/// scope is not carried over. Use the modifying overloads to layer or replace aspects
/// of the current logger instead.
///
/// This overload is the application-bootstrap binding mechanism: pass a `Logger`
/// constructed via ``Logger/init(label:)`` at your application entry point. Because
/// ``Logger/init(label:)`` consults `LoggingSystem.factory`, the constructed `Logger`
/// only carries a useful handler once ``LoggingSystem/bootstrap(_:)`` has been called.
/// For mid-call-tree backend swaps that should work without bootstrap (tests, scoped
/// routing), use ``withLogger(logLevel:handler:metadata:_:)-5nmw6``
/// instead — it modifies
/// the current logger's handler in place without constructing a new one.
///
/// ```swift
/// let logger = Logger(label: "app")
/// await withLogger(logger) { logger in
/// logger.info("Application started")
/// await handleRequests() // reads Logger.current
/// }
/// ```
///
/// - Parameters:
/// - logger: The logger to bind for the duration of `operation`.
/// - operation: The async closure to run with `logger` bound. Receives `logger` as a
/// parameter so the body does not need to re-read ``Logger/current``.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
_ logger: Logger,
_ operation: nonisolated(nonsending) (Logger) async throws(Failure) -> Result
) async throws(Failure) -> Result {
do {
return try await Logger.withTaskLocalLogger(logger) {
try await operation(logger)
}
} catch {
throw error as! Failure
}
}
/// Runs `operation` with a copy of ``Logger/current`` that has `metadata` **layered on
/// top of** the inherited base metadata. Keys present in `metadata` override existing
/// keys with the same name. Other aspects (handler, log level, base metadata not in
/// `metadata`) are preserved.
///
/// Use this overload at request boundaries and any point where context should
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-2c7dy`` scopes
/// layer on top of each
/// other.
///
/// ```swift
/// withLogger(mergingMetadata: ["request.id": "\(request.id)"]) { logger in
/// logger.info("Handling request")
/// withLogger(mergingMetadata: ["user.id": "\(user.id)"]) { logger in
/// logger.info("Authenticated") // sees both request.id and user.id
/// }
/// }
/// ```
///
/// - Parameters:
/// - metadata: Metadata keys merged onto the inherited base metadata for the scope.
/// Keys override existing values with the same name.
/// - operation: The closure to run with the merged logger bound. Receives the
/// merged logger as a parameter.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public func withLogger<Result, Failure: Error>(
mergingMetadata metadata: @autoclosure () -> Logger.Metadata,
_ operation: (Logger) throws(Failure) -> Result
) throws(Failure) -> Result {
var logger = Logger.current
for (key, value) in metadata() {
logger[metadataKey: key] = value
}
do {
return try Logger.withTaskLocalLogger(logger) {
try operation(logger)
}
} catch {
throw error as! Failure
}
}
/// Runs `operation` with a copy of ``Logger/current`` that has `metadata` **layered on
/// top of** the inherited base metadata. Keys present in `metadata` override existing
/// keys with the same name. Other aspects (handler, log level, base metadata not in
/// `metadata`) are preserved.
///
/// Use this overload at request boundaries and any point where context should
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-3eduo`` scopes
/// layer on top of each
/// other.
///
/// ```swift
/// withLogger(mergingMetadata: ["request.id": "\(request.id)"]) { logger in
/// logger.info("Handling request")
/// withLogger(mergingMetadata: ["user.id": "\(user.id)"]) { logger in
/// logger.info("Authenticated") // sees both request.id and user.id
/// }
/// }
/// ```
///
/// - Parameters:
/// - metadata: Metadata keys merged onto the inherited base metadata for the scope.
/// Keys override existing values with the same name.
/// - operation: The async closure to run with the merged logger bound. Receives the
/// merged logger as a parameter.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
mergingMetadata metadata: @autoclosure () -> Logger.Metadata,
_ operation: nonisolated(nonsending) (Logger) async throws(Failure) -> Result
) async throws(Failure) -> Result {
var logger = Logger.current
for (key, value) in metadata() {
logger[metadataKey: key] = value
}
do {
return try await Logger.withTaskLocalLogger(logger) {
try await operation(logger)
}
} catch {
throw error as! Failure
}
}
/// Runs `operation` with a copy of ``Logger/current`` whose aspects are **replaced** by
/// the provided arguments. `nil` parameters leave the corresponding aspect unchanged.
///
/// Unlike ``withLogger(mergingMetadata:_:)-2c7dy``, which layers
/// metadata on top of the
/// inherited base, this overload **replaces** the base metadata when `metadata` is
/// non-nil. Pass `metadata: [:]` to wipe the inherited metadata entirely for the scope.
///
/// With no arguments, this overload re-binds ``Logger/current`` unchanged — a convenient
/// way to extract it into a local variable for repeated use inside the closure.
///
/// ```swift
/// withLogger(mergingMetadata: ["request.id": "\(request.id)"]) { _ in
/// // Start a background job with metadata unrelated to the request that scheduled it.
/// withLogger(metadata: ["job.id": "\(job.id)"]) { logger in
/// logger.info("running") // metadata: job.id only — request.id wiped
/// }
/// }
/// ```
///
/// When no `withLogger` scope has been set up, ``Logger/current`` (and therefore this
/// function) returns the process-wide unbound default — a `Logger(label: "")` cached
/// from the first time the task-local is touched. Bootstrap before reading
/// ``Logger/current`` for predictable backend selection.
///
/// - Parameters:
/// - logLevel: When non-nil, replaces the current log level for the scope. When `nil`,
/// the inherited log level is preserved.
/// - handler: When non-nil, replaces the current logger's handler for the scope.
/// Useful in tests to route logs through an `InMemoryLogHandler` or similar while
/// keeping the caller's label. When `nil`, the inherited handler is preserved.
/// - metadata: When non-nil, replaces the handler's base metadata dictionary for the
/// scope. Pass `[:]` to erase inherited metadata; pass a fresh dictionary to start
/// a scope from a known state. When `nil`, the inherited base metadata is preserved.
/// - operation: The closure to run with the modified logger bound. Receives the
/// modified logger as a parameter.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public func withLogger<Result, Failure: Error>(
logLevel: Logger.Level? = nil,
handler: (any LogHandler)? = nil,
metadata: @autoclosure () -> Logger.Metadata? = nil,
_ operation: (Logger) throws(Failure) -> Result
) throws(Failure) -> Result {
var logger = Logger.current
if let handler {
logger.handler = handler
}
if let logLevel {
logger.logLevel = logLevel
}
if let metadata = metadata() {
logger.handler.metadata = metadata
}
do {
return try Logger.withTaskLocalLogger(logger) {
try operation(logger)
}
} catch {
throw error as! Failure
}
}
/// Runs `operation` with a copy of ``Logger/current`` whose aspects are **replaced** by
/// the provided arguments. `nil` parameters leave the corresponding aspect unchanged.
///
/// Unlike ``withLogger(mergingMetadata:_:)-3eduo``, which layers
/// metadata on top of the
/// inherited base, this overload **replaces** the base metadata when `metadata` is
/// non-nil. Pass `metadata: [:]` to wipe the inherited metadata entirely for the scope.
///
/// With no arguments, this overload re-binds ``Logger/current`` unchanged — a convenient
/// way to extract it into a local variable for repeated use inside the closure.
///
/// ```swift
/// withLogger(mergingMetadata: ["request.id": "\(request.id)"]) { _ in
/// // Start a background job with metadata unrelated to the request that scheduled it.
/// withLogger(metadata: ["job.id": "\(job.id)"]) { logger in
/// logger.info("running") // metadata: job.id only — request.id wiped
/// }
/// }
/// ```
///
/// When no `withLogger` scope has been set up, ``Logger/current`` (and therefore this
/// function) returns the process-wide unbound default — a `Logger(label: "")` cached
/// from the first time the task-local is touched. Bootstrap before reading
/// ``Logger/current`` for predictable backend selection.
///
/// - Parameters:
/// - logLevel: When non-nil, replaces the current log level for the scope. When `nil`,
/// the inherited log level is preserved.
/// - handler: When non-nil, replaces the current logger's handler for the scope.
/// Useful in tests to route logs through an `InMemoryLogHandler` or similar while
/// keeping the caller's label. When `nil`, the inherited handler is preserved.
/// - metadata: When non-nil, replaces the handler's base metadata dictionary for the
/// scope. Pass `[:]` to erase inherited metadata; pass a fresh dictionary to start
/// a scope from a known state. When `nil`, the inherited base metadata is preserved.
/// - operation: The async closure to run with the modified logger bound. Receives the
/// modified logger as a parameter.
/// - Returns: The value returned by `operation`.
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
logLevel: Logger.Level? = nil,
handler: (any LogHandler)? = nil,
metadata: @autoclosure () -> Logger.Metadata? = nil,
_ operation: nonisolated(nonsending) (Logger) async throws(Failure) -> Result
) async throws(Failure) -> Result {
var logger = Logger.current
if let handler {
logger.handler = handler
}
if let logLevel {
logger.logLevel = logLevel
}
if let metadata = metadata() {
logger.handler.metadata = metadata
}
do {
return try await Logger.withTaskLocalLogger(logger) {
try await operation(logger)
}
} catch {
throw error as! Failure
}
}
+107 -8
View File
@@ -34,7 +34,7 @@ public struct Logger {
@usableFromInline
var handler: any LogHandler
@inlinable
@usableFromInline
init(label: String, handler: any LogHandler) {
self.label = label
self.handler = handler
@@ -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.
@@ -1387,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"
@@ -1414,14 +1433,29 @@ extension Logger.MetadataValue: CustomStringConvertible {
/// A string representation of the metadata value.
public var description: String {
switch self {
case .dictionary(let dict):
return dict.mapValues { $0.description }.description
case .array(let list):
return list.map { $0.description }.description
case .string(let str):
return str
case .stringConvertible(let repr):
return repr.description
case .array(let list):
let items = list.map { $0.quotedAsCollectionElement }
return "[\(items.joined(separator: ", "))]"
case .dictionary(let dict):
guard !dict.isEmpty else { return "[:]" }
let entries = dict.map { key, value in "\(key.debugDescription): \(value.quotedAsCollectionElement)" }
return "[\(entries.joined(separator: ", "))]"
}
}
/// Only qute the leaf
private var quotedAsCollectionElement: String {
switch self {
case .string(let str):
return str.debugDescription
case .stringConvertible(let repr):
return repr.description.debugDescription
case .array, .dictionary:
return self.description
}
}
}
@@ -1454,6 +1488,71 @@ extension Logger.MetadataValue: ExpressibleByArrayLiteral {
}
}
// MARK: - Task-local logger storage
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
extension Logger {
/// Task-local storage for implicit logger context propagation.
///
/// Implementation detail. Use ``Logger/current`` or the `withLogger` free functions instead.
///
/// The default value is a `Logger(label: "")` constructed via `LoggingSystem.factory`
/// the first time the task-local is touched (read or bound) anywhere in the process.
/// That means whichever backend is configured at first access becomes the unbound
/// default for the rest of the process — bootstrap before any logging for predictable
/// behavior.
@usableFromInline
static let taskLocalLogger: TaskLocal<Logger> = TaskLocal(wrappedValue: Logger(label: ""))
/// Thin wrapper over `TaskLocal.withValue` so call sites don't need to reach into
/// the task-local storage directly.
@inlinable
nonisolated(nonsending) static func withTaskLocalLogger<Return, Failure: Error>(
_ value: Logger,
operation: nonisolated(nonsending) () async throws(Failure) -> Return
) async throws(Failure) -> Return {
do {
return try await Self.taskLocalLogger.withValue(value, operation: operation)
} catch {
throw error as! Failure
}
}
@inlinable
static func withTaskLocalLogger<Return, Failure: Error>(
_ value: Logger,
operation: () throws(Failure) -> Return
) throws(Failure) -> Return {
do {
return try Self.taskLocalLogger.withValue(value, operation: operation)
} catch {
throw error as! Failure
}
}
/// The current task-local logger.
///
/// Returns the logger bound by the nearest enclosing
/// ``withLogger(_:_:)-70nli`` scope. If none is active, returns the
/// process-wide unbound default — a `Logger(label: "")` constructed via
/// `LoggingSystem.factory` the first time the task-local is touched, then reused for
/// the lifetime of the process. The empty label is the deliberate diagnostic signal
/// that no `withLogger` scope was set up before the read.
///
/// Because the unbound default is captured at first access, ``LoggingSystem/bootstrap(_:)``
/// must be called before any task-local logger API is exercised; otherwise the
/// unbound default uses the swift-log default ``StreamLogHandler`` and a later
/// bootstrap is not visible to ``current`` outside of a `withLogger` scope.
///
/// Task-local values propagate through structured concurrency (`async let`,
/// `withTaskGroup`, child `Task {}`) but are **not** inherited by `Task.detached`.
/// Capture the logger explicitly across detached boundaries.
@inlinable
public static var current: Logger {
Self.taskLocalLogger.get()
}
}
// MARK: - Sendable support helpers
extension Logger.MetadataValue: Sendable {}
+11 -1
View File
@@ -101,6 +101,12 @@ public enum LoggingSystem: Sendable {
}
}
/// `true` once a user has explicitly called ``bootstrap(_:)`` or the metadata-provider
/// overload; `false` while the system is still using the default `StreamLogHandler`.
internal static var isBootstrapped: Bool {
self._factory.isInitialized
}
/// System wide ``Logger/MetadataProvider`` that was configured during the logging system's `bootstrap`.
///
/// When creating a ``Logger`` using the plain ``Logger/init(label:)`` initializer, this metadata provider
@@ -151,7 +157,7 @@ public enum LoggingSystem: Sendable {
/// and can only be updated once from the initial value given.
private struct ReplaceOnceBox<BoxedType: Sendable> {
private struct ReplaceOnce: Sendable {
private var initialized = false
private(set) var initialized = false
private var _underlying: BoxedType
private let violationErrorMessage: String
@@ -189,6 +195,10 @@ public enum LoggingSystem: Sendable {
var underlying: BoxedType {
self.storage.withReadLock { $0.underlying }
}
var isInitialized: Bool {
self.storage.withReadLock { $0.initialized }
}
}
private typealias FactoryBox = ReplaceOnceBox<
@@ -0,0 +1,96 @@
//===----------------------------------------------------------------------===//
//
// 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"])
}
@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)
}
}
@@ -66,6 +66,79 @@ struct CompatibilityTest {
testLogging.history.assertExist(level: .error, message: "yes: error", source: "yes: error source")
testLogging.history.assertExist(level: .critical, message: "yes: critical", source: "yes: critical source")
}
/// A handler implementing only `log(event:)` must survive a caller on the SwiftLog 1.0
/// entry point. Both deprecated defaults used to forward to each other.
@available(*, deprecated, message: "Testing deprecated functionality")
@Test func swiftLog1CompatibilityMethodReachesAnEventOnlyHandler() {
let handler = EventOnlyLogHandler()
handler.log(
level: .warning,
message: "compat",
metadata: ["k": "v"],
file: "/Sources/CompatModule/Caller.swift",
function: #function,
line: 42
)
let events = handler.recorded
#expect(events.count == 1)
#expect(events.first?.level == .warning)
#expect(events.first?.message == "compat")
#expect(events.first?.metadata == ["k": "v"])
#expect(events.first?.source == "CompatModule")
#expect(events.first?.line == 42)
}
/// The same entry point must still reach a handler implementing only the
/// source-carrying deprecated method.
@available(*, deprecated, message: "Testing deprecated functionality")
@Test func swiftLog1CompatibilityMethodReachesASourceOnlyHandler() {
let testLogging = NewerButStillOldTestLogging()
let handler = testLogging.make(label: "compat")
handler.log(
level: .error,
message: "compat",
metadata: nil,
file: "/Sources/CompatModule/Caller.swift",
function: #function,
line: 42
)
testLogging.history.assertExist(level: .error, message: "compat", source: "CompatModule")
}
}
/// Implements `log(event:)` and nothing else.
private struct EventOnlyLogHandler: LogHandler {
private final class Store: @unchecked Sendable {
private let lock = Lock()
private var events: [LogEvent] = []
func append(_ event: LogEvent) {
self.lock.withLock { self.events.append(event) }
}
var all: [LogEvent] {
self.lock.withLock { self.events }
}
}
private let store = Store()
var metadata: Logger.Metadata = [:]
var logLevel: Logger.Level = .trace
subscript(metadataKey metadataKey: String) -> Logger.Metadata.Value? {
get { self.metadata[metadataKey] }
set { self.metadata[metadataKey] = newValue }
}
func log(event: LogEvent) {
self.store.append(event)
}
var recorded: [LogEvent] { self.store.all }
}
private struct OldSchoolTestLogging {
+1
View File
@@ -12,6 +12,7 @@
//
//===----------------------------------------------------------------------===//
import Foundation
import Testing
@testable import Logging
+40 -12
View File
@@ -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",
]
)
}
@@ -1143,6 +1140,37 @@ 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")
}
@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 {
@@ -127,6 +127,69 @@ struct MetadataValueInterpolationTests {
#expect(value.description == String(describing: box))
}
// MARK: - Optional interpolation with a default
@Test("nil optional uses the default string")
func defaultNil() {
let value: Int? = nil
let result: Logger.MetadataValue = "\(value, default: "none")"
#expect(result.description == "none")
}
@Test("non-nil optional interpolates the wrapped value")
func defaultSome() {
let value: Int? = 42
let result: Logger.MetadataValue = "\(value, default: "none")"
#expect(result.description == "42")
}
@Test("nil optional of a TOS-only type uses the default")
func defaultNilStreamingOnly() {
let value: StreamingOnly? = nil
let result: Logger.MetadataValue = "\(value, default: "missing")"
#expect(result.description == "missing")
}
@Test("non-nil optional of a CSC-only type interpolates via .description")
func defaultSomeDescribingOnly() {
let value: DescribingOnly? = DescribingOnly(value: 3)
let result: Logger.MetadataValue = "\(value, default: "missing")"
#expect(result.description == "DO(3)")
}
@Test("nil optional of a non-CSC, non-TOS type uses the default")
func defaultNilUnconstrained() {
let value: PlainStruct? = nil
let result: Logger.MetadataValue = "\(value, default: "absent")"
#expect(result.description == "absent")
}
@Test("default accepts a Substring (some StringProtocol)")
func defaultSubstring() {
let value: Int? = nil
let fallback = "n/a value".dropFirst(4)
let result: Logger.MetadataValue = "\(value, default: fallback)"
#expect(result.description == "value")
}
@Test("default segment mixed with plain segments")
func defaultMultiSegment() {
let name: String? = nil
let result: Logger.MetadataValue = "user=\(name, default: "anon") id=\(42)"
#expect(result.description == "user=anon id=42")
}
@Test("default interpolation yields .string case")
func defaultYieldsStringCase() {
let value: Int? = nil
let result: Logger.MetadataValue = "\(value, default: "none")"
if case .string(let s) = result {
#expect(s == "none")
} else {
Issue.record("Expected .string case, got \(result)")
}
}
// MARK: - Overloaded return types
@Test("Overloaded function returning String/Data/[UInt8] disambiguates to String")
@@ -0,0 +1,63 @@
//===----------------------------------------------------------------------===//
//
// 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 Logging
import Testing
@Suite
struct MetadataValueTest {
@Test
func descriptionRendering() {
#expect(Logger.MetadataValue.array([]).description == "[]")
#expect(Logger.MetadataValue.array(["a", "b"]).description == ["a", "b"].description)
#expect(Logger.MetadataValue.dictionary([:]).description == "[:]")
#expect(Logger.MetadataValue.dictionary(["k": "v"]).description == ["k": "v"].description)
#expect(
Logger.MetadataValue.dictionary(["outer": ["inner": "leaf"]]).description
== "[\"outer\": [\"inner\": \"leaf\"]]"
)
}
@Test
func equatableCompareson() {
let lhs: Logger.MetadataValue = ["a": ["1", "2"]]
let rhs: Logger.MetadataValue = ["a": ["1", "2"]]
let different: Logger.MetadataValue = ["a": ["1", "3"]]
#expect(lhs == rhs)
#expect(lhs != different)
}
@Test
func descriptionOfNestedArraysGrowsLinearlyNotExponentially() {
var value: Logger.MetadataValue = .string("leaf")
for _ in 0..<100 {
value = .array([value])
}
// "leaf".debugDescription + each level adds a "[" and "]".
#expect(value.description.count == 6 + 2 * 100)
}
@Test
func equatableComparesNestedArrays() {
var lhs: Logger.MetadataValue = .string("leaf")
var rhs: Logger.MetadataValue = .string("leaf")
for _ in 0..<100 {
lhs = .array([lhs])
rhs = .array([rhs])
}
#expect(lhs == rhs)
}
}
@@ -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"
@@ -0,0 +1,448 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Logging API open source project
//
// Copyright (c) 2025 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 Testing
@testable import Logging
struct TaskLocalLoggerTest {
// MARK: - Binding a logger
@Test func bindLogger() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
withLogger(logger) { logger in
logger.info("bound")
}
logging.history.assertExist(level: .info, message: "bound")
}
@Test func bindLoggerAsyncReturning() async {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
let result = await withLogger(logger) { logger -> Int in
await Task.yield()
logger.info("computing")
return 42
}
#expect(result == 42)
logging.history.assertExist(level: .info, message: "computing")
}
/// The bind overload replaces the task-local logger; accumulated metadata from an
/// enclosing `withLogger(mergingMetadata:)` scope is intentionally not carried over.
@Test func bindReplacesAccumulatedMetadata() {
let logging1 = TestLogging()
let logging2 = TestLogging()
let root = Logger(label: "root", factory: { logging1.make(label: $0) })
let other = Logger(label: "other", factory: { logging2.make(label: $0) })
withLogger(root) { _ in
withLogger(mergingMetadata: ["request.id": "r1"]) { _ in
withLogger(other) { inner in
inner.info("no request.id")
}
}
}
let entry = logging2.history.entries.first { $0.message == "no request.id" }
#expect(entry?.metadata?["request.id"] == nil)
}
// MARK: - Modifying the current logger
@Test func mergeMetadata() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
withLogger(logger) { _ in
withLogger(mergingMetadata: ["key": "value"]) { logger in
logger.info("merged")
}
}
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) })
withLogger(logger) { _ in
withLogger(logLevel: .warning) { logger in
logger.debug("suppressed")
logger.warning("emitted")
}
}
logging.history.assertNotExist(level: .debug, message: "suppressed")
logging.history.assertExist(level: .warning, message: "emitted")
}
@Test func nestedMetadataAccumulates() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
withLogger(logger) { _ in
withLogger(mergingMetadata: ["level1": "first"]) { _ in
withLogger(mergingMetadata: ["level2": "second"]) { logger in
logger.info("inner")
}
}
}
logging.history.assertExist(
level: .info,
message: "inner",
metadata: ["level1": "first", "level2": "second"]
)
}
@Test func innerMetadataOverridesOuter() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
withLogger(logger) { _ in
withLogger(mergingMetadata: ["key": "outer"]) { _ in
withLogger(mergingMetadata: ["key": "inner"]) { logger in
logger.info("test")
}
}
}
logging.history.assertExist(level: .info, message: "test", metadata: ["key": "inner"])
}
/// The modifying `withLogger(metadata:)` overload replaces the inherited metadata
/// rather than layering — passing `[:]` wipes; passing a fresh dict starts the scope
/// from a known state.
@Test func metadataReplacesInherited() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
withLogger(logger) { _ in
withLogger(mergingMetadata: ["request.id": "r1", "user.id": "u1"]) { _ in
withLogger(metadata: ["job.id": "j1"]) { scoped in
scoped.info("background")
}
}
}
let entry = logging.history.entries.first { $0.message == "background" }
#expect(entry?.metadata?["job.id"] == "j1")
#expect(entry?.metadata?["request.id"] == nil)
#expect(entry?.metadata?["user.id"] == nil)
}
@Test func metadataEmptyDictWipesInherited() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
withLogger(logger) { _ in
withLogger(mergingMetadata: ["request.id": "r1"]) { _ in
withLogger(metadata: [:]) { scoped in
scoped.info("wiped")
}
}
}
let entry = logging.history.entries.first { $0.message == "wiped" }
#expect(entry?.metadata?.isEmpty ?? true)
}
/// `withLogger(handler:)` routes logs to a different handler for the scope — the
/// canonical use is swapping in an in-memory handler to capture logs for assertions
/// in a test.
@Test func handlerSwapsForScope() {
let outer = TestLogging()
let inner = TestLogging()
let appLogger = Logger(label: "app", factory: { outer.make(label: $0) })
withLogger(appLogger) { _ in
for _ in outer.history.entries {} // touch outer so we can see the drift
withLogger(handler: inner.make(label: "captured"), metadata: ["case": "test"]) { scoped in
scoped.info("emitted under inner handler")
}
appLogger.info("back under outer")
}
inner.history.assertExist(
level: .info,
message: "emitted under inner handler",
metadata: ["case": "test"]
)
inner.history.assertNotExist(level: .info, message: "back under outer")
outer.history.assertExist(level: .info, message: "back under outer")
outer.history.assertNotExist(level: .info, message: "emitted under inner handler")
}
@Test(arguments: [Logger.Level.debug, .warning])
func handlerSwapRespectsExplicitLogLevel(level: Logger.Level) {
let outer = TestLogging()
let inner = TestLogging()
var appLogger = Logger(label: "app", factory: { outer.make(label: $0) })
appLogger.logLevel = .critical
var replacement = inner.make(label: "captured")
replacement.logLevel = .info
let suppressedLevel: Logger.Level = level == .debug ? .trace : .info
withLogger(appLogger) { _ in
withLogger(logLevel: level, handler: replacement) { scoped in
#expect(scoped.logLevel == level)
#expect(Logger.current.logLevel == level)
scoped.log(level: level, "emitted")
Logger.current.log(level: suppressedLevel, "suppressed")
}
#expect(Logger.current.logLevel == .critical)
}
#expect(replacement.logLevel == .info)
inner.history.assertExist(level: level, message: "emitted")
inner.history.assertNotExist(level: suppressedLevel, message: "suppressed")
outer.history.assertNotExist(level: level, message: "emitted")
}
@Test(arguments: [Logger.Level.debug, .warning])
func asyncHandlerSwapRespectsExplicitLogLevel(level: Logger.Level) async {
let outer = TestLogging()
let inner = TestLogging()
var appLogger = Logger(label: "app", factory: { outer.make(label: $0) })
appLogger.logLevel = .critical
var replacement = inner.make(label: "captured")
replacement.logLevel = .info
let suppressedLevel: Logger.Level = level == .debug ? .trace : .info
await withLogger(appLogger) { _ in
await withLogger(logLevel: level, handler: replacement) { scoped in
await Task.yield()
#expect(scoped.logLevel == level)
#expect(Logger.current.logLevel == level)
scoped.log(level: level, "emitted")
Logger.current.log(level: suppressedLevel, "suppressed")
}
#expect(Logger.current.logLevel == .critical)
}
#expect(replacement.logLevel == .info)
inner.history.assertExist(level: level, message: "emitted")
inner.history.assertNotExist(level: suppressedLevel, message: "suppressed")
outer.history.assertNotExist(level: level, message: "emitted")
}
@Test func siblingScopesAreIsolated() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
withLogger(logger) { _ in
withLogger(mergingMetadata: ["a": "1"]) { logger in
logger.info("first")
}
withLogger(mergingMetadata: ["b": "2"]) { logger in
logger.info("second")
}
}
let second = logging.history.entries.first { $0.message == "second" }
#expect(second?.metadata?["a"] == nil)
#expect(second?.metadata?["b"] == "2")
}
// MARK: - Async propagation and task isolation
@Test func contextPreservedAcrossAwait() async throws {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
await withLogger(logger) { _ in
await withLogger(mergingMetadata: ["request": "123"]) { logger in
logger.info("before await")
await Task.yield()
logger.info("after await")
}
}
logging.history.assertExist(level: .info, message: "before await", metadata: ["request": "123"])
logging.history.assertExist(level: .info, message: "after await", metadata: ["request": "123"])
}
@Test func childTaskInheritsContextDetachedDoesNot() async {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
await withLogger(logger) { _ in
await withLogger(mergingMetadata: ["parent": "value"]) { _ in
await Task {
Logger.current.info("child")
}.value
await Task.detached {
Logger.current.info("detached")
}.value
}
}
logging.history.assertExist(level: .info, message: "child", metadata: ["parent": "value"])
// Detached task starts without a task-local logger and falls back to a freshly
// constructed `Logger(label: "")`, which doesn't reach our per-test TestLogging.
logging.history.assertNotExist(level: .info, message: "detached")
}
@Test func concurrentTasksHaveIndependentContext() async {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
await withLogger(logger) { _ in
await withLogger(mergingMetadata: ["context": "parent"]) { _ in
await withTaskGroup(of: Void.self) { group in
group.addTask {
withLogger(mergingMetadata: ["task": "1"]) { logger in
logger.info("task 1")
}
}
group.addTask {
withLogger(mergingMetadata: ["task": "2"]) { logger in
logger.info("task 2")
}
}
}
}
}
logging.history.assertExist(
level: .info,
message: "task 1",
metadata: ["task": "1", "context": "parent"]
)
logging.history.assertExist(
level: .info,
message: "task 2",
metadata: ["task": "2", "context": "parent"]
)
}
@Test func asyncLetInheritsContext() async {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
func observedScope() async -> String? {
Logger.current.handler.metadata["scope"]?.description
}
await withLogger(logger) { _ in
await withLogger(mergingMetadata: ["scope": "parent"]) { _ in
async let inherited = observedScope()
let observed = await inherited
#expect(observed == "parent")
}
}
}
// MARK: - Error propagation
@Test func bindPropagatesThrow() {
struct TestError: Error {}
#expect(throws: TestError.self) {
try withLogger(Logger(label: "t")) { _ in
throw TestError()
}
}
}
@Test func modifyAsyncPropagatesThrow() async {
struct TestError: Error {}
#expect(throws: TestError.self) {
try withLogger(mergingMetadata: ["k": "v"]) { _ in
throw TestError()
}
}
}
// MARK: - Fallback behavior
@Test func fallbackUsesEmptyLabel() {
// Without an active `withLogger` scope, `Logger.current` returns the process-wide
// unbound default — a `Logger(label: "")` cached from the first time the
// task-local is touched. The empty label is the diagnostic signal that no
// `withLogger` scope was set up before the read.
withLogger(mergingMetadata: ["key": "value"]) { logger in
#expect(logger.label == "")
}
}
// MARK: - Real-world patterns
@Test func libraryReadsCurrentWithoutLoggerParameter() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
struct DatabaseClient {
func query(_ sql: String) {
Logger.current.debug("query", metadata: ["sql": "\(sql)"])
}
}
withLogger(logger) { _ in
withLogger(mergingMetadata: ["request.id": "123"]) { _ in
DatabaseClient().query("SELECT 1")
}
}
logging.history.assertExist(
level: .debug,
message: "query",
metadata: ["request.id": "123", "sql": "SELECT 1"]
)
}
// MARK: - Stress
@Test func deeplyNestedScopes() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
func nest(depth: Int) {
if depth == 0 {
Logger.current.info("bottom")
return
}
withLogger(mergingMetadata: ["d-\(depth)": "\(depth)"]) { _ in
nest(depth: depth - 1)
}
}
withLogger(logger) { _ in
nest(depth: 20)
}
let entry = logging.history.entries.first { $0.message == "bottom" }
#expect(entry?.metadata?.count == 20)
}
}
+55
View File
@@ -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 {}
+22
View File
@@ -0,0 +1,22 @@
#===----------------------------------------------------------------------===#
#
# This source file is part of the Swift Logging API open source project
#
# Copyright (c) 2018-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
#
#===----------------------------------------------------------------------===#
set(SwiftLog_EXPORTS_FILE ${CMAKE_CURRENT_BINARY_DIR}/SwiftLogExports.cmake)
configure_file(SwiftLogConfig.cmake.in
${CMAKE_CURRENT_BINARY_DIR}/SwiftLogConfig.cmake)
get_property(SwiftLog_EXPORTS GLOBAL PROPERTY SwiftLog_EXPORTS)
export(TARGETS ${SwiftLog_EXPORTS}
FILE ${SwiftLog_EXPORTS_FILE})
+17
View File
@@ -0,0 +1,17 @@
##===----------------------------------------------------------------------===##
##
## This source file is part of the Swift Logging API open source project
##
## Copyright (c) 2018-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
##
##===----------------------------------------------------------------------===##
if(NOT TARGET Logging)
include(@SwiftLog_EXPORTS_FILE@)
endif()
+80
View File
@@ -0,0 +1,80 @@
##===----------------------------------------------------------------------===##
##
## This source file is part of the Swift Logging API open source project
##
## Copyright (c) 2018-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
##
##===----------------------------------------------------------------------===##
# Returns the os name in a variable
#
# Usage:
# get_swift_host_os(result_var_name)
#
#
# Sets ${result_var_name} with the converted OS name derived from
# CMAKE_SYSTEM_NAME.
function(get_swift_host_os result_var_name)
if(CMAKE_SYSTEM_NAME STREQUAL Darwin)
set(${result_var_name} macosx PARENT_SCOPE)
else()
string(TOLOWER ${CMAKE_SYSTEM_NAME} cmake_system_name_lc)
set(${result_var_name} ${cmake_system_name_lc} PARENT_SCOPE)
endif()
endfunction()
if(NOT Swift_MODULE_TRIPLE)
# Attempt to get the module triple from the Swift compiler.
set(module_triple_command "${CMAKE_Swift_COMPILER}" -print-target-info)
if(CMAKE_Swift_COMPILER_TARGET)
list(APPEND module_triple_command -target ${CMAKE_Swift_COMPILER_TARGET})
endif()
execute_process(COMMAND ${module_triple_command}
OUTPUT_VARIABLE target_info_json)
string(JSON module_triple GET "${target_info_json}" "target" "moduleTriple")
# Exit now if we failed to infer the triple.
if(NOT module_triple)
message(FATAL_ERROR
"Failed to get module triple from Swift compiler. "
"Compiler output: ${target_info_json}")
endif()
# Cache the module triple for future use.
set(Swift_MODULE_TRIPLE "${module_triple}" CACHE STRING "swift module triple used for installed swiftmodule and swiftinterface files")
mark_as_advanced(Swift_MODULE_TRIPLE)
endif()
function(_install_target module)
get_swift_host_os(swift_os)
get_target_property(type ${module} TYPE)
if(type STREQUAL STATIC_LIBRARY)
set(swift swift_static)
else()
set(swift swift)
endif()
install(TARGETS ${module})
if(type STREQUAL EXECUTABLE)
return()
endif()
get_target_property(module_name ${module} Swift_MODULE_NAME)
if(NOT module_name)
set(module_name ${module})
endif()
install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftdoc
DESTINATION ${CMAKE_INSTALL_LIBDIR}/${swift}/${swift_os}/${module_name}.swiftmodule
RENAME ${Swift_MODULE_TRIPLE}.swiftdoc)
install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftmodule
DESTINATION ${CMAKE_INSTALL_LIBDIR}/${swift}/${swift_os}/${module_name}.swiftmodule
RENAME ${Swift_MODULE_TRIPLE}.swiftmodule)
endfunction()