mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c9c6bb9d27 | ||
|
|
6404842475 | ||
|
|
fcd893317d | ||
|
|
65b3417512 | ||
|
|
666b45a252 | ||
|
|
4038b6a4f7 | ||
|
|
109c380c23 | ||
|
|
c29472f010 | ||
|
|
bca880e799 | ||
|
|
c581740960 | ||
|
|
9c9acde6dc | ||
|
|
cf3e828428 | ||
|
|
3be27be290 | ||
|
|
9c6fb14227 | ||
|
|
53d00853e6 | ||
|
|
c5ece24786 | ||
|
|
172948a4b5 | ||
|
|
47a917767f | ||
|
|
f054da4c19 | ||
|
|
3ffafb9722 | ||
|
|
7af2de138f | ||
|
|
e83726cb15 | ||
|
|
8056dbfb08 | ||
|
|
1032aed8a5 | ||
|
|
1895d78a91 | ||
|
|
8a6b9eab84 | ||
|
|
c4e96785bf | ||
|
|
54ec9e35cd | ||
|
|
e3b5d65fc9 |
No files matched your search
@@ -14,19 +14,21 @@ jobs:
|
||||
name: Unit tests
|
||||
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
|
||||
with:
|
||||
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_6_1_enabled: false
|
||||
linux_6_4_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_6_1_enabled: true
|
||||
windows_6_1_enabled: false
|
||||
windows_6_2_enabled: true
|
||||
windows_6_3_enabled: true
|
||||
windows_6_4_enabled: true
|
||||
windows_nightly_next_enabled: true
|
||||
windows_nightly_main_enabled: true
|
||||
windows_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_6_4_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
|
||||
@@ -36,6 +38,7 @@ jobs:
|
||||
with:
|
||||
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
|
||||
macos_swift_6_3_enabled: true
|
||||
macos_swift_6_4_enabled: true
|
||||
|
||||
cxx-interop:
|
||||
name: Cxx interop
|
||||
@@ -52,8 +55,11 @@ jobs:
|
||||
with:
|
||||
runner_pool: nightly
|
||||
build_scheme: swift-log-Package
|
||||
debug_output_enabled: true
|
||||
macos_xcode_test_enabled: false
|
||||
swift_6_1_enabled: false
|
||||
swift_6_2_enabled: true
|
||||
swift_6_3_enabled: true
|
||||
swift_6_4_enabled: true
|
||||
macos_xcode_test_enabled: true
|
||||
ios_xcode_test_enabled: false
|
||||
watchos_xcode_test_enabled: false
|
||||
tvos_xcode_test_enabled: false
|
||||
@@ -74,8 +80,9 @@ jobs:
|
||||
name: Release builds
|
||||
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
|
||||
with:
|
||||
windows_6_1_enabled: true
|
||||
windows_6_1_enabled: false
|
||||
windows_6_2_enabled: true
|
||||
windows_6_3_enabled: true
|
||||
windows_6_4_enabled: true
|
||||
windows_nightly_next_enabled: true
|
||||
windows_nightly_main_enabled: true
|
||||
@@ -10,7 +10,7 @@ on:
|
||||
jobs:
|
||||
soundness:
|
||||
name: Soundness
|
||||
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.11
|
||||
uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.16
|
||||
with:
|
||||
license_header_check_project_name: "Swift Logging API"
|
||||
|
||||
@@ -18,19 +18,21 @@ jobs:
|
||||
name: Unit tests
|
||||
uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
|
||||
with:
|
||||
linux_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_6_1_enabled: false
|
||||
linux_6_4_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_6_1_enabled: true
|
||||
windows_6_1_enabled: false
|
||||
windows_6_2_enabled: true
|
||||
windows_6_3_enabled: true
|
||||
windows_6_4_enabled: true
|
||||
windows_nightly_next_enabled: true
|
||||
windows_nightly_main_enabled: true
|
||||
windows_6_1_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_6_2_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_6_3_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_6_4_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_nightly_next_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
windows_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
|
||||
|
||||
@@ -41,6 +43,7 @@ jobs:
|
||||
benchmark_package_paths: '["Benchmarks/NoTraits", "Benchmarks/MaxLogLevelWarning", "Benchmarks/MaxLogLevelNone"]'
|
||||
macos_runner_pool: general
|
||||
macos_swift_6_3_enabled: true
|
||||
macos_swift_6_4_enabled: true
|
||||
|
||||
cxx-interop:
|
||||
name: Cxx interop
|
||||
@@ -58,6 +61,15 @@ jobs:
|
||||
runner_pool: general
|
||||
build_scheme: swift-log-Package
|
||||
swift_test_enabled: true
|
||||
swift_6_1_enabled: false
|
||||
swift_6_2_enabled: true
|
||||
swift_6_3_enabled: true
|
||||
swift_6_4_enabled: true
|
||||
macos_xcode_test_enabled: true
|
||||
ios_xcode_test_enabled: false
|
||||
watchos_xcode_test_enabled: false
|
||||
tvos_xcode_test_enabled: false
|
||||
visionos_xcode_test_enabled: false
|
||||
|
||||
android:
|
||||
name: Android Swift SDK
|
||||
@@ -68,9 +80,10 @@ jobs:
|
||||
name: Release builds
|
||||
uses: apple/swift-nio/.github/workflows/release_builds.yml@main
|
||||
with:
|
||||
windows_6_1_enabled: true
|
||||
windows_6_1_enabled: false
|
||||
windows_6_2_enabled: true
|
||||
windows_6_3_enabled: true
|
||||
windows_6_4_enabled: true
|
||||
windows_nightly_next_enabled: true
|
||||
windows_nightly_main_enabled: true
|
||||
|
||||
@@ -79,3 +92,16 @@ jobs:
|
||||
uses: apple/swift-nio/.github/workflows/wasm_swift_sdk.yml@main
|
||||
with:
|
||||
nightly_next_enabled: false
|
||||
|
||||
cmake-lists:
|
||||
name: Check CMake Lists
|
||||
uses: apple/swift-nio/.github/workflows/cmake_tests.yml@main
|
||||
with:
|
||||
image: "swift:6.2-jammy"
|
||||
update_cmake_lists_config: >-
|
||||
{
|
||||
"targets": [
|
||||
{ "name": "Logging", "type": "source", "exceptions": [] },
|
||||
{ "name": "InMemoryLogging", "type": "source", "exceptions": [] }
|
||||
]
|
||||
}
|
||||
@@ -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,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+2
-2
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 759,
|
||||
"instructions" : 710,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 810,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 803,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 803,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 803,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
@@ -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,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 734,
|
||||
"instructions" : 689,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1993,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1968,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 815,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 750,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 775,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 2008,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 2002,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
@@ -86,4 +86,21 @@ public let benchmarks: @Sendable () -> Void = {
|
||||
]
|
||||
)
|
||||
}
|
||||
|
||||
// MARK: - metadata serialization performance
|
||||
|
||||
func nestedArrayMetadataValue(depth: Int) -> Logger.MetadataValue {
|
||||
var value: Logger.MetadataValue = .string("leaf")
|
||||
for _ in 0..<depth {
|
||||
value = .array([value])
|
||||
}
|
||||
return value
|
||||
}
|
||||
|
||||
for depth in [1, 5, 20, 1_000] {
|
||||
let nested = nestedArrayMetadataValue(depth: depth)
|
||||
makeBenchmark(loggerLevel: .info, logLevel: .debug, "_metadata_nesting_depth_\(depth)") { _ in
|
||||
blackHole(nested.description)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -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,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1050,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1046,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 5483,
|
||||
"objectAllocCount" : 1
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 4939775,
|
||||
"objectAllocCount" : 2016
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 82239,
|
||||
"objectAllocCount" : 37
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 18351,
|
||||
"objectAllocCount" : 6
|
||||
}
|
||||
+2
-2
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 5935,
|
||||
"instructions" : 6200,
|
||||
"objectAllocCount" : 2
|
||||
}
|
||||
}
|
||||
+2
-2
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 7151,
|
||||
"instructions" : 7600,
|
||||
"objectAllocCount" : 3
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1005,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1017,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 1966,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 4551,
|
||||
"objectAllocCount" : 1
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"instructions" : 9623,
|
||||
"objectAllocCount" : 4
|
||||
}
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1119,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1119,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1117,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 5327,
|
||||
"objectAllocCount" : 1
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 4263935,
|
||||
"objectAllocCount" : 2016
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 69119,
|
||||
"objectAllocCount" : 37
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 15471,
|
||||
"objectAllocCount" : 6
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 6851,
|
||||
"objectAllocCount" : 2
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 8399,
|
||||
"objectAllocCount" : 3
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1095,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1038,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 1972,
|
||||
"objectAllocCount" : 0
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 4171,
|
||||
"objectAllocCount" : 1
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"instructions" : 10231,
|
||||
"objectAllocCount" : 4
|
||||
}
|
||||
@@ -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"),
|
||||
]
|
||||
)
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
cmake_minimum_required(VERSION 3.19)
|
||||
|
||||
# Initialize C language first to inspect the compiler environment
|
||||
project(swift-log LANGUAGES C)
|
||||
|
||||
# Set Swift compiler target from C compiler target if not manually set for Windows
|
||||
if(WIN32 AND NOT CMAKE_Swift_COMPILER_TARGET)
|
||||
if(CMAKE_C_COMPILER_ARCHITECTURE_ID MATCHES "(ARM64|arm64|aarch64)")
|
||||
set(CMAKE_Swift_COMPILER_TARGET "aarch64-unknown-windows-msvc" CACHE STRING "Swift compiler target triple")
|
||||
elseif(CMAKE_C_COMPILER_ARCHITECTURE_ID MATCHES "(X86|x64|AMD64|x86_64)")
|
||||
set(CMAKE_Swift_COMPILER_TARGET "x86_64-unknown-windows-msvc" CACHE STRING "Swift compiler target triple")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
# Enable Swift after C defines the architecture
|
||||
enable_language(Swift)
|
||||
|
||||
option(BUILD_SHARED_LIBS "Build shared libraries by default" YES)
|
||||
|
||||
set(CMAKE_Swift_LANGUAGE_VERSION 6)
|
||||
|
||||
if(CMAKE_Swift_COMPILER_VERSION VERSION_LESS "6.2")
|
||||
message(FATAL_ERROR "swift-log requires Swift compiler version 6.2 or newer. Detected version: ${CMAKE_Swift_COMPILER_VERSION}")
|
||||
endif()
|
||||
|
||||
set(SWIFT_LOG_COMMON_COMPILE_OPTIONS
|
||||
"SHELL:-enable-upcoming-feature ExistentialAny"
|
||||
"SHELL:-enable-upcoming-feature MemberImportVisibility"
|
||||
"SHELL:-enable-upcoming-feature InternalImportsByDefault"
|
||||
"SHELL:-enable-upcoming-feature NonisolatedNonsendingByDefault"
|
||||
"SHELL:-Xfrontend -require-explicit-sendable"
|
||||
"SHELL:-package-name swift_log")
|
||||
|
||||
list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules)
|
||||
|
||||
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
|
||||
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
|
||||
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
|
||||
|
||||
set(CMAKE_Swift_MODULE_DIRECTORY ${CMAKE_BINARY_DIR}/swift)
|
||||
|
||||
if(MSVC)
|
||||
message(STATUS "MSVC condition triggered successfully!")
|
||||
set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
|
||||
set(CMAKE_Swift_COMPILE_OPTIONS_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
|
||||
endif()
|
||||
|
||||
include(GNUInstallDirs)
|
||||
include(SwiftSupport)
|
||||
|
||||
if(NOT APPLE)
|
||||
find_package(dispatch QUIET)
|
||||
find_package(Foundation QUIET)
|
||||
endif()
|
||||
|
||||
add_subdirectory(Sources)
|
||||
|
||||
add_subdirectory(cmake/modules)
|
||||
+4
-4
@@ -87,15 +87,15 @@ directory, for example:
|
||||
## Benchmarks
|
||||
|
||||
Benchmarks for `swift-log` are in a separate Swift Package in the `Benchmarks` subfolder of this repository.
|
||||
They use the [`package-benchmark`](https://github.com/ordo-one/package-benchmark) plugin.
|
||||
Benchmarks depends on the [`jemalloc`](https://jemalloc.net) memory allocation library, which is used by `package-benchmark` to capture memory allocation statistics.
|
||||
An installation guide can be found in the [Getting Started article](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark/gettingstarted#Installing-Prerequisites-and-Platform-Support) of `package-benchmark`.
|
||||
They use the [`benchmark`](https://github.com/ordo-one/benchmark) plugin.
|
||||
On Swift versions prior to 6.3 Benchmarks depends on the [`jemalloc`](https://jemalloc.net) memory allocation library, which is used by `benchmark` to capture memory allocation statistics.
|
||||
An installation guide can be found in the [Getting Started article](https://swiftpackageindex.com/ordo-one/benchmark/documentation/benchmark/gettingstarted#Installing-Prerequisites-and-Platform-Support) of `benchmark`.
|
||||
Afterwards you can run the benchmarks from CLI by going to the `Benchmarks` subfolder (e.g. `cd Benchmarks`) and invoking:
|
||||
```
|
||||
swift package benchmark
|
||||
```
|
||||
|
||||
For more information please refer to `swift package benchmark --help` or the [documentation of `package-benchmark`](https://swiftpackageindex.com/ordo-one/package-benchmark/documentation/benchmark).
|
||||
For more information please refer to `swift package benchmark --help` or the [documentation of `benchmark`](https://swiftpackageindex.com/ordo-one/benchmark/documentation/benchmark).
|
||||
|
||||
|
||||
## How to contribute your work
|
||||
|
||||
+4
-2
@@ -29,11 +29,13 @@ let package = Package(
|
||||
targets: [
|
||||
.target(
|
||||
name: "Logging",
|
||||
dependencies: []
|
||||
dependencies: [],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
.target(
|
||||
name: "InMemoryLogging",
|
||||
dependencies: ["Logging"]
|
||||
dependencies: ["Logging"],
|
||||
exclude: ["CMakeLists.txt"]
|
||||
),
|
||||
.testTarget(
|
||||
name: "LoggingTests",
|
||||
|
||||
@@ -1,66 +0,0 @@
|
||||
// swift-tools-version:6.1
|
||||
|
||||
import PackageDescription
|
||||
|
||||
let package = Package(
|
||||
name: "swift-log",
|
||||
products: [
|
||||
.library(name: "Logging", targets: ["Logging"]),
|
||||
.library(name: "InMemoryLogging", targets: ["InMemoryLogging"]),
|
||||
],
|
||||
traits: [
|
||||
.trait(name: "MaxLogLevelDebug", description: "Debug and above available (compiles out trace)"),
|
||||
.trait(name: "MaxLogLevelInfo", description: "Info and above available (compiles out trace, debug)"),
|
||||
.trait(name: "MaxLogLevelNotice", description: "Notice and above available (compiles out trace, debug, info)"),
|
||||
.trait(
|
||||
name: "MaxLogLevelWarning",
|
||||
description: "Warning and above available (compiles out trace, debug, info, notice)"
|
||||
),
|
||||
.trait(
|
||||
name: "MaxLogLevelError",
|
||||
description: "Error and above available (compiles out trace, debug, info, notice, warning)"
|
||||
),
|
||||
.trait(name: "MaxLogLevelCritical", description: "Only critical available (compiles out all except critical)"),
|
||||
.trait(name: "MaxLogLevelNone", description: "All logging compiled out (no log levels available)"),
|
||||
|
||||
// By default, no traits are enabled (all log levels available)
|
||||
.default(enabledTraits: []),
|
||||
],
|
||||
targets: [
|
||||
.target(
|
||||
name: "Logging",
|
||||
dependencies: []
|
||||
),
|
||||
.target(
|
||||
name: "InMemoryLogging",
|
||||
dependencies: ["Logging"]
|
||||
),
|
||||
.testTarget(
|
||||
name: "LoggingTests",
|
||||
dependencies: ["Logging"]
|
||||
),
|
||||
.testTarget(
|
||||
name: "InMemoryLoggingTests",
|
||||
dependencies: ["InMemoryLogging", "Logging"]
|
||||
),
|
||||
]
|
||||
)
|
||||
|
||||
for target in package.targets
|
||||
where [.executable, .test, .regular].contains(
|
||||
target.type
|
||||
) {
|
||||
var settings = target.swiftSettings ?? []
|
||||
|
||||
// https://github.com/apple/swift-evolution/blob/main/proposals/0335-existential-any.md
|
||||
// Require `any` for existential types.
|
||||
settings.append(.enableUpcomingFeature("ExistentialAny"))
|
||||
|
||||
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0444-member-import-visibility.md
|
||||
settings.append(.enableUpcomingFeature("MemberImportVisibility"))
|
||||
|
||||
// https://github.com/swiftlang/swift-evolution/blob/main/proposals/0409-access-level-on-imports.md
|
||||
settings.append(.enableUpcomingFeature("InternalImportsByDefault"))
|
||||
|
||||
target.swiftSettings = settings
|
||||
}
|
||||
@@ -22,7 +22,7 @@ choose from the many
|
||||
The following snippet shows how to add SwiftLog to your Swift Package:
|
||||
|
||||
```swift
|
||||
// swift-tools-version: 6.1
|
||||
// swift-tools-version: 6.2
|
||||
import PackageDescription
|
||||
|
||||
let package = Package(
|
||||
@@ -67,3 +67,8 @@ The community has built numerous specialized logging backends.
|
||||
A great way to discover available log backend implementations is searching the
|
||||
[Swift Package Index](https://swiftpackageindex.com/search?query=swift-log)
|
||||
for the `swift-log` keyword.
|
||||
|
||||
## Building with CMake
|
||||
|
||||
While Swift Package Manager (SPM) is the primary build system for development and testing, CMake build support is also available for integrated or mixed build environments if needed. Note that tests are not included in the CMake build, they are managed through Swift Package Manager with `swift test`.
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
add_subdirectory(Logging)
|
||||
add_subdirectory(InMemoryLogging)
|
||||
@@ -0,0 +1,28 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
add_library(InMemoryLogging
|
||||
"InMemoryLogHandler.swift"
|
||||
)
|
||||
|
||||
set_target_properties(InMemoryLogging PROPERTIES
|
||||
INTERFACE_INCLUDE_DIRECTORIES "$<BUILD_INTERFACE:$<TARGET_PROPERTY:Swift_MODULE_DIRECTORY>>;$<BUILD_INTERFACE:$<TARGET_FILE_DIR:InMemoryLogging>>")
|
||||
|
||||
target_compile_options(InMemoryLogging PRIVATE
|
||||
${SWIFT_LOG_COMMON_COMPILE_OPTIONS})
|
||||
|
||||
target_link_libraries(InMemoryLogging PRIVATE Logging)
|
||||
|
||||
_install_target(InMemoryLogging)
|
||||
set_property(GLOBAL APPEND PROPERTY SwiftLog_EXPORTS InMemoryLogging)
|
||||
@@ -0,0 +1,36 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
add_library(Logging
|
||||
"Handlers/MultiplexLogHandler.swift"
|
||||
"Handlers/StreamLogHandler.swift"
|
||||
"Handlers/SwiftLogNoOpLogHandler.swift"
|
||||
"Locks.swift"
|
||||
"LogEvent.swift"
|
||||
"LogHandler.swift"
|
||||
"Logger+Attributes.swift"
|
||||
"Logger+With.swift"
|
||||
"Logger.swift"
|
||||
"LoggingSystem.swift"
|
||||
"MetadataProvider.swift"
|
||||
)
|
||||
|
||||
set_target_properties(Logging PROPERTIES
|
||||
INTERFACE_INCLUDE_DIRECTORIES "$<BUILD_INTERFACE:$<TARGET_PROPERTY:Swift_MODULE_DIRECTORY>>;$<BUILD_INTERFACE:$<TARGET_FILE_DIR:Logging>>")
|
||||
|
||||
target_compile_options(Logging PRIVATE
|
||||
${SWIFT_LOG_COMMON_COMPILE_OPTIONS})
|
||||
|
||||
_install_target(Logging)
|
||||
set_property(GLOBAL APPEND PROPERTY SwiftLog_EXPORTS Logging)
|
||||
@@ -0,0 +1,81 @@
|
||||
# 004: Testing code that logs
|
||||
|
||||
Validate what you code logs by capturing entries in memory rather than bootstrapping a process-wide backend.
|
||||
|
||||
## Overview
|
||||
|
||||
Import and use `InMemoryLogging`, which provides an `InMemoryLogHandler` that collects every emitted record into an array you can inspect.
|
||||
Keep a handler you create local to each test.
|
||||
Each handler that you create in a test has no shared state, so the test stays isolated is safe to run on parallel with other tests.
|
||||
Don't use ``LoggingSystem/bootstrap(_:)`` in a test, it sets one process-wide backend and traps if called twice.
|
||||
|
||||
Add the product to your test target:
|
||||
|
||||
```swift
|
||||
.product(name: "InMemoryLogging", package: "swift-log")
|
||||
```
|
||||
|
||||
### Capture logs from a logger you pass in
|
||||
|
||||
When the code under test accepts a `Logger` (see <doc:003-AcceptingLoggers>), back it with
|
||||
an `InMemoryLogHandler` and validate the results on `entries`.
|
||||
|
||||
The following code illustrates how to set up and validate a handler using `InMemoryLogging` to check the expected results:
|
||||
|
||||
```swift
|
||||
import InMemoryLogging
|
||||
import Logging
|
||||
import Testing
|
||||
|
||||
struct RequestProcessor {
|
||||
func handle(id: String, logger: Logger) {
|
||||
logger.info("request received", metadata: ["request.id": "\(id)"])
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
func stampsRequestID() {
|
||||
let handler = InMemoryLogHandler()
|
||||
let logger = Logger(label: "test", factory: { _ in handler })
|
||||
|
||||
RequestProcessor().handle(id: "42", logger: logger)
|
||||
|
||||
#expect(handler.entries.count == 1)
|
||||
#expect(handler.entries[0].message == "request received")
|
||||
#expect(handler.entries[0].metadata["request.id"] == "42")
|
||||
}
|
||||
```
|
||||
|
||||
Each `Entry` is equatable and exposes `level`, `message`, `metadata`, and `error`.
|
||||
The handler log level defaults to ``Logger/Level/info``; set `handler.logLevel = .trace` before you use it to
|
||||
capture lower levels.
|
||||
|
||||
### Capture logs from code that reads `Logger.current`
|
||||
|
||||
When the code you want to test reads the task-local ``Logger/current`` instead of taking a parameter, bind an `InMemoryLogHandler` for the scope of that by using ``withLogger(logLevel:handler:metadata:_:)-2pd9p``.
|
||||
The handler shares its storage by reference, so the copy you hold sees what was logged.
|
||||
|
||||
Bind the handler for the scope of the call and validate the captured entry:
|
||||
|
||||
```swift
|
||||
import InMemoryLogging
|
||||
import Logging
|
||||
import Testing
|
||||
|
||||
struct AnalyticsClient {
|
||||
func track(_ event: String) {
|
||||
Logger.current.info("event", metadata: ["event.name": "\(event)"])
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
func tracksEvent() {
|
||||
let handler = InMemoryLogHandler()
|
||||
withLogger(handler: handler) { _ in
|
||||
AnalyticsClient().track("signup") // calls Logger.current.info(...)
|
||||
}
|
||||
|
||||
#expect(handler.entries.count == 1)
|
||||
#expect(handler.entries[0].metadata["event.name"] == "signup")
|
||||
}
|
||||
```
|
||||
@@ -102,6 +102,136 @@ public struct PrintLogHandler: LogHandler {
|
||||
|
||||
```
|
||||
|
||||
### Constructing handlers that need more than a label
|
||||
|
||||
Many log handler backends need more than a `label` in order to construct them: a file path, a remote address, credentials, or
|
||||
a buffer. A handler is an ordinary value that you construct, so nothing constrains its
|
||||
initializer — it can take any parameters it needs, and it can `throw`. There is no
|
||||
protocol-required `init(label:)`. The single `label` argument on factory methods such as
|
||||
`StreamLogHandler.standardOutput(label:)` is a convention, not a requirement.
|
||||
|
||||
Open expensive or fallible resources, such as a file, a socket, early and up front in your own initializer that can `throw`, so that failures surface at setup time.
|
||||
``LogHandler/log(event:)`` cannot throw, so an error deferred to logging time has nowhere to go.
|
||||
Keep the handler `struct` cheap and copyable by placing any shared resource behind a thread-safe reference type.
|
||||
Value semantics apply to a handler's *configuration* — its level and metadata — not its *destination*, so copies writing to
|
||||
the same file are correct and expected.
|
||||
|
||||
The `FileLogHandler` below opens its file once, in an initializer that throws and exception when you create it with an overlapping `Destination`.
|
||||
The handler `struct` itself stays a cheap, copyable value:
|
||||
|
||||
```swift
|
||||
import Foundation
|
||||
import Logging
|
||||
import Synchronization
|
||||
|
||||
/// A log handler that appends formatted log lines to a file on disk.
|
||||
public struct FileLogHandler: LogHandler {
|
||||
/// The shared, thread-safe destination. Open it once, then share it across handlers: because
|
||||
/// the destination is a reference type, all those value-semantic handlers write through a single
|
||||
/// locked file handle.
|
||||
public final class Destination: @unchecked Sendable {
|
||||
private let fileHandle: Mutex<FileHandle>
|
||||
|
||||
/// Opens `url` for appending. All validation happens here, at setup time.
|
||||
public init(writingTo url: URL) throws {
|
||||
let fileManager = FileManager.default
|
||||
if !fileManager.fileExists(atPath: url.path) {
|
||||
guard fileManager.createFile(atPath: url.path, contents: nil) else {
|
||||
throw Failure.cannotCreateFile(url)
|
||||
}
|
||||
}
|
||||
self.fileHandle = .init(try FileHandle(forWritingTo: url))
|
||||
_ = try self.fileHandle.withLock { try $0.seekToEnd() }
|
||||
}
|
||||
|
||||
func write(_ line: String) {
|
||||
// `log(event:)` cannot throw, so a write failure is handled here, not propagated.
|
||||
do {
|
||||
try self.fileHandle.withLock { try $0.write(contentsOf: Data(line.utf8)) }
|
||||
} catch {
|
||||
// Surface the failure without crashing the application.
|
||||
try? FileHandle.standardError.write(contentsOf: Data("FileLogHandler: \(error)\n".utf8))
|
||||
}
|
||||
}
|
||||
|
||||
/// Flushes and closes the file. Call this during shutdown.
|
||||
public func close() {
|
||||
self.fileHandle.withLock { try? $0.close() }
|
||||
}
|
||||
}
|
||||
|
||||
/// Errors thrown while opening a ``Destination``.
|
||||
public enum Failure: Error {
|
||||
case cannotCreateFile(URL)
|
||||
}
|
||||
|
||||
private let label: String
|
||||
private let destination: Destination
|
||||
|
||||
// Per-logger configuration — this is what must carry value semantics.
|
||||
public var logLevel: Logger.Level = .info
|
||||
public var metadata: Logger.Metadata = [:]
|
||||
public var metadataProvider: Logger.MetadataProvider?
|
||||
|
||||
/// Cheap and non-throwing, so it is safe to call from a bootstrap factory closure per label.
|
||||
public init(label: String, destination: Destination, metadataProvider: Logger.MetadataProvider? = nil) {
|
||||
self.label = label
|
||||
self.destination = destination
|
||||
self.metadataProvider = metadataProvider
|
||||
}
|
||||
|
||||
public func log(event: LogEvent) {
|
||||
var merged = self.metadata
|
||||
if let provided = self.metadataProvider?.get() {
|
||||
merged.merge(provided, uniquingKeysWith: { _, new in new })
|
||||
}
|
||||
if let explicit = event.metadata {
|
||||
merged.merge(explicit, uniquingKeysWith: { _, new in new })
|
||||
}
|
||||
let renderedMetadata =
|
||||
merged.isEmpty
|
||||
? ""
|
||||
: " " + merged.sorted { $0.key < $1.key }.map { "\($0.key)=\($0.value)" }.joined(separator: " ")
|
||||
self.destination.write("\(event.level) \(self.label):\(renderedMetadata) \(event.message)\n")
|
||||
}
|
||||
|
||||
public subscript(metadataKey key: String) -> Logger.Metadata.Value? {
|
||||
get { self.metadata[key] }
|
||||
set { self.metadata[key] = newValue }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Using your log handler
|
||||
|
||||
Construct the destination where you can use `try` to build a logger backed by your handler, then bind it
|
||||
as ``Logger/current`` for the application's lifetime using `withLogger`:
|
||||
|
||||
```swift
|
||||
// Open the file once, where setup can throw.
|
||||
let destination = try FileLogHandler.Destination(writingTo: URL(fileURLWithPath: "/var/log/myapp.log"))
|
||||
defer { destination.close() }
|
||||
|
||||
// Build a logger backed by the handler, then bind it for the scope.
|
||||
let logger = Logger(label: "app") { label in
|
||||
FileLogHandler(label: label, destination: destination)
|
||||
}
|
||||
try await withLogger(logger) { logger in
|
||||
logger.info("Application started")
|
||||
// Code in this scope reads the handler through Logger.current.
|
||||
}
|
||||
```
|
||||
|
||||
The `try` on `Destination` is where setup fails if the path is unwritable: validation happens
|
||||
before the logger is constructed, so you never need a throwing factory overload.
|
||||
Use the same pattern for handlers that connect to a remote service:
|
||||
- validate and connect up front
|
||||
- keep ``LogHandler/log(event:)`` non-blocking by buffering onto a background task
|
||||
- provide a `close()` or `shutdown()` (or use [Swift Service Lifecycle](https://github.com/swift-server/swift-service-lifecycle) service) to flush on shutdown
|
||||
|
||||
For runtime failures the handler can't avoid, such as a full disk or a broken pipe, degrade gracefully inside `log(event:)` by dropping the log message, retrying, or reporting to `stderr`.
|
||||
Never call `fatalError` on the logging path.
|
||||
|
||||
### Advanced features
|
||||
|
||||
#### Metadata providers
|
||||
|
||||
@@ -41,3 +41,4 @@ practice includes:
|
||||
- <doc:001-ChoosingLogLevels>
|
||||
- <doc:002-StructuredLogging>
|
||||
- <doc:003-AcceptingLoggers>
|
||||
- <doc:004-TestingLogging>
|
||||
@@ -35,4 +35,15 @@ If you have any questions, ask in an issue on GitHub.
|
||||
|
||||
## Topics
|
||||
|
||||
### Implemented Proposals
|
||||
|
||||
- <doc:SLG-0001-metadata-providers>
|
||||
- <doc:SLG-0002>
|
||||
- <doc:SLG-0003>
|
||||
- <doc:SLG-0004-metadata-value-attributes>
|
||||
- <doc:SLG-0005-log-event-LogHandler-API>
|
||||
- <doc:SLG-0006-task-local-logger>
|
||||
|
||||
### Proposal Template
|
||||
|
||||
- <doc:SLG-NNNN>
|
||||
@@ -6,7 +6,7 @@ Add an extensible per-value attribute mechanism for metadata.
|
||||
|
||||
- Proposal: SLG-0004
|
||||
- Author(s): [Vladimir Kukushkin](https://github.com/kukushechkin)
|
||||
- Status: **Ready for Implementation**
|
||||
- Status: **Approved**
|
||||
- Issue: [apple/swift-log#204](https://github.com/apple/swift-log/issues/204)
|
||||
- Implementation:
|
||||
- [apple/swift-log#453](https://github.com/apple/swift-log/pull/453)
|
||||
|
||||
@@ -6,7 +6,7 @@ Accumulate structured logging metadata across async call stacks using task-local
|
||||
|
||||
- Proposal: SLG-0006
|
||||
- Author(s): [Vladimir Kukushkin](https://github.com/kukushechkin)
|
||||
- Status: **Ready for Implementation**
|
||||
- Status: **Approved**
|
||||
- Issue: [apple/swift-log#261](https://github.com/apple/swift-log/issues/261)
|
||||
- Implementation: [apple/swift-log#459](https://github.com/apple/swift-log/pull/459)
|
||||
- Feature flag: none
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
### Creating a metadata provider
|
||||
|
||||
- ``init(_:)-(()->Logger.Metadata)``
|
||||
- ``init(_:)``
|
||||
|
||||
### Invoking the provider
|
||||
|
||||
|
||||
@@ -9,3 +9,8 @@
|
||||
- ``array(_:)``
|
||||
- ``dictionary(_:)``
|
||||
|
||||
### Working with attributes
|
||||
|
||||
- ``attributed(_:attributes:)``
|
||||
- ``attributes``
|
||||
|
||||
@@ -10,6 +10,16 @@
|
||||
- ``init(label:factory:)-6iktu``
|
||||
- ``MetadataProvider``
|
||||
|
||||
### Task-local logger
|
||||
|
||||
- ``current``
|
||||
- ``withLogger(_:_:)-3dt06``
|
||||
- ``withLogger(_:_:)-70nli``
|
||||
- ``withLogger(mergingMetadata:_:)-2c7dy``
|
||||
- ``withLogger(mergingMetadata:_:)-3eduo``
|
||||
- ``withLogger(logLevel:handler:metadata:_:)-2pd9p``
|
||||
- ``withLogger(logLevel:handler:metadata:_:)-5nmw6``
|
||||
|
||||
### Sending trace log messages
|
||||
|
||||
- ``trace(_:metadata:file:function:line:)``
|
||||
|
||||
@@ -8,6 +8,8 @@
|
||||
- ``standardOutput(label:metadataProvider:)``
|
||||
- ``standardError(label:)``
|
||||
- ``standardError(label:metadataProvider:)``
|
||||
- ``init(label:stream:)``
|
||||
- ``init(label:stream:metadataProvider:)``
|
||||
|
||||
### Sending log messages
|
||||
|
||||
|
||||
@@ -144,9 +144,23 @@ public struct MultiplexLogHandler: LogHandler {
|
||||
|
||||
/// Log a message using the log level and source that you provide.
|
||||
///
|
||||
/// Metadata from this handler's metadata provider overrides metadata from
|
||||
/// the underlying handlers and their providers. Explicit metadata in the
|
||||
/// log event takes precedence over this handler's provider.
|
||||
///
|
||||
/// - parameters:
|
||||
/// - event: The log event containing the level, message, metadata, and source location.
|
||||
public func log(event: LogEvent) {
|
||||
var event = event
|
||||
if let provider = self._metadataProvider {
|
||||
var metadata = provider.get()
|
||||
if let explicit = event.metadata {
|
||||
metadata.merge(explicit, uniquingKeysWith: { _, explicit in explicit })
|
||||
}
|
||||
if !metadata.isEmpty {
|
||||
event.metadata = metadata
|
||||
}
|
||||
}
|
||||
for handler in self.handlers where handler.logLevel <= event.level {
|
||||
handler.log(event: event)
|
||||
}
|
||||
|
||||
@@ -38,8 +38,6 @@ import WASILibc
|
||||
/// 2. The handler's ``metadataProvider`` is invoked, overriding any existing keys.
|
||||
/// 3. The per-log-statement metadata is merged, overriding any previously set keys.
|
||||
public struct StreamLogHandler: LogHandler {
|
||||
internal typealias _SendableTextOutputStream = TextOutputStream & Sendable
|
||||
|
||||
/// Creates a stream log handler that directs its output to STDOUT.
|
||||
public static func standardOutput(label: String) -> StreamLogHandler {
|
||||
StreamLogHandler(
|
||||
@@ -68,7 +66,7 @@ public struct StreamLogHandler: LogHandler {
|
||||
StreamLogHandler(label: label, stream: StdioOutputStream.stderr, metadataProvider: metadataProvider)
|
||||
}
|
||||
|
||||
private let stream: any _SendableTextOutputStream
|
||||
private let stream: any TextOutputStream & Sendable
|
||||
private let label: String
|
||||
|
||||
/// Get the log level configured for this `Logger`.
|
||||
@@ -102,13 +100,24 @@ public struct StreamLogHandler: LogHandler {
|
||||
}
|
||||
}
|
||||
|
||||
// internal for testing only
|
||||
internal init(label: String, stream: any _SendableTextOutputStream) {
|
||||
/// Creates a ``StreamLogHandler`` that directs its output to the stream you provide,
|
||||
/// using the global metadata provider from ``LoggingSystem``.
|
||||
///
|
||||
/// - parameters:
|
||||
/// - label: The label for this log handler.
|
||||
/// - stream: The stream to write log output to.
|
||||
public init(label: String, stream: any TextOutputStream & Sendable) {
|
||||
self.init(label: label, stream: stream, metadataProvider: LoggingSystem.metadataProvider)
|
||||
}
|
||||
|
||||
// internal for testing only
|
||||
internal init(label: String, stream: any _SendableTextOutputStream, metadataProvider: Logger.MetadataProvider?) {
|
||||
/// Creates a ``StreamLogHandler`` that directs its output to the stream you provide,
|
||||
/// using the metadata provider you provide.
|
||||
///
|
||||
/// - parameters:
|
||||
/// - label: The label for this log handler.
|
||||
/// - stream: The stream to write log output to.
|
||||
/// - metadataProvider: The metadata provider to use, or `nil` for no provider.
|
||||
public init(label: String, stream: any TextOutputStream & Sendable, metadataProvider: Logger.MetadataProvider?) {
|
||||
self.label = label
|
||||
self.stream = stream
|
||||
self.metadataProvider = metadataProvider
|
||||
@@ -336,8 +345,13 @@ internal struct StdioOutputStream: TextOutputStream, @unchecked Sendable {
|
||||
)
|
||||
#elseif canImport(WASILibc)
|
||||
// no file locking on WASI
|
||||
#if compiler(>=6.5)
|
||||
let file = WASILibc.stderr
|
||||
#else
|
||||
let file = WASILibc.stderr!
|
||||
#endif
|
||||
return StdioOutputStream(
|
||||
file: WASILibc.stderr!,
|
||||
file: file,
|
||||
flushMode: .always,
|
||||
lock: nil,
|
||||
unlock: nil,
|
||||
@@ -408,8 +422,13 @@ internal struct StdioOutputStream: TextOutputStream, @unchecked Sendable {
|
||||
)
|
||||
#elseif canImport(WASILibc)
|
||||
// no file locking on WASI
|
||||
#if compiler(>=6.5)
|
||||
let file = WASILibc.stdout
|
||||
#else
|
||||
let file = WASILibc.stdout!
|
||||
#endif
|
||||
return StdioOutputStream(
|
||||
file: WASILibc.stdout!,
|
||||
file: file,
|
||||
flushMode: .always,
|
||||
lock: nil,
|
||||
unlock: nil,
|
||||
|
||||
+11
-11
@@ -61,7 +61,7 @@ package final class Lock {
|
||||
#elseif os(FreeBSD) || os(OpenBSD)
|
||||
fileprivate let mutex: UnsafeMutablePointer<pthread_mutex_t?> =
|
||||
UnsafeMutablePointer.allocate(capacity: 1)
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
fileprivate let mutex: UnsafeMutablePointer<pthread_mutex_t> =
|
||||
UnsafeMutablePointer.allocate(capacity: 1)
|
||||
#endif
|
||||
@@ -70,7 +70,7 @@ package final class Lock {
|
||||
package init() {
|
||||
#if os(Windows)
|
||||
InitializeSRWLock(self.mutex)
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
#if os(FreeBSD) || os(OpenBSD)
|
||||
var attr = pthread_mutexattr_t(bitPattern: 0)
|
||||
#else
|
||||
@@ -100,7 +100,7 @@ package final class Lock {
|
||||
deinit {
|
||||
#if os(Windows)
|
||||
mutex.deallocate()
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
let err = pthread_mutex_destroy(self.mutex)
|
||||
precondition(err == 0, "\(#function) failed in pthread_mutex with error \(err)")
|
||||
mutex.deallocate()
|
||||
@@ -114,7 +114,7 @@ package final class Lock {
|
||||
package func lock() {
|
||||
#if os(Windows)
|
||||
AcquireSRWLockExclusive(self.mutex)
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
let err = pthread_mutex_lock(self.mutex)
|
||||
precondition(err == 0, "\(#function) failed in pthread_mutex with error \(err)")
|
||||
#endif
|
||||
@@ -127,7 +127,7 @@ package final class Lock {
|
||||
package func unlock() {
|
||||
#if os(Windows)
|
||||
ReleaseSRWLockExclusive(self.mutex)
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
let err = pthread_mutex_unlock(self.mutex)
|
||||
precondition(err == 0, "\(#function) failed in pthread_mutex with error \(err)")
|
||||
#endif
|
||||
@@ -196,10 +196,10 @@ internal final class ReadWriteLock: @unchecked Sendable {
|
||||
#endif
|
||||
|
||||
/// Create a new lock.
|
||||
public init() {
|
||||
init() {
|
||||
#if os(Windows)
|
||||
InitializeSRWLock(self.rwlock)
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
let err = pthread_rwlock_init(self.rwlock, nil)
|
||||
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
|
||||
#endif
|
||||
@@ -208,7 +208,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
|
||||
deinit {
|
||||
#if os(Windows)
|
||||
self.rwlock.deallocate()
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
let err = pthread_rwlock_destroy(self.rwlock)
|
||||
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
|
||||
self.rwlock.deallocate()
|
||||
@@ -223,7 +223,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
|
||||
#if os(Windows)
|
||||
AcquireSRWLockShared(self.rwlock)
|
||||
self.shared = true
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
let err = pthread_rwlock_rdlock(self.rwlock)
|
||||
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
|
||||
#endif
|
||||
@@ -237,7 +237,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
|
||||
#if os(Windows)
|
||||
AcquireSRWLockExclusive(self.rwlock)
|
||||
self.shared = false
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
let err = pthread_rwlock_wrlock(self.rwlock)
|
||||
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
|
||||
#endif
|
||||
@@ -255,7 +255,7 @@ internal final class ReadWriteLock: @unchecked Sendable {
|
||||
} else {
|
||||
ReleaseSRWLockExclusive(self.rwlock)
|
||||
}
|
||||
#elseif (compiler(<6.1) && !os(WASI)) || (compiler(>=6.1) && _runtime(_multithreaded))
|
||||
#elseif _runtime(_multithreaded)
|
||||
let err = pthread_rwlock_unlock(self.rwlock)
|
||||
precondition(err == 0, "\(#function) failed in pthread_rwlock with error \(err)")
|
||||
#endif
|
||||
|
||||
@@ -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
|
||||
)
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -19,8 +19,8 @@
|
||||
/// Code called within `operation` can read the logger via ``Logger/current`` without an
|
||||
/// explicit parameter. Binding a different logger with this overload **replaces** the
|
||||
/// current task-local logger; any metadata accumulated by an outer
|
||||
/// ``withLogger(mergingMetadata:_:)-(_,(Logger)(Failure)->Result)`` or
|
||||
/// ``withLogger(logLevel:handler:metadata:_:)-(_,_,_,(Logger)(Failure)->Result)``
|
||||
/// ``withLogger(mergingMetadata:_:)-2c7dy`` or
|
||||
/// ``withLogger(logLevel:handler:metadata:_:)-2pd9p``
|
||||
/// scope is not carried over. Use the modifying overloads to layer or replace aspects
|
||||
/// of the current logger instead.
|
||||
///
|
||||
@@ -29,7 +29,7 @@
|
||||
/// ``Logger/init(label:)`` consults `LoggingSystem.factory`, the constructed `Logger`
|
||||
/// only carries a useful handler once ``LoggingSystem/bootstrap(_:)`` has been called.
|
||||
/// For mid-call-tree backend swaps that should work without bootstrap (tests, scoped
|
||||
/// routing), use ``withLogger(logLevel:handler:metadata:_:)-(_,_,_,(Logger)(Failure)->Result)``
|
||||
/// routing), use ``withLogger(logLevel:handler:metadata:_:)-2pd9p``
|
||||
/// instead — it modifies
|
||||
/// the current logger's handler in place without constructing a new one.
|
||||
///
|
||||
@@ -66,8 +66,8 @@ public func withLogger<Result, Failure: Error>(
|
||||
/// Code called within `operation` can read the logger via ``Logger/current`` without an
|
||||
/// explicit parameter. Binding a different logger with this overload **replaces** the
|
||||
/// current task-local logger; any metadata accumulated by an outer
|
||||
/// ``withLogger(mergingMetadata:_:)-(_,(Logger)(Failure)->Result)`` or
|
||||
/// ``withLogger(logLevel:handler:metadata:_:)-(_,_,_,(Logger)(Failure)->Result)``
|
||||
/// ``withLogger(mergingMetadata:_:)-3eduo`` or
|
||||
/// ``withLogger(logLevel:handler:metadata:_:)-5nmw6``
|
||||
/// scope is not carried over. Use the modifying overloads to layer or replace aspects
|
||||
/// of the current logger instead.
|
||||
///
|
||||
@@ -76,7 +76,7 @@ public func withLogger<Result, Failure: Error>(
|
||||
/// ``Logger/init(label:)`` consults `LoggingSystem.factory`, the constructed `Logger`
|
||||
/// only carries a useful handler once ``LoggingSystem/bootstrap(_:)`` has been called.
|
||||
/// For mid-call-tree backend swaps that should work without bootstrap (tests, scoped
|
||||
/// routing), use ``withLogger(logLevel:handler:metadata:_:)-(_,_,_,(Logger)(Failure)->Result)``
|
||||
/// routing), use ``withLogger(logLevel:handler:metadata:_:)-5nmw6``
|
||||
/// instead — it modifies
|
||||
/// the current logger's handler in place without constructing a new one.
|
||||
///
|
||||
@@ -93,7 +93,6 @@ public func withLogger<Result, Failure: Error>(
|
||||
/// - operation: The async closure to run with `logger` bound. Receives `logger` as a
|
||||
/// parameter so the body does not need to re-read ``Logger/current``.
|
||||
/// - Returns: The value returned by `operation`.
|
||||
#if compiler(>=6.2)
|
||||
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
|
||||
@inlinable
|
||||
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
|
||||
@@ -108,23 +107,6 @@ public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
|
||||
throw error as! Failure
|
||||
}
|
||||
}
|
||||
#else
|
||||
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
|
||||
@inlinable
|
||||
public func withLogger<Result, Failure: Error>(
|
||||
_ logger: Logger,
|
||||
isolation: isolated (any Actor)? = #isolation,
|
||||
_ operation: (Logger) async throws(Failure) -> Result,
|
||||
) async throws(Failure) -> Result {
|
||||
do {
|
||||
return try await Logger.withTaskLocalLogger(logger, isolation: isolation) {
|
||||
try await operation(logger)
|
||||
}
|
||||
} catch {
|
||||
throw error as! Failure
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
/// Runs `operation` with a copy of ``Logger/current`` that has `metadata` **layered on
|
||||
/// top of** the inherited base metadata. Keys present in `metadata` override existing
|
||||
@@ -132,7 +114,7 @@ public func withLogger<Result, Failure: Error>(
|
||||
/// `metadata`) are preserved.
|
||||
///
|
||||
/// Use this overload at request boundaries and any point where context should
|
||||
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-(_,(Logger)(Failure)->Result)`` scopes
|
||||
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-2c7dy`` scopes
|
||||
/// layer on top of each
|
||||
/// other.
|
||||
///
|
||||
@@ -176,7 +158,7 @@ public func withLogger<Result, Failure: Error>(
|
||||
/// `metadata`) are preserved.
|
||||
///
|
||||
/// Use this overload at request boundaries and any point where context should
|
||||
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-(_,(Logger)(Failure)->Result)`` scopes
|
||||
/// accumulate. Nested ``withLogger(mergingMetadata:_:)-3eduo`` scopes
|
||||
/// layer on top of each
|
||||
/// other.
|
||||
///
|
||||
@@ -195,7 +177,6 @@ public func withLogger<Result, Failure: Error>(
|
||||
/// - operation: The async closure to run with the merged logger bound. Receives the
|
||||
/// merged logger as a parameter.
|
||||
/// - Returns: The value returned by `operation`.
|
||||
#if compiler(>=6.2)
|
||||
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
|
||||
@inlinable
|
||||
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
|
||||
@@ -214,32 +195,11 @@ public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
|
||||
throw error as! Failure
|
||||
}
|
||||
}
|
||||
#else
|
||||
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
|
||||
@inlinable
|
||||
public func withLogger<Result, Failure: Error>(
|
||||
mergingMetadata metadata: @autoclosure () -> Logger.Metadata,
|
||||
isolation: isolated (any Actor)? = #isolation,
|
||||
_ operation: (Logger) async throws(Failure) -> Result,
|
||||
) async throws(Failure) -> Result {
|
||||
var logger = Logger.current
|
||||
for (key, value) in metadata() {
|
||||
logger[metadataKey: key] = value
|
||||
}
|
||||
do {
|
||||
return try await Logger.withTaskLocalLogger(logger, isolation: isolation) {
|
||||
try await operation(logger)
|
||||
}
|
||||
} catch {
|
||||
throw error as! Failure
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
/// Runs `operation` with a copy of ``Logger/current`` whose aspects are **replaced** by
|
||||
/// the provided arguments. `nil` parameters leave the corresponding aspect unchanged.
|
||||
///
|
||||
/// Unlike ``withLogger(mergingMetadata:_:)-(_,(Logger)(Failure)->Result)``, which layers
|
||||
/// Unlike ``withLogger(mergingMetadata:_:)-2c7dy``, which layers
|
||||
/// metadata on top of the
|
||||
/// inherited base, this overload **replaces** the base metadata when `metadata` is
|
||||
/// non-nil. Pass `metadata: [:]` to wipe the inherited metadata entirely for the scope.
|
||||
@@ -282,12 +242,12 @@ public func withLogger<Result, Failure: Error>(
|
||||
_ operation: (Logger) throws(Failure) -> Result
|
||||
) throws(Failure) -> Result {
|
||||
var logger = Logger.current
|
||||
if let logLevel {
|
||||
logger.logLevel = logLevel
|
||||
}
|
||||
if let handler {
|
||||
logger.handler = handler
|
||||
}
|
||||
if let logLevel {
|
||||
logger.logLevel = logLevel
|
||||
}
|
||||
if let metadata = metadata() {
|
||||
logger.handler.metadata = metadata
|
||||
}
|
||||
@@ -303,7 +263,7 @@ public func withLogger<Result, Failure: Error>(
|
||||
/// Runs `operation` with a copy of ``Logger/current`` whose aspects are **replaced** by
|
||||
/// the provided arguments. `nil` parameters leave the corresponding aspect unchanged.
|
||||
///
|
||||
/// Unlike ``withLogger(mergingMetadata:_:)-(_,(Logger)(Failure)->Result)``, which layers
|
||||
/// Unlike ``withLogger(mergingMetadata:_:)-3eduo``, which layers
|
||||
/// metadata on top of the
|
||||
/// inherited base, this overload **replaces** the base metadata when `metadata` is
|
||||
/// non-nil. Pass `metadata: [:]` to wipe the inherited metadata entirely for the scope.
|
||||
@@ -337,7 +297,6 @@ public func withLogger<Result, Failure: Error>(
|
||||
/// - operation: The async closure to run with the modified logger bound. Receives the
|
||||
/// modified logger as a parameter.
|
||||
/// - Returns: The value returned by `operation`.
|
||||
#if compiler(>=6.2)
|
||||
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
|
||||
@inlinable
|
||||
public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
|
||||
@@ -347,12 +306,12 @@ public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
|
||||
_ operation: nonisolated(nonsending) (Logger) async throws(Failure) -> Result
|
||||
) async throws(Failure) -> Result {
|
||||
var logger = Logger.current
|
||||
if let logLevel {
|
||||
logger.logLevel = logLevel
|
||||
}
|
||||
if let handler {
|
||||
logger.handler = handler
|
||||
}
|
||||
if let logLevel {
|
||||
logger.logLevel = logLevel
|
||||
}
|
||||
if let metadata = metadata() {
|
||||
logger.handler.metadata = metadata
|
||||
}
|
||||
@@ -364,32 +323,3 @@ public nonisolated(nonsending) func withLogger<Result, Failure: Error>(
|
||||
throw error as! Failure
|
||||
}
|
||||
}
|
||||
#else
|
||||
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
|
||||
@inlinable
|
||||
public func withLogger<Result, Failure: Error>(
|
||||
logLevel: Logger.Level? = nil,
|
||||
handler: (any LogHandler)? = nil,
|
||||
metadata: @autoclosure () -> Logger.Metadata? = nil,
|
||||
isolation: isolated (any Actor)? = #isolation,
|
||||
_ operation: (Logger) async throws(Failure) -> Result
|
||||
) async throws(Failure) -> Result {
|
||||
var logger = Logger.current
|
||||
if let logLevel {
|
||||
logger.logLevel = logLevel
|
||||
}
|
||||
if let handler {
|
||||
logger.handler = handler
|
||||
}
|
||||
if let metadata = metadata() {
|
||||
logger.handler.metadata = metadata
|
||||
}
|
||||
do {
|
||||
return try await Logger.withTaskLocalLogger(logger, isolation: isolation) {
|
||||
try await operation(logger)
|
||||
}
|
||||
} catch {
|
||||
throw error as! Failure
|
||||
}
|
||||
}
|
||||
#endif
|
||||
@@ -57,15 +57,23 @@ public struct Logger {
|
||||
/// This computed property provides access to the `LogHandler`.
|
||||
@inlinable
|
||||
public var handler: any LogHandler {
|
||||
get {
|
||||
self._storage.handler
|
||||
_read {
|
||||
yield self._storage.handler
|
||||
}
|
||||
// Keep a setter for plain assignments, which is cheaper than going through `_modify`.
|
||||
set {
|
||||
if !isKnownUniquelyReferenced(&self._storage) {
|
||||
self._storage = self._storage.copy()
|
||||
}
|
||||
self._storage.handler = newValue
|
||||
}
|
||||
// Yield the stored handler, so a metadata write does not copy the handler's metadata.
|
||||
_modify {
|
||||
if !isKnownUniquelyReferenced(&self._storage) {
|
||||
self._storage = self._storage.copy()
|
||||
}
|
||||
yield &self._storage.handler
|
||||
}
|
||||
}
|
||||
|
||||
/// The metadata provider this logger was created with.
|
||||
@@ -1414,14 +1422,29 @@ extension Logger.MetadataValue: CustomStringConvertible {
|
||||
/// A string representation of the metadata value.
|
||||
public var description: String {
|
||||
switch self {
|
||||
case .dictionary(let dict):
|
||||
return dict.mapValues { $0.description }.description
|
||||
case .array(let list):
|
||||
return list.map { $0.description }.description
|
||||
case .string(let str):
|
||||
return str
|
||||
case .stringConvertible(let repr):
|
||||
return repr.description
|
||||
case .array(let list):
|
||||
let items = list.map { $0.quotedAsCollectionElement }
|
||||
return "[\(items.joined(separator: ", "))]"
|
||||
case .dictionary(let dict):
|
||||
guard !dict.isEmpty else { return "[:]" }
|
||||
let entries = dict.map { key, value in "\(key.debugDescription): \(value.quotedAsCollectionElement)" }
|
||||
return "[\(entries.joined(separator: ", "))]"
|
||||
}
|
||||
}
|
||||
|
||||
/// Only qute the leaf
|
||||
private var quotedAsCollectionElement: String {
|
||||
switch self {
|
||||
case .string(let str):
|
||||
return str.debugDescription
|
||||
case .stringConvertible(let repr):
|
||||
return repr.description.debugDescription
|
||||
case .array, .dictionary:
|
||||
return self.description
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1472,7 +1495,6 @@ extension Logger {
|
||||
|
||||
/// Thin wrapper over `TaskLocal.withValue` so call sites don't need to reach into
|
||||
/// the task-local storage directly.
|
||||
#if compiler(>=6.2)
|
||||
@inlinable
|
||||
nonisolated(nonsending) static func withTaskLocalLogger<Return, Failure: Error>(
|
||||
_ value: Logger,
|
||||
@@ -1484,20 +1506,6 @@ extension Logger {
|
||||
throw error as! Failure
|
||||
}
|
||||
}
|
||||
#else
|
||||
@inlinable
|
||||
static func withTaskLocalLogger<Return, Failure: Error>(
|
||||
_ value: Logger,
|
||||
isolation: isolated (any Actor)? = #isolation,
|
||||
operation: () async throws(Failure) -> Return
|
||||
) async throws(Failure) -> Return {
|
||||
do {
|
||||
return try await Self.taskLocalLogger.withValue(value, operation: operation, isolation: isolation)
|
||||
} catch {
|
||||
throw error as! Failure
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
@inlinable
|
||||
static func withTaskLocalLogger<Return, Failure: Error>(
|
||||
@@ -1514,7 +1522,7 @@ extension Logger {
|
||||
/// The current task-local logger.
|
||||
///
|
||||
/// Returns the logger bound by the nearest enclosing
|
||||
/// ``withLogger(_:_:)-(_,(Logger)(Failure)->Result)`` scope. If none is active, returns the
|
||||
/// ``withLogger(_:_:)-70nli`` scope. If none is active, returns the
|
||||
/// process-wide unbound default — a `Logger(label: "")` constructed via
|
||||
/// `LoggingSystem.factory` the first time the task-local is touched, then reused for
|
||||
/// the lifetime of the process. The empty label is the deliberate diagnostic signal
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// This source file is part of the Swift Logging API open source project
|
||||
//
|
||||
// Copyright (c) 2026 Apple Inc. and the Swift Logging API project authors
|
||||
// Licensed under Apache License v2.0
|
||||
//
|
||||
// See LICENSE.txt for license information
|
||||
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import InMemoryLogging
|
||||
import Logging
|
||||
import Testing
|
||||
|
||||
struct MultiplexProviderRegressionTests {
|
||||
@Test(arguments: [1, 2])
|
||||
func constructorProviderReachesEverySink(handlerCount: Int) {
|
||||
let sinks = (0..<handlerCount).map { _ in InMemoryLogHandler() }
|
||||
let handler = MultiplexLogHandler(sinks, metadataProvider: .init { ["trace-id": "123"] })
|
||||
let logger = Logger(label: "test", factory: { _ in handler })
|
||||
#expect(logger.metadataProvider?.get()["trace-id"] == "123")
|
||||
logger.info("hello")
|
||||
for sink in sinks {
|
||||
#expect(sink.entries.count == 1)
|
||||
#expect(sink.entries.first?.metadata["trace-id"] == "123")
|
||||
}
|
||||
}
|
||||
|
||||
@Test func constructorProviderLayersBetweenChildAndExplicitMetadata() {
|
||||
var sink = InMemoryLogHandler()
|
||||
sink.metadataProvider = .init { ["child": "kept", "shared": "child"] }
|
||||
let handler = MultiplexLogHandler(
|
||||
[sink],
|
||||
metadataProvider: .init {
|
||||
["outer": "kept", "shared": "outer"]
|
||||
}
|
||||
)
|
||||
let logger = Logger(label: "test", factory: { _ in handler })
|
||||
logger.info("provided")
|
||||
logger.info("explicit", metadata: ["shared": "explicit"])
|
||||
#expect(sink.entries.first?.metadata == ["child": "kept", "outer": "kept", "shared": "outer"])
|
||||
#expect(sink.entries.last?.metadata == ["child": "kept", "outer": "kept", "shared": "explicit"])
|
||||
}
|
||||
}
|
||||
@@ -66,6 +66,79 @@ struct CompatibilityTest {
|
||||
testLogging.history.assertExist(level: .error, message: "yes: error", source: "yes: error source")
|
||||
testLogging.history.assertExist(level: .critical, message: "yes: critical", source: "yes: critical source")
|
||||
}
|
||||
|
||||
/// A handler implementing only `log(event:)` must survive a caller on the SwiftLog 1.0
|
||||
/// entry point. Both deprecated defaults used to forward to each other.
|
||||
@available(*, deprecated, message: "Testing deprecated functionality")
|
||||
@Test func swiftLog1CompatibilityMethodReachesAnEventOnlyHandler() {
|
||||
let handler = EventOnlyLogHandler()
|
||||
|
||||
handler.log(
|
||||
level: .warning,
|
||||
message: "compat",
|
||||
metadata: ["k": "v"],
|
||||
file: "/Sources/CompatModule/Caller.swift",
|
||||
function: #function,
|
||||
line: 42
|
||||
)
|
||||
|
||||
let events = handler.recorded
|
||||
#expect(events.count == 1)
|
||||
#expect(events.first?.level == .warning)
|
||||
#expect(events.first?.message == "compat")
|
||||
#expect(events.first?.metadata == ["k": "v"])
|
||||
#expect(events.first?.source == "CompatModule")
|
||||
#expect(events.first?.line == 42)
|
||||
}
|
||||
|
||||
/// The same entry point must still reach a handler implementing only the
|
||||
/// source-carrying deprecated method.
|
||||
@available(*, deprecated, message: "Testing deprecated functionality")
|
||||
@Test func swiftLog1CompatibilityMethodReachesASourceOnlyHandler() {
|
||||
let testLogging = NewerButStillOldTestLogging()
|
||||
let handler = testLogging.make(label: "compat")
|
||||
|
||||
handler.log(
|
||||
level: .error,
|
||||
message: "compat",
|
||||
metadata: nil,
|
||||
file: "/Sources/CompatModule/Caller.swift",
|
||||
function: #function,
|
||||
line: 42
|
||||
)
|
||||
|
||||
testLogging.history.assertExist(level: .error, message: "compat", source: "CompatModule")
|
||||
}
|
||||
}
|
||||
|
||||
/// Implements `log(event:)` and nothing else.
|
||||
private struct EventOnlyLogHandler: LogHandler {
|
||||
private final class Store: @unchecked Sendable {
|
||||
private let lock = Lock()
|
||||
private var events: [LogEvent] = []
|
||||
func append(_ event: LogEvent) {
|
||||
self.lock.withLock { self.events.append(event) }
|
||||
}
|
||||
var all: [LogEvent] {
|
||||
self.lock.withLock { self.events }
|
||||
}
|
||||
}
|
||||
|
||||
private let store = Store()
|
||||
|
||||
var metadata: Logger.Metadata = [:]
|
||||
var logLevel: Logger.Level = .trace
|
||||
|
||||
subscript(metadataKey metadataKey: String) -> Logger.Metadata.Value? {
|
||||
get { self.metadata[metadataKey] }
|
||||
set { self.metadata[metadataKey] = newValue }
|
||||
}
|
||||
|
||||
func log(event: LogEvent) {
|
||||
self.store.append(event)
|
||||
}
|
||||
|
||||
var recorded: [LogEvent] { self.store.all }
|
||||
}
|
||||
|
||||
private struct OldSchoolTestLogging {
|
||||
|
||||
@@ -12,6 +12,7 @@
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import Foundation
|
||||
import Testing
|
||||
|
||||
@testable import Logging
|
||||
|
||||
@@ -1143,6 +1143,23 @@ struct LoggingTest {
|
||||
#expect(.error == logger1.logLevel)
|
||||
#expect(.trace == logger2.logLevel)
|
||||
}
|
||||
|
||||
@Test func loggerMetadataWriteMutatesHandlerInPlace() {
|
||||
var logger1 = Logger(label: "foo", factory: { _ in CopyCountingLogHandler() })
|
||||
for i in 0..<10 {
|
||||
logger1[metadataKey: "key\(i)"] = "\(i)"
|
||||
}
|
||||
#expect(logger1.handlerCopies == 0)
|
||||
|
||||
// The first write to a copy copies the handler once, later writes reuse that copy.
|
||||
var logger2 = logger1
|
||||
for i in 0..<10 {
|
||||
logger2[metadataKey: "key\(i)"] = "changed"
|
||||
}
|
||||
#expect(logger2.handlerCopies == 1)
|
||||
#expect(logger1.handlerCopies == 0)
|
||||
#expect(logger1[metadataKey: "key0"] == "0")
|
||||
}
|
||||
}
|
||||
|
||||
extension Logger {
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// This source file is part of the Swift Logging API open source project
|
||||
//
|
||||
// Copyright (c) 2026 Apple Inc. and the Swift Logging API project authors
|
||||
// Licensed under Apache License v2.0
|
||||
//
|
||||
// See LICENSE.txt for license information
|
||||
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
//
|
||||
//===----------------------------------------------------------------------===//
|
||||
|
||||
import Logging
|
||||
import Testing
|
||||
|
||||
@Suite
|
||||
struct MetadataValueTest {
|
||||
@Test
|
||||
func descriptionRendering() {
|
||||
#expect(Logger.MetadataValue.array([]).description == "[]")
|
||||
#expect(Logger.MetadataValue.array(["a", "b"]).description == ["a", "b"].description)
|
||||
|
||||
#expect(Logger.MetadataValue.dictionary([:]).description == "[:]")
|
||||
#expect(Logger.MetadataValue.dictionary(["k": "v"]).description == ["k": "v"].description)
|
||||
#expect(
|
||||
Logger.MetadataValue.dictionary(["outer": ["inner": "leaf"]]).description
|
||||
== "[\"outer\": [\"inner\": \"leaf\"]]"
|
||||
)
|
||||
}
|
||||
|
||||
@Test
|
||||
func equatableCompareson() {
|
||||
let lhs: Logger.MetadataValue = ["a": ["1", "2"]]
|
||||
let rhs: Logger.MetadataValue = ["a": ["1", "2"]]
|
||||
let different: Logger.MetadataValue = ["a": ["1", "3"]]
|
||||
|
||||
#expect(lhs == rhs)
|
||||
#expect(lhs != different)
|
||||
}
|
||||
|
||||
@Test
|
||||
func descriptionOfNestedArraysGrowsLinearlyNotExponentially() {
|
||||
var value: Logger.MetadataValue = .string("leaf")
|
||||
for _ in 0..<100 {
|
||||
value = .array([value])
|
||||
}
|
||||
// "leaf".debugDescription + each level adds a "[" and "]".
|
||||
#expect(value.description.count == 6 + 2 * 100)
|
||||
}
|
||||
|
||||
@Test
|
||||
func equatableComparesNestedArrays() {
|
||||
var lhs: Logger.MetadataValue = .string("leaf")
|
||||
var rhs: Logger.MetadataValue = .string("leaf")
|
||||
for _ in 0..<100 {
|
||||
lhs = .array([lhs])
|
||||
rhs = .array([rhs])
|
||||
}
|
||||
#expect(lhs == rhs)
|
||||
}
|
||||
}
|
||||
@@ -79,6 +79,20 @@ struct TaskLocalLoggerTest {
|
||||
logging.history.assertExist(level: .info, message: "merged", metadata: ["key": "value"])
|
||||
}
|
||||
|
||||
@Test func mergeMetadataCopiesHandlerOnce() {
|
||||
let logger = Logger(label: "test", factory: { _ in CopyCountingLogHandler() })
|
||||
let metadata: Logger.Metadata = ["a": "1", "b": "2", "c": "3", "d": "4", "e": "5"]
|
||||
|
||||
withLogger(logger) { _ in
|
||||
withLogger(mergingMetadata: metadata) { inner in
|
||||
#expect(inner.handler.metadata == metadata)
|
||||
#expect(inner.handlerCopies == 1)
|
||||
}
|
||||
#expect(Logger.current.handler.metadata.isEmpty)
|
||||
#expect(Logger.current.handlerCopies == 0)
|
||||
}
|
||||
}
|
||||
|
||||
@Test func overrideLogLevel() {
|
||||
let logging = TestLogging()
|
||||
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
|
||||
@@ -191,6 +205,59 @@ struct TaskLocalLoggerTest {
|
||||
outer.history.assertNotExist(level: .info, message: "emitted under inner handler")
|
||||
}
|
||||
|
||||
@Test(arguments: [Logger.Level.debug, .warning])
|
||||
func handlerSwapRespectsExplicitLogLevel(level: Logger.Level) {
|
||||
let outer = TestLogging()
|
||||
let inner = TestLogging()
|
||||
var appLogger = Logger(label: "app", factory: { outer.make(label: $0) })
|
||||
appLogger.logLevel = .critical
|
||||
var replacement = inner.make(label: "captured")
|
||||
replacement.logLevel = .info
|
||||
let suppressedLevel: Logger.Level = level == .debug ? .trace : .info
|
||||
|
||||
withLogger(appLogger) { _ in
|
||||
withLogger(logLevel: level, handler: replacement) { scoped in
|
||||
#expect(scoped.logLevel == level)
|
||||
#expect(Logger.current.logLevel == level)
|
||||
scoped.log(level: level, "emitted")
|
||||
Logger.current.log(level: suppressedLevel, "suppressed")
|
||||
}
|
||||
#expect(Logger.current.logLevel == .critical)
|
||||
}
|
||||
|
||||
#expect(replacement.logLevel == .info)
|
||||
inner.history.assertExist(level: level, message: "emitted")
|
||||
inner.history.assertNotExist(level: suppressedLevel, message: "suppressed")
|
||||
outer.history.assertNotExist(level: level, message: "emitted")
|
||||
}
|
||||
|
||||
@Test(arguments: [Logger.Level.debug, .warning])
|
||||
func asyncHandlerSwapRespectsExplicitLogLevel(level: Logger.Level) async {
|
||||
let outer = TestLogging()
|
||||
let inner = TestLogging()
|
||||
var appLogger = Logger(label: "app", factory: { outer.make(label: $0) })
|
||||
appLogger.logLevel = .critical
|
||||
var replacement = inner.make(label: "captured")
|
||||
replacement.logLevel = .info
|
||||
let suppressedLevel: Logger.Level = level == .debug ? .trace : .info
|
||||
|
||||
await withLogger(appLogger) { _ in
|
||||
await withLogger(logLevel: level, handler: replacement) { scoped in
|
||||
await Task.yield()
|
||||
#expect(scoped.logLevel == level)
|
||||
#expect(Logger.current.logLevel == level)
|
||||
scoped.log(level: level, "emitted")
|
||||
Logger.current.log(level: suppressedLevel, "suppressed")
|
||||
}
|
||||
#expect(Logger.current.logLevel == .critical)
|
||||
}
|
||||
|
||||
#expect(replacement.logLevel == .info)
|
||||
inner.history.assertExist(level: level, message: "emitted")
|
||||
inner.history.assertNotExist(level: suppressedLevel, message: "suppressed")
|
||||
outer.history.assertNotExist(level: level, message: "emitted")
|
||||
}
|
||||
|
||||
@Test func siblingScopesAreIsolated() {
|
||||
let logging = TestLogging()
|
||||
let logger = Logger(label: "test", factory: { logging.make(label: $0) })
|
||||
|
||||
@@ -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 {}
|
||||
@@ -0,0 +1,22 @@
|
||||
#===----------------------------------------------------------------------===#
|
||||
#
|
||||
# This source file is part of the Swift Logging API open source project
|
||||
#
|
||||
# Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
# Licensed under Apache License v2.0
|
||||
#
|
||||
# See LICENSE.txt for license information
|
||||
# See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
#
|
||||
#===----------------------------------------------------------------------===#
|
||||
|
||||
set(SwiftLog_EXPORTS_FILE ${CMAKE_CURRENT_BINARY_DIR}/SwiftLogExports.cmake)
|
||||
|
||||
configure_file(SwiftLogConfig.cmake.in
|
||||
${CMAKE_CURRENT_BINARY_DIR}/SwiftLogConfig.cmake)
|
||||
|
||||
get_property(SwiftLog_EXPORTS GLOBAL PROPERTY SwiftLog_EXPORTS)
|
||||
export(TARGETS ${SwiftLog_EXPORTS}
|
||||
FILE ${SwiftLog_EXPORTS_FILE})
|
||||
@@ -0,0 +1,17 @@
|
||||
##===----------------------------------------------------------------------===##
|
||||
##
|
||||
## This source file is part of the Swift Logging API open source project
|
||||
##
|
||||
## Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
## Licensed under Apache License v2.0
|
||||
##
|
||||
## See LICENSE.txt for license information
|
||||
## See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
##
|
||||
## SPDX-License-Identifier: Apache-2.0
|
||||
##
|
||||
##===----------------------------------------------------------------------===##
|
||||
|
||||
if(NOT TARGET Logging)
|
||||
include(@SwiftLog_EXPORTS_FILE@)
|
||||
endif()
|
||||
@@ -0,0 +1,80 @@
|
||||
##===----------------------------------------------------------------------===##
|
||||
##
|
||||
## This source file is part of the Swift Logging API open source project
|
||||
##
|
||||
## Copyright (c) 2018-2026 Apple Inc. and the Swift Logging API project authors
|
||||
## Licensed under Apache License v2.0
|
||||
##
|
||||
## See LICENSE.txt for license information
|
||||
## See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
||||
##
|
||||
## SPDX-License-Identifier: Apache-2.0
|
||||
##
|
||||
##===----------------------------------------------------------------------===##
|
||||
|
||||
# Returns the os name in a variable
|
||||
#
|
||||
# Usage:
|
||||
# get_swift_host_os(result_var_name)
|
||||
#
|
||||
#
|
||||
# Sets ${result_var_name} with the converted OS name derived from
|
||||
# CMAKE_SYSTEM_NAME.
|
||||
function(get_swift_host_os result_var_name)
|
||||
if(CMAKE_SYSTEM_NAME STREQUAL Darwin)
|
||||
set(${result_var_name} macosx PARENT_SCOPE)
|
||||
else()
|
||||
string(TOLOWER ${CMAKE_SYSTEM_NAME} cmake_system_name_lc)
|
||||
set(${result_var_name} ${cmake_system_name_lc} PARENT_SCOPE)
|
||||
endif()
|
||||
endfunction()
|
||||
|
||||
if(NOT Swift_MODULE_TRIPLE)
|
||||
# Attempt to get the module triple from the Swift compiler.
|
||||
set(module_triple_command "${CMAKE_Swift_COMPILER}" -print-target-info)
|
||||
if(CMAKE_Swift_COMPILER_TARGET)
|
||||
list(APPEND module_triple_command -target ${CMAKE_Swift_COMPILER_TARGET})
|
||||
endif()
|
||||
execute_process(COMMAND ${module_triple_command}
|
||||
OUTPUT_VARIABLE target_info_json)
|
||||
string(JSON module_triple GET "${target_info_json}" "target" "moduleTriple")
|
||||
|
||||
# Exit now if we failed to infer the triple.
|
||||
if(NOT module_triple)
|
||||
message(FATAL_ERROR
|
||||
"Failed to get module triple from Swift compiler. "
|
||||
"Compiler output: ${target_info_json}")
|
||||
endif()
|
||||
|
||||
# Cache the module triple for future use.
|
||||
set(Swift_MODULE_TRIPLE "${module_triple}" CACHE STRING "swift module triple used for installed swiftmodule and swiftinterface files")
|
||||
mark_as_advanced(Swift_MODULE_TRIPLE)
|
||||
endif()
|
||||
|
||||
function(_install_target module)
|
||||
get_swift_host_os(swift_os)
|
||||
get_target_property(type ${module} TYPE)
|
||||
|
||||
if(type STREQUAL STATIC_LIBRARY)
|
||||
set(swift swift_static)
|
||||
else()
|
||||
set(swift swift)
|
||||
endif()
|
||||
|
||||
install(TARGETS ${module})
|
||||
if(type STREQUAL EXECUTABLE)
|
||||
return()
|
||||
endif()
|
||||
|
||||
get_target_property(module_name ${module} Swift_MODULE_NAME)
|
||||
if(NOT module_name)
|
||||
set(module_name ${module})
|
||||
endif()
|
||||
|
||||
install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftdoc
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/${swift}/${swift_os}/${module_name}.swiftmodule
|
||||
RENAME ${Swift_MODULE_TRIPLE}.swiftdoc)
|
||||
install(FILES $<TARGET_PROPERTY:${module},Swift_MODULE_DIRECTORY>/${module_name}.swiftmodule
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/${swift}/${swift_os}/${module_name}.swiftmodule
|
||||
RENAME ${Swift_MODULE_TRIPLE}.swiftmodule)
|
||||
endfunction()
|
||||
Reference in new issue
Block a user