Compare commits

...
29 Commits
Author SHA1 Message Date
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
88 changed files with 1169 additions and 256 deletions

No files matched your search

+13 -6
View File
@@ -14,19 +14,21 @@ jobs:
name: Unit tests
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
with:
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_1_enabled: false
linux_6_4_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_1_enabled: false
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_6_4_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_6_4_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"
@@ -36,6 +38,7 @@ jobs:
with:
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
macos_swift_6_3_enabled: true
macos_swift_6_4_enabled: true
cxx-interop:
name: Cxx interop
@@ -52,8 +55,11 @@ jobs:
with:
runner_pool: nightly
build_scheme: swift-log-Package
debug_output_enabled: true
macos_xcode_test_enabled: false
swift_6_1_enabled: false
swift_6_2_enabled: true
swift_6_3_enabled: true
swift_6_4_enabled: true
macos_xcode_test_enabled: true
ios_xcode_test_enabled: false
watchos_xcode_test_enabled: false
tvos_xcode_test_enabled: false
@@ -74,8 +80,9 @@ jobs:
name: Release builds
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
with:
windows_6_1_enabled: true
windows_6_1_enabled: false
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_6_4_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
+31 -5
View File
@@ -10,7 +10,7 @@ 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.16
with:
license_header_check_project_name: "Swift Logging API"
@@ -18,19 +18,21 @@ jobs:
name: Unit tests
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
with:
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_1_enabled: false
linux_6_4_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_1_enabled: false
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_6_4_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_6_4_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"
@@ -41,6 +43,7 @@ jobs:
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
macos_runner_pool: general
macos_swift_6_3_enabled: true
macos_swift_6_4_enabled: true
cxx-interop:
name: Cxx interop
@@ -58,6 +61,15 @@ jobs:
runner_pool: general
build_scheme: swift-log-Package
swift_test_enabled: true
swift_6_1_enabled: false
swift_6_2_enabled: true
swift_6_3_enabled: true
swift_6_4_enabled: true
macos_xcode_test_enabled: true
ios_xcode_test_enabled: false
watchos_xcode_test_enabled: false
tvos_xcode_test_enabled: false
visionos_xcode_test_enabled: false
android:
name: Android Swift SDK
@@ -68,9 +80,10 @@ jobs:
name: Release builds
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
with:
windows_6_1_enabled: true
windows_6_1_enabled: false
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_6_4_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
@@ -79,3 +92,16 @@ jobs:
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
with:
nightly_next_enabled: false
cmake-lists:
name: Check CMake Lists
uses: apple/swift-nio/.github/workflows/cmake_tests.yml@main
with:
image: "swift:6.2-jammy"
update_cmake_lists_config: >-
{
"targets": [
{ "name": "Logging", "type": "source", "exceptions": [] },
{ "name": "InMemoryLogging", "type": "source", "exceptions": [] }
]
}
+3 -3
View File
@@ -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")
]
)
]
@@ -1,4 +1,4 @@
{
"instructions" : 734,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 734,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 734,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 759,
"instructions" : 710,
"objectAllocCount" : 0
}
}
@@ -0,0 +1,4 @@
{
"instructions" : 810,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 803,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 803,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 803,
"objectAllocCount" : 0
}
+3 -3
View File
@@ -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")
]
)
]
@@ -1,4 +1,4 @@
{
"instructions" : 734,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 734,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 734,
"instructions" : 689,
"objectAllocCount" : 0
}
@@ -1,4 +1,4 @@
{
"instructions" : 1993,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 1968,
"objectAllocCount" : 0
}
}
@@ -0,0 +1,4 @@
{
"instructions" : 815,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 750,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 775,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 2008,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 2002,
"objectAllocCount" : 0
}
@@ -86,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)
}
}
}
+3 -3
View File
@@ -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")
]
)
]
@@ -1,4 +1,4 @@
{
"instructions" : 1050,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 1050,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 1046,
"objectAllocCount" : 0
}
}
@@ -0,0 +1,4 @@
{
"instructions" : 5483,
"objectAllocCount" : 1
}
@@ -0,0 +1,4 @@
{
"instructions" : 4939775,
"objectAllocCount" : 2016
}
@@ -0,0 +1,4 @@
{
"instructions" : 82239,
"objectAllocCount" : 37
}
@@ -0,0 +1,4 @@
{
"instructions" : 18351,
"objectAllocCount" : 6
}
@@ -1,4 +1,4 @@
{
"instructions" : 5935,
"instructions" : 6200,
"objectAllocCount" : 2
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 7151,
"instructions" : 7600,
"objectAllocCount" : 3
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 1005,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 1017,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 1966,
"objectAllocCount" : 0
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 4551,
"objectAllocCount" : 1
}
}
@@ -1,4 +1,4 @@
{
"instructions" : 9623,
"objectAllocCount" : 4
}
}
@@ -0,0 +1,4 @@
{
"instructions" : 1119,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1119,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1117,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 5327,
"objectAllocCount" : 1
}
@@ -0,0 +1,4 @@
{
"instructions" : 4263935,
"objectAllocCount" : 2016
}
@@ -0,0 +1,4 @@
{
"instructions" : 69119,
"objectAllocCount" : 37
}
@@ -0,0 +1,4 @@
{
"instructions" : 15471,
"objectAllocCount" : 6
}
@@ -0,0 +1,4 @@
{
"instructions" : 6851,
"objectAllocCount" : 2
}
@@ -0,0 +1,4 @@
{
"instructions" : 8399,
"objectAllocCount" : 3
}
@@ -0,0 +1,4 @@
{
"instructions" : 1095,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1038,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1972,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 4171,
"objectAllocCount" : 1
}
@@ -0,0 +1,4 @@
{
"instructions" : 10231,
"objectAllocCount" : 4
}
+2 -2
View File
@@ -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"),
]
)
+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")
message(FATAL_ERROR "swift-log requires Swift compiler version 6.2 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
+4 -2
View File
@@ -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
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)
@@ -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
@@ -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)
@@ -6,7 +6,7 @@ Accumulate structured logging metadata across async call stacks using task-local
- Proposal: SLG-0006
- Author(s): [Vladimir Kukushkin](https://github.com/kukushechkin)
- Status: **Ready for Implementation**
- 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
@@ -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
@@ -144,9 +144,23 @@ public struct MultiplexLogHandler: LogHandler {
/// Log a message using the log level and source that you provide.
///
/// Metadata from this handler's metadata provider overrides metadata from
/// the underlying handlers and their providers. Explicit metadata in the
/// log event takes precedence over this handler's provider.
///
/// - parameters:
/// - event: The log event containing the level, message, metadata, and source location.
public func log(event: LogEvent) {
var event = event
if let provider = self._metadataProvider {
var metadata = provider.get()
if let explicit = event.metadata {
metadata.merge(explicit, uniquingKeysWith: { _, explicit in explicit })
}
if !metadata.isEmpty {
event.metadata = metadata
}
}
for handler in self.handlers where handler.logLevel <= event.level {
handler.log(event: event)
}
@@ -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`.
@@ -102,13 +100,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
@@ -336,8 +345,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 +422,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
)
)
}
}
+3 -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
+16 -86
View File
@@ -19,8 +19,8 @@
/// 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:_:)-(_,(Logger)(Failure)->Result)`` or
/// ``withLogger(logLevel:handler:metadata:_:)-(_,_,_,(Logger)(Failure)->Result)``
/// ``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.
///
@@ -29,7 +29,7 @@
/// ``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:_:)-(_,_,_,(Logger)(Failure)->Result)``
/// routing), use ``withLogger(logLevel:handler:metadata:_:)-2pd9p``
/// instead — it modifies
/// the current logger's handler in place without constructing a new one.
///
@@ -66,8 +66,8 @@ public func withLogger<Result, Failure: Error>(
/// 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:_:)-(_,(Logger)(Failure)->Result)`` or
/// ``withLogger(logLevel:handler:metadata:_:)-(_,_,_,(Logger)(Failure)->Result)``
/// ``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.
///
@@ -76,7 +76,7 @@ public func withLogger<Result, Failure: Error>(
/// ``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:_:)-(_,_,_,(Logger)(Failure)->Result)``
/// routing), use ``withLogger(logLevel:handler:metadata:_:)-5nmw6``
/// instead — it modifies
/// the current logger's handler in place without constructing a new one.
///
@@ -93,7 +93,6 @@ public func withLogger<Result, Failure: Error>(
/// - 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`.
#if compiler(>=6.2)
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
@@ -108,23 +107,6 @@ public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
throw error as! Failure
}
}
#else
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public func withLogger<Result, Failure: Error>(
_ logger: Logger,
isolation: isolated (any Actor)? = #isolation,
_ operation: (Logger) async throws(Failure) -> Result,
) async throws(Failure) -> Result {
do {
return try await Logger.withTaskLocalLogger(logger, isolation: isolation) {
try await operation(logger)
}
} catch {
throw error as! Failure
}
}
#endif
/// 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
@@ -132,7 +114,7 @@ public func withLogger<Result, Failure: Error>(
/// `metadata`) are preserved.
///
/// Use this overload at request boundaries and any point where context should
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-(_,(Logger)(Failure)->Result)`` scopes
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-2c7dy`` scopes
/// layer on top of each
/// other.
///
@@ -176,7 +158,7 @@ public func withLogger<Result, Failure: Error>(
/// `metadata`) are preserved.
///
/// Use this overload at request boundaries and any point where context should
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-(_,(Logger)(Failure)->Result)`` scopes
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-3eduo`` scopes
/// layer on top of each
/// other.
///
@@ -195,7 +177,6 @@ public func withLogger<Result, Failure: Error>(
/// - operation: The async closure to run with the merged logger bound. Receives the
/// merged logger as a parameter.
/// - Returns: The value returned by `operation`.
#if compiler(>=6.2)
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
@@ -214,32 +195,11 @@ public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
throw error as! Failure
}
}
#else
@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,
isolation: isolated (any Actor)? = #isolation,
_ operation: (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, isolation: isolation) {
try await operation(logger)
}
} catch {
throw error as! Failure
}
}
#endif
/// 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:_:)-(_,(Logger)(Failure)->Result)``, which layers
/// 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.
@@ -282,12 +242,12 @@ public func withLogger<Result, Failure: Error>(
_ operation: (Logger) throws(Failure) -> Result
) throws(Failure) -> Result {
var logger = Logger.current
if let logLevel {
logger.logLevel = logLevel
}
if let handler {
logger.handler = handler
}
if let logLevel {
logger.logLevel = logLevel
}
if let metadata = metadata() {
logger.handler.metadata = metadata
}
@@ -303,7 +263,7 @@ public func withLogger<Result, Failure: Error>(
/// 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:_:)-(_,(Logger)(Failure)->Result)``, which layers
/// 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.
@@ -337,7 +297,6 @@ public func withLogger<Result, Failure: Error>(
/// - operation: The async closure to run with the modified logger bound. Receives the
/// modified logger as a parameter.
/// - Returns: The value returned by `operation`.
#if compiler(>=6.2)
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@inlinable
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
@@ -347,12 +306,12 @@ public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
_ operation: nonisolated(nonsending) (Logger) async throws(Failure) -> Result
) async throws(Failure) -> Result {
var logger = Logger.current
if let logLevel {
logger.logLevel = logLevel
}
if let handler {
logger.handler = handler
}
if let logLevel {
logger.logLevel = logLevel
}
if let metadata = metadata() {
logger.handler.metadata = metadata
}
@@ -364,32 +323,3 @@ public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
throw error as! Failure
}
}
#else
@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,
isolation: isolated (any Actor)? = #isolation,
_ operation: (Logger) async throws(Failure) -> Result
) async throws(Failure) -> Result {
var logger = Logger.current
if let logLevel {
logger.logLevel = logLevel
}
if let handler {
logger.handler = handler
}
if let metadata = metadata() {
logger.handler.metadata = metadata
}
do {
return try await Logger.withTaskLocalLogger(logger, isolation: isolation) {
try await operation(logger)
}
} catch {
throw error as! Failure
}
}
#endif
+30 -22
View File
@@ -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.
@@ -1414,14 +1422,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
}
}
}
@@ -1472,7 +1495,6 @@ extension Logger {
/// Thin wrapper over `TaskLocal.withValue` so call sites don't need to reach into
/// the task-local storage directly.
#if compiler(>=6.2)
@inlinable
nonisolated(nonsending) static func withTaskLocalLogger<Return, Failure: Error>(
_ value: Logger,
@@ -1484,20 +1506,6 @@ extension Logger {
throw error as! Failure
}
}
#else
@inlinable
static func withTaskLocalLogger<Return, Failure: Error>(
_ value: Logger,
isolation: isolated (any Actor)? = #isolation,
operation: () async throws(Failure) -> Return
) async throws(Failure) -> Return {
do {
return try await Self.taskLocalLogger.withValue(value, operation: operation, isolation: isolation)
} catch {
throw error as! Failure
}
}
#endif
@inlinable
static func withTaskLocalLogger<Return, Failure: Error>(
@@ -1514,7 +1522,7 @@ extension Logger {
/// The current task-local logger.
///
/// Returns the logger bound by the nearest enclosing
/// ``withLogger(_:_:)-(_,(Logger)(Failure)->Result)`` scope. If none is active, returns the
/// ``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
@@ -0,0 +1,48 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Logging API open source project
//
// Copyright (c) 2026 Apple Inc. and the Swift Logging API project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import InMemoryLogging
import Logging
import Testing
struct MultiplexProviderRegressionTests {
@Test(arguments: [1, 2])
func constructorProviderReachesEverySink(handlerCount: Int) {
let sinks = (0..<handlerCount).map { _ in InMemoryLogHandler() }
let handler = MultiplexLogHandler(sinks, metadataProvider: .init { ["trace-id": "123"] })
let logger = Logger(label: "test", factory: { _ in handler })
#expect(logger.metadataProvider?.get()["trace-id"] == "123")
logger.info("hello")
for sink in sinks {
#expect(sink.entries.count == 1)
#expect(sink.entries.first?.metadata["trace-id"] == "123")
}
}
@Test func constructorProviderLayersBetweenChildAndExplicitMetadata() {
var sink = InMemoryLogHandler()
sink.metadataProvider = .init { ["child": "kept", "shared": "child"] }
let handler = MultiplexLogHandler(
[sink],
metadataProvider: .init {
["outer": "kept", "shared": "outer"]
}
)
let logger = Logger(label: "test", factory: { _ in handler })
logger.info("provided")
logger.info("explicit", metadata: ["shared": "explicit"])
#expect(sink.entries.first?.metadata == ["child": "kept", "outer": "kept", "shared": "outer"])
#expect(sink.entries.last?.metadata == ["child": "kept", "outer": "kept", "shared": "explicit"])
}
}
@@ -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
+17
View File
@@ -1143,6 +1143,23 @@ struct LoggingTest {
#expect(.error == logger1.logLevel)
#expect(.trace == logger2.logLevel)
}
@Test func loggerMetadataWriteMutatesHandlerInPlace() {
var logger1 = Logger(label: "foo", factory: { _ in CopyCountingLogHandler() })
for i in 0..<10 {
logger1[metadataKey: "key\(i)"] = "\(i)"
}
#expect(logger1.handlerCopies == 0)
// The first write to a copy copies the handler once, later writes reuse that copy.
var logger2 = logger1
for i in 0..<10 {
logger2[metadataKey: "key\(i)"] = "changed"
}
#expect(logger2.handlerCopies == 1)
#expect(logger1.handlerCopies == 0)
#expect(logger1[metadataKey: "key0"] == "0")
}
}
extension Logger {
@@ -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)
}
}
@@ -79,6 +79,20 @@ struct TaskLocalLoggerTest {
logging.history.assertExist(level: .info, message: "merged", metadata: ["key": "value"])
}
@Test func mergeMetadataCopiesHandlerOnce() {
let logger = Logger(label: "test", factory: { _ in CopyCountingLogHandler() })
let metadata: Logger.Metadata = ["a": "1", "b": "2", "c": "3", "d": "4", "e": "5"]
withLogger(logger) { _ in
withLogger(mergingMetadata: metadata) { inner in
#expect(inner.handler.metadata == metadata)
#expect(inner.handlerCopies == 1)
}
#expect(Logger.current.handler.metadata.isEmpty)
#expect(Logger.current.handlerCopies == 0)
}
}
@Test func overrideLogLevel() {
let logging = TestLogging()
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
@@ -191,6 +205,59 @@ struct TaskLocalLoggerTest {
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) })
+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()