Compare commits

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

### Motivation:

Modernize and unify workflows with swiftlang.

### Modifications:

CI configuration updated.

### Result:

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

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

### Modifications:

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

### Result:

More reliable benchmarks that don't fail 20% of the time.
2026-11-19 09:59:58 +00:00
0z5a c7413d967b Make MultiplexLogHandler.metadataProvider setter replace the initializer's provider (#537)
### Motivation:

`MultiplexLogHandler.metadataProvider`'s setter only forwards the new
provider to the underlying handlers. Since #522, `log(event:)` also
merges the provider passed to `init(_:metadataProvider:)` on top of the
underlying handlers' metadata, so after a set that old provider still
overrides the new one for conflicting keys, setting `nil` doesn't remove
it, and the getter keeps returning it.

This shows up through `Logger(label:metadataProvider:)`, which calls the
factory and then sets `handler.metadataProvider`. If the bootstrapped
factory returns a `MultiplexLogHandler` with its own provider, the
provider the library passed is silently overridden. With a plain handler
the same code uses the library's provider, which is what
`Logger(label:metadataProvider:)` documents ("the custom metadata
provider this logger should invoke, instead of the system wide
bootstrapped one").

### Modifications:

- In the setter, also replace the multiplex handler's own provider with
the new value. It is still forwarded to the underlying handlers as
before.
- Document the setter.
- Add regression tests: setting a provider replaces the initializer's
provider for one and two handlers, and setting `nil` clears it (both the
getter and emitted logs). Another test covers an underlying handler that
doesn't support metadata providers.

I kept forwarding to the underlying handlers and replace the multiplex
handler's own provider as well, rather than clearing it. Clearing it
would drop provider metadata for underlying handlers that use the
default `metadataProvider` implementation in the
`Logger(label:metadataProvider:)` case, which works today.

### Result:

After `handler.metadataProvider = p`, logs and the getter use `p`. After
`handler.metadataProvider = nil`, no provider metadata is added. In the
common setup where the factory passes its provider into the
`MultiplexLogHandler` initializer, the number of provider calls per log
stays the same. When the multiplex handler had no provider of its own, a
set now also applies the provider once at the multiplex level, so
underlying handlers without provider support get its metadata too.

The new tests fail on main and pass with this change. All tests pass
locally on macOS (Swift 6.3.3), and `swift format lint` is clean on the
changed files. I couldn't run the benchmarks locally.

This change was drafted with Claude Code (claude-opus-5-5); the test
results above are from the runs described.
2026-11-17 13:24:42 +00:00
Tony Allevato 34b131f794 Support raw-identifier module names in Logger.currentModule. (#535)
When a module name (via `-module-alias`) is a raw identifier (SE-0451),
`#fileID` formats the module component enclosed in backticks (for
example, `` `/a/b/c`/File.swift ``). If the raw identifier contains '/',
splitting on the first '/' in `#fileID` truncates the module name at the
slash inside the backticks.

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

## Problem

`MultiplexLogHandler` had inconsistent metadata priority:

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

## Fix

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

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

## Testing

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

---------

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

### Motivation:

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

### Modifications:

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

### Result:

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

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

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

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

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


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

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

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

---

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

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


</details>

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

### Motivation:

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

### Modifications:

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

### Result:

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

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

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

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

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

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


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

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

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

---

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

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


</details>

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

### Motivation: 

Update benchmark expectations, with the updated performance level

### Modifications:

Update json file with the new instruction count

### Result:

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

### Motivation: Update threshold

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

### Modifications:

Updated threshold to a lower value

### Result:

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

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

### Modifications:

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

### Result:

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

Fixes #521.

## Motivation

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

## Modifications

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

## Result

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

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

## Motivation

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

## Modifications

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

## Result

The scoped logger filters messages at the requested level.

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


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

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

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

---

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

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


</details>

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

### Motivation:

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

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

### Modifications:

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

### Result:

100 nested metadata values render cleanly. 

Resolves #515 

### Alternatives

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

### Motivation:

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

### Modifications:

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

### Result:

No SwiftPM errors!

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

No code changes were made in this PR.

Fixes: #510

---------

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

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

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

### Modifications:

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

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

### Result:

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

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

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

### Modifications:

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

### Result:

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

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

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

---------

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

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

### Modifications:

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

### Result:

The documentation matches the code. No behaviour change.

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

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

### Modifications:

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

### Result:

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

### Motivation:

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

### Modifications:

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


### Result:

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

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

Swift 6.3 benchmarks have been failing for a while now

### Modifications:

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

### Result:

Benchmarks should not fail sporadically.
2026-08-05 13:35:50 +01:00
88 changed files with 971 additions and 470 deletions

No files matched your search

+53 -63
View File
@@ -10,74 +10,64 @@ on:
- cron: "0 8,20 * * *"
jobs:
unit-tests:
name: Unit tests
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
tests:
name: Tests
uses: swiftlang/github-workflows/.github/workflows/package_test.yml@0.0.18
with:
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_1_enabled: true
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
windows_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
# After https://github.com/swiftlang/github-workflows/pull/362 fix is available, this can be simplified to:
# windows_command: |
# Debug-Test: swift test
# Release-Build: swift build -c release
# windows_version_overrides: |
# default: -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
# nightly-release: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
# nightly-main: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
windows_env_vars: '{"COMMON_SWIFT_FLAGS": "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"}'
windows_command: |
Debug-Test:
command: swift test -Xswiftc -warnings-as-errors %COMMON_SWIFT_FLAGS%
versions: ["current-2", "current-1", "current"]
Release-Build:
command: swift build -c release -Xswiftc -warnings-as-errors %COMMON_SWIFT_FLAGS%
versions: ["current-2", "current-1", "current"]
Debug-Test-Nightly:
command: swift test %COMMON_SWIFT_FLAGS%
versions: ["nightly-release", "nightly-main"]
Release-Build-Nightly:
command: swift build -c release %COMMON_SWIFT_FLAGS%
versions: ["nightly-release", "nightly-main"]
# The Windows runner installs a pinned Swift patch release. The container image tracks the newest patch release.
# Context: https://github.com/swiftlang/github-workflows/issues/356
windows_use_docker: true
# Strict flags for the release toolchains. The nightly toolchains skip -warnings-as-errors.
linux_version_overrides: |
default: -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
nightly-release: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
nightly-main: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
macos_runner_pool: nightly
xcode_scheme: swift-log-Package
xcode_targets: |
macOS:
build: true
test: true
wasm_sdk_versions: '["current", "nightly-main"]'
enable_embedded_wasm_sdk_build: false
enable_macos_swiftly: false
enable_freebsd: false
macos-benchmarks:
name: macOS benchmarks
uses: apple/swift-nio/.github/workflows/macos_benchmarks.yml@main
uses: swiftlang/github-workflows/.github/workflows/benchmarks.yml@0.0.18
with:
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
macos_swift_6_3_enabled: true
enable_linux: false
enable_macos: true
macos_swift_versions: '["current-1", "current"]'
macos_runner_pool: nightly
cxx-interop:
name: Cxx interop
uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
static-linux:
name: Static Linux Swift SDK
# Workaround https://github.com/nektos/act/issues/1875
uses: apple/swift-nio/.github/workflows/static_sdk.yml@main
macos-tests:
name: macOS tests
uses: apple/swift-nio/.github/workflows/macos_tests.yml@main
cmake-build:
name: CMake build
uses: swiftlang/github-workflows/.github/workflows/cmake_build.yml@0.0.18
with:
runner_pool: nightly
build_scheme: swift-log-Package
swift_6_1_enabled: true
swift_6_2_enabled: true
swift_6_3_enabled: true
macos_xcode_test_enabled: true
ios_xcode_test_enabled: true
watchos_xcode_test_enabled: true
tvos_xcode_test_enabled: true
visionos_xcode_test_enabled: true
wasm:
name: Wasm Swift SDK
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
with:
nightly_next_enabled: false
android:
name: Android Swift SDK
# Workaround https://github.com/nektos/act/issues/1875
uses: apple/swift-nio/.github/workflows/android_swift_sdk.yml@main
release-builds:
name: Release builds
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
with:
windows_6_1_enabled: true
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
enable_windows_checks: false
linux_pre_build_command: apt-get update && apt-get install -y ninja-build
+53 -78
View File
@@ -10,93 +10,68 @@ on:
jobs:
soundness:
name: Soundness
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.13
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.18
with:
license_header_check_project_name: "Swift Logging API"
unit-tests:
name: Unit tests
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
tests:
name: Tests
uses: swiftlang/github-workflows/.github/workflows/package_test.yml@0.0.18
with:
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_1_enabled: true
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
windows_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
# After https://github.com/swiftlang/github-workflows/pull/362 fix is available, this can be simplified to:
# windows_command: |
# Debug-Test: swift test
# Release-Build: swift build -c release
# windows_version_overrides: |
# default: -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
# nightly-release: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
# nightly-main: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
windows_env_vars: '{"COMMON_SWIFT_FLAGS": "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"}'
windows_command: |
Debug-Test:
command: swift test -Xswiftc -warnings-as-errors %COMMON_SWIFT_FLAGS%
versions: ["current-2", "current-1", "current"]
Release-Build:
command: swift build -c release -Xswiftc -warnings-as-errors %COMMON_SWIFT_FLAGS%
versions: ["current-2", "current-1", "current"]
Debug-Test-Nightly:
command: swift test %COMMON_SWIFT_FLAGS%
versions: ["nightly-release", "nightly-main"]
Release-Build-Nightly:
command: swift build -c release %COMMON_SWIFT_FLAGS%
versions: ["nightly-release", "nightly-main"]
# The Windows runner installs a pinned Swift patch release. The container image tracks the newest patch release.
# Context: https://github.com/swiftlang/github-workflows/issues/356
windows_use_docker: true
# Strict flags for the release toolchains. The nightly toolchains skip -warnings-as-errors.
linux_version_overrides: |
default: -Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
nightly-release: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
nightly-main: --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable
macos_runner_pool: general
xcode_scheme: swift-log-Package
xcode_targets: |
macOS:
build: true
test: true
wasm_sdk_versions: '["current", "nightly-main"]'
enable_embedded_wasm_sdk_build: false
enable_macos_swiftly: false
enable_freebsd: false
macos-benchmarks:
name: macOS benchmarks
uses: apple/swift-nio/.github/workflows/macos_benchmarks.yml@main
uses: swiftlang/github-workflows/.github/workflows/benchmarks.yml@0.0.18
with:
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
enable_linux: false
enable_macos: true
macos_swift_versions: '["current-1", "current"]'
macos_runner_pool: general
macos_swift_6_3_enabled: true
cxx-interop:
name: Cxx interop
uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
static-linux:
name: Static Linux Swift SDK
# Workaround https://github.com/nektos/act/issues/1875
uses: apple/swift-nio/.github/workflows/static_sdk.yml@main
macos-tests:
name: macOS tests
uses: apple/swift-nio/.github/workflows/macos_tests.yml@main
cmake-build:
name: CMake build
uses: swiftlang/github-workflows/.github/workflows/cmake_build.yml@0.0.18
with:
runner_pool: general
build_scheme: swift-log-Package
swift_test_enabled: true
swift_6_1_enabled: true
swift_6_2_enabled: true
swift_6_3_enabled: true
macos_xcode_test_enabled: true
ios_xcode_test_enabled: true
watchos_xcode_test_enabled: true
tvos_xcode_test_enabled: true
visionos_xcode_test_enabled: true
android:
name: Android Swift SDK
# Workaround https://github.com/nektos/act/issues/1875
uses: apple/swift-nio/.github/workflows/android_swift_sdk.yml@main
release-builds:
name: Release builds
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
with:
windows_6_1_enabled: true
windows_6_2_enabled: true
windows_6_3_enabled: true
windows_nightly_next_enabled: true
windows_nightly_main_enabled: true
wasm:
name: Wasm Swift SDK
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
with:
nightly_next_enabled: false
cmake-lists:
name: Check CMake Lists
uses: apple/swift-nio/.github/workflows/cmake_tests.yml@main
with:
image: "swift:6.1-jammy"
update_cmake_lists_config: >-
{
"targets": [
{ "name": "Logging", "type": "source", "exceptions": [] },
{ "name": "InMemoryLogging", "type": "source", "exceptions": [] }
]
}
enable_windows_checks: false
linux_pre_build_command: apt-get update && apt-get install -y ninja-build
+2 -9
View File
@@ -2,6 +2,7 @@ name: PR label
permissions:
contents: read
pull-requests: read
on:
pull_request:
@@ -10,12 +11,4 @@ on:
jobs:
semver-label-check:
name: Semantic version label check
runs-on: ubuntu-latest
timeout-minutes: 1
steps:
- name: Checkout repository
uses: actions/checkout@v7
with:
persist-credentials: false
- name: Check for Semantic Version label
uses: apple/swift-nio/.github/actions/pull_request_semver_label_checker@main
uses: swiftlang/github-workflows/.github/workflows/pull_request_label.yml@0.0.18
+4 -4
View File
@@ -1,4 +1,4 @@
// swift-tools-version: 6.2
// swift-tools-version: 6.2.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
@@ -19,19 +19,19 @@ let package = Package(
),
// Parent Benchmarks
.package(name: "Benchmarks", path: "../"),
.package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"),
.package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"),
],
targets: [
.executableTarget(
name: "MaxLogLevelNone",
dependencies: [
.product(name: "BenchmarksFactory", package: "Benchmarks"),
.product(name: "Benchmark", package: "package-benchmark"),
.product(name: "Benchmark", package: "benchmark"),
.product(name: "Logging", package: "swift-log"),
],
path: "Benchmarks/MaxLogLevelNoneBenchmarks",
plugins: [
.plugin(name: "BenchmarkPlugin", package: "package-benchmark")
.plugin(name: "BenchmarkPlugin", package: "benchmark")
]
)
]
@@ -0,0 +1,4 @@
{
"instructions" : 6875,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6879,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6895,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6867,
"objectAllocCount" : 0
}
+4 -4
View File
@@ -1,4 +1,4 @@
// swift-tools-version: 6.2
// swift-tools-version: 6.2.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
@@ -19,19 +19,19 @@ let package = Package(
),
// Parent Benchmarks
.package(name: "Benchmarks", path: "../"),
.package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"),
.package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"),
],
targets: [
.executableTarget(
name: "MaxLogLevelWarning",
dependencies: [
.product(name: "BenchmarksFactory", package: "Benchmarks"),
.product(name: "Benchmark", package: "package-benchmark"),
.product(name: "Benchmark", package: "benchmark"),
.product(name: "Logging", package: "swift-log"),
],
path: "Benchmarks/MaxLogLevelWarningBenchmarks",
plugins: [
.plugin(name: "BenchmarkPlugin", package: "package-benchmark")
.plugin(name: "BenchmarkPlugin", package: "benchmark")
]
)
]
@@ -0,0 +1,4 @@
{
"instructions" : 1251327,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1251327,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6847,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6863,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 6871,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1189887,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1189887,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 1993,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 1968,
"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)
}
}
}
+4 -4
View File
@@ -1,4 +1,4 @@
// swift-tools-version:6.2
// swift-tools-version:6.2.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
@@ -18,19 +18,19 @@ let package = Package(
),
// Parent Benchmarks
.package(name: "Benchmarks", path: "../"),
.package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"),
.package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"),
],
targets: [
.executableTarget(
name: "NoTraits",
dependencies: [
.product(name: "BenchmarksFactory", package: "Benchmarks"),
.product(name: "Benchmark", package: "package-benchmark"),
.product(name: "Benchmark", package: "benchmark"),
.product(name: "Logging", package: "swift-log"),
],
path: "Benchmarks/NoTraitsBenchmarks",
plugins: [
.plugin(name: "BenchmarkPlugin", package: "package-benchmark")
.plugin(name: "BenchmarkPlugin", package: "benchmark")
]
)
]
@@ -0,0 +1,4 @@
{
"instructions" : 324863,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 324863,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 320767,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 4751359,
"objectAllocCount" : 1000
}
@@ -0,0 +1,4 @@
{
"instructions" : 5039157355,
"objectAllocCount" : 2016000
}
@@ -0,0 +1,4 @@
{
"instructions" : 81723391,
"objectAllocCount" : 37000
}
@@ -0,0 +1,4 @@
{
"instructions" : 17661951,
"objectAllocCount" : 6000
}
@@ -0,0 +1,4 @@
{
"instructions" : 5644287,
"objectAllocCount" : 2000
}
@@ -0,0 +1,4 @@
{
"instructions" : 7065599,
"objectAllocCount" : 3000
}
@@ -0,0 +1,4 @@
{
"instructions" : 272895,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 284927,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1249279,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 3273000,
"objectAllocCount" : 1000
}
@@ -0,0 +1,4 @@
{
"instructions" : 9117695,
"objectAllocCount" : 4000
}
@@ -0,0 +1,4 @@
{
"instructions" : 324863,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 324863,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 323071,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 4415487,
"objectAllocCount" : 1000
}
@@ -0,0 +1,4 @@
{
"instructions" : 4322989256,
"objectAllocCount" : 2016000
}
@@ -0,0 +1,4 @@
{
"instructions" : 68354047,
"objectAllocCount" : 37000
}
@@ -0,0 +1,4 @@
{
"instructions" : 14581759,
"objectAllocCount" : 6000
}
@@ -0,0 +1,4 @@
{
"instructions" : 5795839,
"objectAllocCount" : 2000
}
@@ -0,0 +1,4 @@
{
"instructions" : 7192575,
"objectAllocCount" : 3000
}
@@ -0,0 +1,4 @@
{
"instructions" : 301055,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 243967,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 1189887,
"objectAllocCount" : 0
}
@@ -0,0 +1,4 @@
{
"instructions" : 2841000,
"objectAllocCount" : 1000
}
@@ -0,0 +1,4 @@
{
"instructions" : 8929279,
"objectAllocCount" : 4000
}
@@ -1,4 +0,0 @@
{
"instructions" : 1050,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 1050,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 1046,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 5935,
"objectAllocCount" : 2
}
@@ -1,4 +0,0 @@
{
"instructions" : 7151,
"objectAllocCount" : 3
}
@@ -1,4 +0,0 @@
{
"instructions" : 1005,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 1017,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 1966,
"objectAllocCount" : 0
}
@@ -1,4 +0,0 @@
{
"instructions" : 4551,
"objectAllocCount" : 1
}
@@ -1,4 +0,0 @@
{
"instructions" : 9623,
"objectAllocCount" : 4
}
+3 -3
View File
@@ -1,4 +1,4 @@
// swift-tools-version:6.2
// swift-tools-version:6.2.3
// The swift-tools-version declares the minimum version of Swift required to build this package.
import PackageDescription
@@ -12,14 +12,14 @@ let package = Package(
.library(name: "BenchmarksFactory", targets: ["BenchmarksFactory"])
],
dependencies: [
.package(url: "https://github.com/ordo-one/package-benchmark.git", from: "1.29.6"),
.package(url: "https://github.com/ordo-one/benchmark.git", from: "1.29.6"),
.package(path: "../"), // swift-log
],
targets: [
.target(
name: "BenchmarksFactory",
dependencies: [
.product(name: "Benchmark", package: "package-benchmark"),
.product(name: "Benchmark", package: "benchmark"),
.product(name: "Logging", package: "swift-log"),
]
)
@@ -36,6 +36,7 @@ public func makeBenchmark(
"\(logLevel)_log_with_\(loggerLevel)_log_level\(suffix)",
configuration: .init(
metrics: metrics,
scalingFactor: .kilo,
maxIterations: iterations,
thresholds: [
.instructions: BenchmarkThresholds(
@@ -54,12 +55,16 @@ public func makeBenchmark(
if setScopedLogger {
withLogger(logger) { logger in
benchmark.startMeasurement()
body(logger)
for _ in benchmark.scaledIterations {
body(logger)
}
benchmark.stopMeasurement()
}
} else {
benchmark.startMeasurement()
body(logger)
for _ in benchmark.scaledIterations {
body(logger)
}
benchmark.stopMeasurement()
}
}
+2 -2
View File
@@ -33,8 +33,8 @@ option(BUILD_SHARED_LIBS "Build shared libraries by default" YES)
set(CMAKE_Swift_LANGUAGE_VERSION 6)
if(CMAKE_Swift_COMPILER_VERSION VERSION_LESS "6.1")
message(FATAL_ERROR "swift-log requires Swift compiler version 6.1 or newer. Detected version: ${CMAKE_Swift_COMPILER_VERSION}")
if(CMAKE_Swift_COMPILER_VERSION VERSION_LESS "6.2.3")
message(FATAL_ERROR "swift-log requires Swift compiler version 6.2.3 or newer. Detected version: ${CMAKE_Swift_COMPILER_VERSION}")
endif()
set(SWIFT_LOG_COMMON_COMPILE_OPTIONS
+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
+3 -5
View File
@@ -1,4 +1,4 @@
// swift-tools-version:6.2
// swift-tools-version:6.2.3
import PackageDescription
@@ -39,13 +39,11 @@ let package = Package(
),
.testTarget(
name: "LoggingTests",
dependencies: ["Logging"],
exclude: ["CMakeLists.txt"]
dependencies: ["Logging"]
),
.testTarget(
name: "InMemoryLoggingTests",
dependencies: ["InMemoryLogging", "Logging"],
exclude: ["CMakeLists.txt"]
dependencies: ["InMemoryLogging", "Logging"]
),
]
)
-70
View File
@@ -1,70 +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: [],
exclude: ["CMakeLists.txt"]
),
.target(
name: "InMemoryLogging",
dependencies: ["Logging"],
exclude: ["CMakeLists.txt"]
),
.testTarget(
name: "LoggingTests",
dependencies: ["Logging"],
exclude: ["CMakeLists.txt"]
),
.testTarget(
name: "InMemoryLoggingTests",
dependencies: ["InMemoryLogging", "Logging"],
exclude: ["CMakeLists.txt"]
),
]
)
for target in package.targets
where [.executable, .test, .regular].contains(
target.type
) {
var settings = target.swiftSettings ?? []
// https://github.com/apple/swift-evolution/blob/main/proposals/0335-existential-any.md
// Require `any` for existential types.
settings.append(.enableUpcomingFeature("ExistentialAny"))
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0444-member-import-visibility.md
settings.append(.enableUpcomingFeature("MemberImportVisibility"))
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0409-access-level-on-imports.md
settings.append(.enableUpcomingFeature("InternalImportsByDefault"))
target.swiftSettings = settings
}
+6 -1
View File
@@ -22,7 +22,7 @@ choose from the many
The following snippet shows how to add SwiftLog to your Swift Package:
```swift
// swift-tools-version: 6.1
// swift-tools-version: 6.2.3
import PackageDescription
let package = Package(
@@ -67,3 +67,8 @@ The community has built numerous specialized logging backends.
A great way to discover available log backend implementations is searching the
[Swift Package Index](https://swiftpackageindex.com/search?query=swift-log)
for the `swift-log` keyword.
## Building with CMake
While Swift Package Manager (SPM) is the primary build system for development and testing, CMake build support is also available for integrated or mixed build environments if needed. Note that tests are not included in the CMake build, they are managed through Swift Package Manager with `swift test`.
@@ -287,7 +287,7 @@ public struct PrintLogHandler: LogHandler {
base: Logger.Metadata,
provider: Logger.MetadataProvider?,
explicit: Logger.Metadata?
) -> Logger.Metadata? {
) -> Logger.Metadata {
var metadata = base
let provided = provider?.get() ?? [:]
@@ -25,3 +25,8 @@
- ``logLevel``
- ``metadata``
- ``metadataProvider``
### Configuring the timestamp
- ``timestampPrecision``
- ``TimestampPrecision``
@@ -105,6 +105,9 @@ public struct MultiplexLogHandler: LogHandler {
}
/// The metadata provider.
///
/// Setting this property sets the provider on all underlying handlers and replaces
/// the provider passed to ``init(_:metadataProvider:)``.
public var metadataProvider: Logger.MetadataProvider? {
get {
if self.handlers.count == 1 {
@@ -138,15 +141,32 @@ public struct MultiplexLogHandler: LogHandler {
}
}
set {
// Also replace this handler's own provider, otherwise the provider passed to the
// initializer keeps overriding the new one, and setting `nil` would not remove it.
self._metadataProvider = newValue
self.mutatingForEachHandler { $0.metadataProvider = newValue }
}
}
/// Log a message using the log level and source that you provide.
///
/// Metadata from this handler's metadata provider overrides metadata from
/// the underlying handlers and their providers. Explicit metadata in the
/// log event takes precedence over this handler's provider.
///
/// - parameters:
/// - event: The log event containing the level, message, metadata, and source location.
public func log(event: LogEvent) {
var event = event
if let provider = self._metadataProvider {
var metadata = provider.get()
if let explicit = event.metadata {
metadata.merge(explicit, uniquingKeysWith: { _, explicit in explicit })
}
if !metadata.isEmpty {
event.metadata = metadata
}
}
for handler in self.handlers where handler.logLevel <= event.level {
handler.log(event: event)
}
@@ -176,6 +196,10 @@ public struct MultiplexLogHandler: LogHandler {
}
/// Get or set the entire metadata storage as a dictionary.
///
/// The getter merges the metadata of the underlying handlers in initialization order.
/// On a key conflict, the first handler's value wins, as in ``subscript(metadataKey:)``.
/// The dictionary does not contain values from metadata providers.
public var metadata: Logger.Metadata {
get {
var effective: Logger.Metadata = [:]
@@ -185,14 +209,9 @@ public struct MultiplexLogHandler: LogHandler {
// !-safe, we always have at least one handler
effective.reserveCapacity(self.handlers.first!.metadata.count)
// Keep the existing value on a conflict, so the first handler wins.
for handler in self.handlers {
effective.merge(handler.metadata, uniquingKeysWith: { _, handlerMetadata in handlerMetadata })
if let provider = handler.metadataProvider {
effective.merge(provider.get(), uniquingKeysWith: { _, provided in provided })
}
}
if let provider = self._metadataProvider {
effective.merge(provider.get(), uniquingKeysWith: { _, provided in provided })
effective.merge(handler.metadata, uniquingKeysWith: { current, _ in current })
}
return effective
+91 -13
View File
@@ -80,6 +80,19 @@ public struct StreamLogHandler: LogHandler {
/// The metadata provider.
public var metadataProvider: Logger.MetadataProvider?
/// The precision of the timestamp written at the start of each log line.
///
/// Defaults to ``TimestampPrecision/seconds``, which keeps the output format
/// that `StreamLogHandler` has always used, for example `2025-06-01T14:03:07+0000`.
/// Some tools parse this output, so the extra precision is opt-in rather than the default.
///
/// Set it to ``TimestampPrecision/milliseconds`` to include milliseconds,
/// for example `2025-06-01T14:03:07.042+0000`.
///
/// > Note: On WASI the wall clock is only read with second precision, so
/// > ``TimestampPrecision/milliseconds`` always prints `.000` there.
public var timestampPrecision: TimestampPrecision = .seconds
private var prettyMetadata: String?
/// Get or set the entire metadata storage as a dictionary.
public var metadata = Logger.Metadata() {
@@ -144,7 +157,7 @@ public struct StreamLogHandler: LogHandler {
var stream = self.stream
stream.write(
"\(self.timestamp()) \(event.level)\(self.label.isEmpty ? "" : " ")\(self.label):\(prettyMetadata.map { " \($0)" } ?? "") [\(event.source)] \(event.message)\n"
"\(self.timestamp(precision: self.timestampPrecision)) \(event.level)\(self.label.isEmpty ? "" : " ")\(self.label):\(prettyMetadata.map { " \($0)" } ?? "") [\(event.source)] \(event.message)\n"
)
}
@@ -210,28 +223,83 @@ public struct StreamLogHandler: LogHandler {
}
}
private func timestamp() -> String {
private func timestamp(precision: TimestampPrecision) -> String {
var buffer = [Int8](repeating: 0, count: 255)
var tzBuffer = [Int8](repeating: 0, count: 16)
let milliseconds: Int
#if os(Windows)
var timestamp = __time64_t()
_ = _time64(&timestamp)
// _ftime64_s gives wall-clock time with millisecond resolution.
var timeBuffer = __timeb64()
_ = _ftime64_s(&timeBuffer)
var localTime = tm()
_ = _localtime64_s(&localTime, &timestamp)
_ = strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S%z", &localTime)
#else
_ = _localtime64_s(&localTime, &timeBuffer.time)
_ = strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S", &localTime)
_ = strftime(&tzBuffer, tzBuffer.count, "%z", &localTime)
milliseconds = Int(timeBuffer.millitm)
#elseif canImport(WASILibc)
// CLOCK_REALTIME isn't importable on WASI (it's a pointer-to-struct macro),
// so fall back to time(nil), which only has second resolution.
var timestamp = time(nil)
guard let localTime = localtime(&timestamp) else {
return "<unknown>"
}
strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S%z", localTime)
strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S", localTime)
strftime(&tzBuffer, tzBuffer.count, "%z", localTime)
milliseconds = 0
#else
var timeSpec = timespec()
clock_gettime(CLOCK_REALTIME, &timeSpec)
guard let localTime = localtime(&timeSpec.tv_sec) else {
return "<unknown>"
}
strftime(&buffer, buffer.count, "%Y-%m-%dT%H:%M:%S", localTime)
strftime(&tzBuffer, tzBuffer.count, "%z", localTime)
milliseconds = Int(timeSpec.tv_nsec) / 1_000_000
#endif
return buffer.withUnsafeBufferPointer {
let dateTime = buffer.withUnsafeBufferPointer {
$0.withMemoryRebound(to: CChar.self) {
String(cString: $0.baseAddress!)
}
}
let timeZone = tzBuffer.withUnsafeBufferPointer {
$0.withMemoryRebound(to: CChar.self) {
String(cString: $0.baseAddress!)
}
}
switch precision {
case .seconds:
return "\(dateTime)\(timeZone)"
case .milliseconds:
return "\(dateTime).\(Self.zeroPadded(milliseconds))\(timeZone)"
}
}
/// Pads a millisecond value to three digits without pulling in Foundation.
internal static func zeroPadded(_ milliseconds: Int) -> String {
if milliseconds < 10 {
return "00\(milliseconds)"
} else if milliseconds < 100 {
return "0\(milliseconds)"
} else {
return "\(milliseconds)"
}
}
}
extension StreamLogHandler {
/// The precision of the timestamp that a ``StreamLogHandler`` writes at the start of each log line.
@nonexhaustive
public enum TimestampPrecision: Sendable, Hashable {
/// Whole seconds, for example `2025-06-01T14:03:07+0000`.
///
/// This is the default, and matches the format `StreamLogHandler` has always produced.
case seconds
/// Milliseconds, for example `2025-06-01T14:03:07.042+0000`.
///
/// > Note: On WASI the wall clock only has second resolution, so the
/// > millisecond field is always `.000`.
case milliseconds
}
}
@@ -345,8 +413,13 @@ internal struct StdioOutputStream: TextOutputStream, @unchecked Sendable {
)
#elseif canImport(WASILibc)
// no file locking on WASI
#if compiler(>=6.5)
let file = WASILibc.stderr
#else
let file = WASILibc.stderr!
#endif
return StdioOutputStream(
file: WASILibc.stderr!,
file: file,
flushMode: .always,
lock: nil,
unlock: nil,
@@ -417,8 +490,13 @@ internal struct StdioOutputStream: TextOutputStream, @unchecked Sendable {
)
#elseif canImport(WASILibc)
// no file locking on WASI
#if compiler(>=6.5)
let file = WASILibc.stdout
#else
let file = WASILibc.stdout!
#endif
return StdioOutputStream(
file: WASILibc.stdout!,
file: file,
flushMode: .always,
lock: nil,
unlock: nil,
+10 -10
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
@@ -199,7 +199,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
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:_:)-3eduo`` or
/// ``withLogger(logLevel:handler:metadata:_:)-5nmw6``
/// ``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:_:)-5nmw6``
/// 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:_:)`` 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:_:)-3eduo``, 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
+41 -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.
@@ -1387,7 +1395,18 @@ extension Logger {
@inlinable
internal static func currentModule(fileID: String = #fileID) -> String {
let utf8All = fileID.utf8
if let slashIndex = utf8All.firstIndex(of: UInt8(ascii: "/")) {
let searchStart: String.UTF8View.Index
if utf8All.first == UInt8(ascii: "`") {
guard let closingBacktickIndex = utf8All.dropFirst().firstIndex(of: UInt8(ascii: "`")) else {
// It should be impossible for a well-formed module to get here, so treat it as an "n/a" case.
return "n/a"
}
// Backticks are part of raw-identifier module names as written in source and mangled, so preserve them.
searchStart = utf8All.index(after: closingBacktickIndex)
} else {
searchStart = utf8All.startIndex
}
if let slashIndex = utf8All[searchStart...].firstIndex(of: UInt8(ascii: "/")) {
return String(fileID[..<slashIndex])
} else {
return "n/a"
@@ -1414,14 +1433,29 @@ extension Logger.MetadataValue: CustomStringConvertible {
/// A string representation of the metadata value.
public var description: String {
switch self {
case .dictionary(let dict):
return dict.mapValues { $0.description }.description
case .array(let list):
return list.map { $0.description }.description
case .string(let str):
return str
case .stringConvertible(let repr):
return repr.description
case .array(let list):
let items = list.map { $0.quotedAsCollectionElement }
return "[\(items.joined(separator: ", "))]"
case .dictionary(let dict):
guard !dict.isEmpty else { return "[:]" }
let entries = dict.map { key, value in "\(key.debugDescription): \(value.quotedAsCollectionElement)" }
return "[\(entries.joined(separator: ", "))]"
}
}
/// Only qute the leaf
private var quotedAsCollectionElement: String {
switch self {
case .string(let str):
return str.debugDescription
case .stringConvertible(let repr):
return repr.description.debugDescription
case .array, .dictionary:
return self.description
}
}
}
@@ -1472,7 +1506,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 +1517,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>(
@@ -0,0 +1,96 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Logging API open source project
//
// Copyright (c) 2026 Apple Inc. and the Swift Logging API project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import InMemoryLogging
import Logging
import Testing
struct MultiplexProviderRegressionTests {
@Test(arguments: [1, 2])
func constructorProviderReachesEverySink(handlerCount: Int) {
let sinks = (0..<handlerCount).map { _ in InMemoryLogHandler() }
let handler = MultiplexLogHandler(sinks, metadataProvider: .init { ["trace-id": "123"] })
let logger = Logger(label: "test", factory: { _ in handler })
#expect(logger.metadataProvider?.get()["trace-id"] == "123")
logger.info("hello")
for sink in sinks {
#expect(sink.entries.count == 1)
#expect(sink.entries.first?.metadata["trace-id"] == "123")
}
}
@Test func constructorProviderLayersBetweenChildAndExplicitMetadata() {
var sink = InMemoryLogHandler()
sink.metadataProvider = .init { ["child": "kept", "shared": "child"] }
let handler = MultiplexLogHandler(
[sink],
metadataProvider: .init {
["outer": "kept", "shared": "outer"]
}
)
let logger = Logger(label: "test", factory: { _ in handler })
logger.info("provided")
logger.info("explicit", metadata: ["shared": "explicit"])
#expect(sink.entries.first?.metadata == ["child": "kept", "outer": "kept", "shared": "outer"])
#expect(sink.entries.last?.metadata == ["child": "kept", "outer": "kept", "shared": "explicit"])
}
@Test(arguments: [1, 2])
func settingProviderReplacesConstructorProvider(handlerCount: Int) {
let sinks = (0..<handlerCount).map { _ in InMemoryLogHandler() }
let handler = MultiplexLogHandler(sinks, metadataProvider: .init { ["trace-id": "constructor"] })
var logger = Logger(label: "test", factory: { _ in handler })
logger.handler.metadataProvider = .init { ["trace-id": "replaced"] }
#expect(logger.metadataProvider?.get() == ["trace-id": "replaced"])
logger.info("replaced")
logger.handler.metadataProvider = nil
#expect(logger.metadataProvider == nil)
logger.info("cleared")
for sink in sinks {
#expect(sink.entries.map(\.metadata) == [["trace-id": "replaced"], [:]])
}
}
@Test func settingProviderReachesHandlersWithoutProviderSupport() {
let sink = InMemoryLogHandler()
var handler = MultiplexLogHandler(
[HandlerWithoutProviderSupport(sink: sink)],
metadataProvider: .init { ["trace-id": "constructor"] }
)
handler.metadataProvider = .init { ["trace-id": "replaced"] }
let logger = Logger(label: "test", factory: { _ in handler })
logger.info("hello")
// Debug builds may also record a one-time warning about the unsupported provider.
#expect(sink.entries.filter { $0.message == "hello" }.map(\.metadata) == [["trace-id": "replaced"]])
}
}
/// Uses the default `metadataProvider` implementation, so it ignores providers set on it.
private struct HandlerWithoutProviderSupport: LogHandler {
let sink: InMemoryLogHandler
var metadata: Logger.Metadata = [:]
var logLevel: Logger.Level = .info
subscript(metadataKey key: String) -> Logger.Metadata.Value? {
get { self.metadata[key] }
set { self.metadata[key] = newValue }
}
func log(event: LogEvent) {
self.sink.log(event: event)
}
}
@@ -66,6 +66,79 @@ struct CompatibilityTest {
testLogging.history.assertExist(level: .error, message: "yes: error", source: "yes: error source")
testLogging.history.assertExist(level: .critical, message: "yes: critical", source: "yes: critical source")
}
/// A handler implementing only `log(event:)` must survive a caller on the SwiftLog 1.0
/// entry point. Both deprecated defaults used to forward to each other.
@available(*, deprecated, message: "Testing deprecated functionality")
@Test func swiftLog1CompatibilityMethodReachesAnEventOnlyHandler() {
let handler = EventOnlyLogHandler()
handler.log(
level: .warning,
message: "compat",
metadata: ["k": "v"],
file: "/Sources/CompatModule/Caller.swift",
function: #function,
line: 42
)
let events = handler.recorded
#expect(events.count == 1)
#expect(events.first?.level == .warning)
#expect(events.first?.message == "compat")
#expect(events.first?.metadata == ["k": "v"])
#expect(events.first?.source == "CompatModule")
#expect(events.first?.line == 42)
}
/// The same entry point must still reach a handler implementing only the
/// source-carrying deprecated method.
@available(*, deprecated, message: "Testing deprecated functionality")
@Test func swiftLog1CompatibilityMethodReachesASourceOnlyHandler() {
let testLogging = NewerButStillOldTestLogging()
let handler = testLogging.make(label: "compat")
handler.log(
level: .error,
message: "compat",
metadata: nil,
file: "/Sources/CompatModule/Caller.swift",
function: #function,
line: 42
)
testLogging.history.assertExist(level: .error, message: "compat", source: "CompatModule")
}
}
/// Implements `log(event:)` and nothing else.
private struct EventOnlyLogHandler: LogHandler {
private final class Store: @unchecked Sendable {
private let lock = Lock()
private var events: [LogEvent] = []
func append(_ event: LogEvent) {
self.lock.withLock { self.events.append(event) }
}
var all: [LogEvent] {
self.lock.withLock { self.events }
}
}
private let store = Store()
var metadata: Logger.Metadata = [:]
var logLevel: Logger.Level = .trace
subscript(metadataKey metadataKey: String) -> Logger.Metadata.Value? {
get { self.metadata[metadataKey] }
set { self.metadata[metadataKey] = newValue }
}
func log(event: LogEvent) {
self.store.append(event)
}
var recorded: [LogEvent] { self.store.all }
}
private struct OldSchoolTestLogging {
+40 -12
View File
@@ -278,7 +278,8 @@ struct LoggingTest {
multiplexLogger.handler.metadata == [
"one": "111",
"two": "222",
"in": "in-2",
// First handler wins on conflicting keys (see issue #498):
"in": "in-1",
]
)
}
@@ -315,21 +316,17 @@ struct LoggingTest {
}
)
// The subscript and `metadata` agree on conflicting keys.
#expect(multiplexLogger[metadataKey: "one"] == "111")
#expect(multiplexLogger[metadataKey: "two"] == "222")
#expect(multiplexLogger[metadataKey: "in"] == "in-1")
// Provider values are not part of `metadata`.
#expect(
multiplexLogger.handler.metadata == [
"one": "111",
"two": "222",
"in": "in-2",
"provider-1": "provided-111",
"provider-2": "provided-222",
"provider-overlap": "provided-222",
]
)
#expect(
multiplexLogger.handler.metadataProvider?.get() == [
"provider-1": "provided-111",
"provider-2": "provided-222",
"provider-overlap": "provided-222",
"in": "in-1",
]
)
}
@@ -1143,6 +1140,37 @@ struct LoggingTest {
#expect(.error == logger1.logLevel)
#expect(.trace == logger2.logLevel)
}
@Test func loggerMetadataWriteMutatesHandlerInPlace() {
var logger1 = Logger(label: "foo", factory: { _ in CopyCountingLogHandler() })
for i in 0..<10 {
logger1[metadataKey: "key\(i)"] = "\(i)"
}
#expect(logger1.handlerCopies == 0)
// The first write to a copy copies the handler once, later writes reuse that copy.
var logger2 = logger1
for i in 0..<10 {
logger2[metadataKey: "key\(i)"] = "changed"
}
#expect(logger2.handlerCopies == 1)
#expect(logger1.handlerCopies == 0)
#expect(logger1[metadataKey: "key0"] == "0")
}
@Test func currentModuleFileIDParsing() {
#expect(Logger.currentModule(fileID: "MyModule/MyFile.swift") == "MyModule")
#expect(Logger.currentModule(fileID: "MyModule/Subdir/MyFile.swift") == "MyModule")
#expect(Logger.currentModule(fileID: "`My.Module`/MyFile.swift") == "`My.Module`")
#expect(Logger.currentModule(fileID: "`My/Module`/MyFile.swift") == "`My/Module`")
#expect(Logger.currentModule(fileID: "`/a/b/c`/MyFile.swift") == "`/a/b/c`")
#expect(Logger.currentModule(fileID: "`/a/b/c`/Subdir/MyFile.swift") == "`/a/b/c`")
#expect(Logger.currentModule(fileID: "`Module With Spaces`/MyFile.swift") == "`Module With Spaces`")
#expect(Logger.currentModule(fileID: "`Unclosed/MyFile.swift") == "n/a")
#expect(Logger.currentModule(fileID: "`NoSlash`") == "n/a")
#expect(Logger.currentModule(fileID: "NoSlash.swift") == "n/a")
#expect(Logger.currentModule(fileID: "") == "n/a")
}
}
extension Logger {
@@ -0,0 +1,63 @@
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Logging API open source project
//
// Copyright (c) 2026 Apple Inc. and the Swift Logging API project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import Logging
import Testing
@Suite
struct MetadataValueTest {
@Test
func descriptionRendering() {
#expect(Logger.MetadataValue.array([]).description == "[]")
#expect(Logger.MetadataValue.array(["a", "b"]).description == ["a", "b"].description)
#expect(Logger.MetadataValue.dictionary([:]).description == "[:]")
#expect(Logger.MetadataValue.dictionary(["k": "v"]).description == ["k": "v"].description)
#expect(
Logger.MetadataValue.dictionary(["outer": ["inner": "leaf"]]).description
== "[\"outer\": [\"inner\": \"leaf\"]]"
)
}
@Test
func equatableCompareson() {
let lhs: Logger.MetadataValue = ["a": ["1", "2"]]
let rhs: Logger.MetadataValue = ["a": ["1", "2"]]
let different: Logger.MetadataValue = ["a": ["1", "3"]]
#expect(lhs == rhs)
#expect(lhs != different)
}
@Test
func descriptionOfNestedArraysGrowsLinearlyNotExponentially() {
var value: Logger.MetadataValue = .string("leaf")
for _ in 0..<100 {
value = .array([value])
}
// "leaf".debugDescription + each level adds a "[" and "]".
#expect(value.description.count == 6 + 2 * 100)
}
@Test
func equatableComparesNestedArrays() {
var lhs: Logger.MetadataValue = .string("leaf")
var rhs: Logger.MetadataValue = .string("leaf")
for _ in 0..<100 {
lhs = .array([lhs])
rhs = .array([rhs])
}
#expect(lhs == rhs)
}
}
@@ -85,6 +85,45 @@ struct StreamLogHandlerTest {
#expect(interceptStream.strings.count == 1)
}
@Test func streamLogHandlerTimestampPrecisionDefaultsToSeconds() {
let handler = StreamLogHandler(label: "testLabel", stream: InterceptStream())
#expect(handler.timestampPrecision == .seconds)
}
@Test func streamLogHandlerOutputFormatWithMillisecondPrecision() {
let interceptStream = InterceptStream()
let label = "testLabel"
let source = "testSource"
let log = Logger(
label: label,
factory: {
var handler = StreamLogHandler(label: $0, stream: interceptStream)
handler.timestampPrecision = .milliseconds
return handler
}
)
let testString = "my message is better than yours"
log.critical("\(testString)", source: source)
let pattern =
"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}(\\+|-)\\d{4}\\s\(Logger.Level.critical)\\s\(label):\\s\\[\(source)\\]\\s\(testString)$"
let messageSucceeded =
interceptStream.interceptedText?.trimmingCharacters(in: .whitespacesAndNewlines).range(
of: pattern,
options: .regularExpression
) != nil
#expect(messageSucceeded)
#expect(interceptStream.strings.count == 1)
}
@Test(arguments: [(0, "000"), (7, "007"), (42, "042"), (999, "999")])
func streamLogHandlerMillisecondsAreZeroPadded(milliseconds: Int, expected: String) {
#expect(StreamLogHandler.zeroPadded(milliseconds) == expected)
}
@Test func streamLogHandlerOutputFormatWithEmptyLabel() {
let interceptStream = InterceptStream()
let source = "testSource"
@@ -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 {}