mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
82cf87d893 | ||
|
|
47655e0c23 | ||
|
|
d05c8efdae | ||
|
|
c7413d967b | ||
|
|
34b131f794 | ||
|
|
e3da040787 | ||
|
|
209524e4da | ||
|
|
c44b210eee | ||
|
|
d0f784af9e | ||
|
|
c9c6bb9d27 | ||
|
|
6404842475 | ||
|
|
fcd893317d | ||
|
|
65b3417512 | ||
|
|
666b45a252 | ||
|
|
4038b6a4f7 | ||
|
|
109c380c23 | ||
|
|
c29472f010 | ||
|
|
bca880e799 | ||
|
|
c581740960 | ||
|
|
9c9acde6dc | ||
|
|
cf3e828428 | ||
|
|
3be27be290 |
No files matched your search
+53
-63
@@ -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: false
|
||||
watchos_xcode_test_enabled: false
|
||||
tvos_xcode_test_enabled: false
|
||||
visionos_xcode_test_enabled: false
|
||||
|
||||
wasm:
|
||||
name: Wasm Swift SDK
|
||||
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
|
||||
with:
|
||||
nightly_next_enabled: false
|
||||
|
||||
android:
|
||||
name: Android Swift SDK
|
||||
# Workaround https://github.com/nektos/act/issues/1875
|
||||
uses: apple/swift-nio/.github/workflows/android_swift_sdk.yml@main
|
||||
|
||||
release-builds:
|
||||
name: Release builds
|
||||
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
|
||||
with:
|
||||
windows_6_1_enabled: true
|
||||
windows_6_2_enabled: true
|
||||
windows_6_3_enabled: true
|
||||
windows_nightly_next_enabled: true
|
||||
windows_nightly_main_enabled: true
|
||||
enable_windows_checks: false
|
||||
linux_pre_build_command: apt-get update && apt-get install -y ninja-build
|
||||
@@ -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: false
|
||||
watchos_xcode_test_enabled: false
|
||||
tvos_xcode_test_enabled: false
|
||||
visionos_xcode_test_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
|
||||
|
||||
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,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
|
||||
@@ -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")
|
||||
]
|
||||
)
|
||||
]
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"instructions" : 6771,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"instructions" : 6767,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"instructions" : 6775,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 759,
|
||||
"instructions" : 6771,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 6875,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 6879,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 6895,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 6867,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
@@ -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")
|
||||
]
|
||||
)
|
||||
]
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"instructions" : 6775,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"instructions" : 6747,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"instructions" : 6775,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1993,
|
||||
"instructions" : 1251327,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1968,
|
||||
"instructions" : 1251327,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 6847,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 6863,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 6871,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1189887,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1189887,
|
||||
"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)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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")
|
||||
]
|
||||
)
|
||||
]
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1050,
|
||||
"instructions" : 324863,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1050,
|
||||
"instructions" : 324863,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1046,
|
||||
"instructions" : 320767,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 4751359,
|
||||
"objectAllocCount" : 1000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 5039157355,
|
||||
"objectAllocCount" : 2016000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 81723391,
|
||||
"objectAllocCount" : 37000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 17661951,
|
||||
"objectAllocCount" : 6000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 5644287,
|
||||
"objectAllocCount" : 2000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 7065599,
|
||||
"objectAllocCount" : 3000
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1005,
|
||||
"instructions" : 272895,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1017,
|
||||
"instructions" : 284927,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1966,
|
||||
"instructions" : 1249279,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 3273000,
|
||||
"objectAllocCount" : 1000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 9117695,
|
||||
"objectAllocCount" : 4000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 324863,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 324863,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 323071,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 4415487,
|
||||
"objectAllocCount" : 1000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 4322989256,
|
||||
"objectAllocCount" : 2016000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 68354047,
|
||||
"objectAllocCount" : 37000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 14581759,
|
||||
"objectAllocCount" : 6000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 5795839,
|
||||
"objectAllocCount" : 2000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 7192575,
|
||||
"objectAllocCount" : 3000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 301055,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 243967,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1189887,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 2841000,
|
||||
"objectAllocCount" : 1000
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 8929279,
|
||||
"objectAllocCount" : 4000
|
||||
}
|
||||
-4
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"instructions" : 6200,
|
||||
"objectAllocCount" : 2
|
||||
}
|
||||
-4
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"instructions" : 7600,
|
||||
"objectAllocCount" : 3
|
||||
}
|
||||
-4
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"instructions" : 4551,
|
||||
"objectAllocCount" : 1
|
||||
}
|
||||
-4
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"instructions" : 9623,
|
||||
"objectAllocCount" : 4
|
||||
}
|
||||
@@ -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
@@ -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
@@ -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
@@ -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"]
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
@@ -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
|
||||
}
|
||||
@@ -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(
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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(×tamp)
|
||||
|
||||
// _ftime64_s gives wall-clock time with millisecond resolution.
|
||||
var timeBuffer = __timeb64()
|
||||
_ = _ftime64_s(&timeBuffer)
|
||||
var localTime = tm()
|
||||
_ = _localtime64_s(&localTime, ×tamp)
|
||||
|
||||
_ = 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(×tamp) 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
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+10
-10
@@ -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
|
||||
|
||||
@@ -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
|
||||
@@ -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)
|
||||
}
|
||||
}
|
||||
@@ -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) })
|
||||
|
||||
@@ -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 {}
|
||||
Reference in new issue
Block a user