Use dependency-free Baggage module (#52)

apple · Aug 24, 2021 · 7a89c90 · 7a89c90
1 parent df632ad
commit 7a89c90
Show file tree

Hide file tree

Showing 81 changed files with 527 additions and 1,757 deletions.
diff --git a/.swiftformat b/.swiftformat
@@ -1,6 +1,6 @@
 # file options
 
---swiftversion 5.0
+--swiftversion 5.2
 --exclude .build
 --exclude Tests/LinuxMain.swift
 --exclude **/*Tests+XCTest.swift
@@ -12,6 +12,7 @@
 --self insert
 --stripunusedargs closure-only
 --wraparguments before-first
+--extensionacl on-declarations
 
 # rules
 

diff --git a/IntegrationTests/allocation-counter-tests-framework/run-allocation-counter.sh b/IntegrationTests/allocation-counter-tests-framework/run-allocation-counter.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/...ter-tests-framework/template/AtomicCounter/Sources/AtomicCounter/include/atomic-counter.h b/...ter-tests-framework/template/AtomicCounter/Sources/AtomicCounter/include/atomic-counter.h
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/...counter-tests-framework/template/AtomicCounter/Sources/AtomicCounter/src/atomic-counter.c b/...counter-tests-framework/template/AtomicCounter/Sources/AtomicCounter/src/atomic-counter.c
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/...amework/template/HookedFunctionsDoHook/Sources/HookedFunctions/include/hooked-functions.h b/...amework/template/HookedFunctionsDoHook/Sources/HookedFunctions/include/hooked-functions.h
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/...s-framework/template/HookedFunctionsDoHook/Sources/HookedFunctions/src/hooked-functions.c b/...s-framework/template/HookedFunctionsDoHook/Sources/HookedFunctions/src/hooked-functions.c
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/...work/template/HookedFunctionsDoNotHook/Sources/HookedFunctions/include/hooked-functions.h b/...work/template/HookedFunctionsDoNotHook/Sources/HookedFunctions/include/hooked-functions.h
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/...ramework/template/HookedFunctionsDoNotHook/Sources/HookedFunctions/src/hooked-functions.c b/...ramework/template/HookedFunctionsDoNotHook/Sources/HookedFunctions/src/hooked-functions.c
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/IntegrationTests/allocation-counter-tests-framework/template/Sources/bootstrapDoHook/main.c b/IntegrationTests/allocation-counter-tests-framework/template/Sources/bootstrapDoHook/main.c
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/...rationTests/allocation-counter-tests-framework/template/Sources/bootstrapDoNotHook/main.c b/...rationTests/allocation-counter-tests-framework/template/Sources/bootstrapDoNotHook/main.c
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/IntegrationTests/allocation-counter-tests-framework/template/scaffolding.swift b/IntegrationTests/allocation-counter-tests-framework/template/scaffolding.swift
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information

diff --git a/IntegrationTests/plugin_echo.sh b/IntegrationTests/plugin_echo.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/IntegrationTests/plugin_junit_xml.sh b/IntegrationTests/plugin_junit_xml.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/IntegrationTests/run-single-test.sh b/IntegrationTests/run-single-test.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/IntegrationTests/run-tests.sh b/IntegrationTests/run-tests.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/IntegrationTests/test_functions.sh b/IntegrationTests/test_functions.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/IntegrationTests/tests_01_performance/defines.sh b/IntegrationTests/tests_01_performance/defines.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/IntegrationTests/tests_01_performance/test_01_allocation_counts.sh b/IntegrationTests/tests_01_performance/test_01_allocation_counts.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/IntegrationTests/tests_01_performance/test_01_resources/run-nio-alloc-counter-tests.sh b/IntegrationTests/tests_01_performance/test_01_resources/run-nio-alloc-counter-tests.sh
@@ -3,7 +3,8 @@
 ##
 ## This source file is part of the Swift Distributed Tracing open source project
 ##
-## Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+## Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+## authors
 ## Licensed under Apache License v2.0
 ##
 ## See LICENSE.txt for license information

diff --git a/IntegrationTests/tests_01_performance/test_01_resources/shared.swift b/IntegrationTests/tests_01_performance/test_01_resources/shared.swift
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -25,8 +26,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Baggage
 import Foundation
+import InstrumentationBaggage
 
 @inline(never)
 func take1(context: BaggageContext) -> Int {

diff --git a/...ts/tests_01_performance/test_01_resources/test_001_pass_around_static_strings_small.swift b/...ts/tests_01_performance/test_01_resources/test_001_pass_around_static_strings_small.swift
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -25,7 +26,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Baggage
+import InstrumentationBaggage
 
 func run(identifier: String) {
     measure(identifier: identifier) {

diff --git a/...ts/tests_01_performance/test_01_resources/test_002_pass_around_static_strings_large.swift b/...ts/tests_01_performance/test_01_resources/test_002_pass_around_static_strings_large.swift
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -25,7 +26,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import Baggage
+import InstrumentationBaggage
 
 func run(identifier: String) {
     measure(identifier: identifier) {

diff --git a/Package.swift b/Package.swift
@@ -1,15 +1,14 @@
-// swift-tools-version:5.0
+// swift-tools-version:5.2
 import PackageDescription
 
 let package = Package(
     name: "swift-distributed-tracing",
     products: [
         .library(name: "Instrumentation", targets: ["Instrumentation"]),
         .library(name: "Tracing", targets: ["Tracing"]),
-        .library(name: "TracingOpenTelemetrySupport", targets: ["TracingOpenTelemetrySupport"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", from: "0.1.1")
+        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.2.0")),
     ],
     targets: [
         // ==== --------------------------------------------------------------------------------------------------------
@@ -18,13 +17,13 @@ let package = Package(
         .target(
             name: "Instrumentation",
             dependencies: [
-                "Baggage",
+                .product(name: "InstrumentationBaggage", package: "swift-distributed-tracing-baggage"),
             ]
         ),
         .testTarget(
             name: "InstrumentationTests",
             dependencies: [
-                "Instrumentation",
+                .target(name: "Instrumentation"),
             ]
         ),
 
@@ -34,29 +33,13 @@ let package = Package(
         .target(
             name: "Tracing",
             dependencies: [
-                "Instrumentation",
+                .target(name: "Instrumentation"),
             ]
         ),
         .testTarget(
             name: "TracingTests",
             dependencies: [
-                "Tracing",
-            ]
-        ),
-
-        // ==== ----------------------------------------------------------------------------------------------------------------
-        // MARK: Support libraries
-
-        .target(
-            name: "TracingOpenTelemetrySupport",
-            dependencies: [
-                "Tracing"
-            ]
-        ),
-        .testTarget(
-            name: "TracingOpenTelemetrySupportTests",
-            dependencies: [
-                "TracingOpenTelemetrySupport",
+                .target(name: "Tracing"),
             ]
         ),
 
@@ -66,10 +49,9 @@ let package = Package(
         .target(
             name: "_TracingBenchmarks",
             dependencies: [
-                "Baggage",
-                "Tracing",
-                "TracingOpenTelemetrySupport",
-                "_TracingBenchmarkTools",
+                .product(name: "InstrumentationBaggage", package: "swift-distributed-tracing-baggage"),
+                .target(name: "Tracing"),
+                .target(name: "_TracingBenchmarkTools"),
             ]
         ),
         .target(

diff --git a/README.md b/README.md
@@ -9,24 +9,9 @@ While Swift Distributed Tracing allows building all kinds of _instruments_, whic
 
 ---
 
-This project uses the context progagation types defined independently in:
+This project uses the context progagation type defined independently in:
 
-- 🧳 [swift-distributed-tracing-baggage](https://github.com/apple/swift-distributed-tracing-baggage) -- [`LoggingContext`](https://apple.github.io/swift-distributed-tracing-baggage/docs/current/Baggage/Protocols/LoggingContext.html) (Swift Log dependency)
-- 🧳 [swift-distributed-tracing-baggage-core](https://github.com/apple/swift-distributed-tracing-baggage-core) -- defining [`Baggage`](https://apple.github.io/swift-distributed-tracing-baggage-core/docs/current/CoreBaggage/Structs/Baggage.html) (zero dependencies)
-
----
-
-### Important note on Adoption
-
-> ⚠️  ⚠️  ⚠️
->
-> We anticipate the upcoming [Swift Concurrency](https://forums.swift.org/t/swift-concurrency-roadmap/41611) features to have significant impact on the usage of these APIs, if task-local values **(proposal coming soon)** are accepted into the language.
-> 
-> As such, we advice to adopt these APIs carefully, and offer them _optionally_, i.e. provide defaulted values for context parameters such that users do not necessarily have to use them – because the upcoming Swift Concurrency story should enable APIs to gain automatic context propagation using task locals (if the proposal were to be accepted).
-> 
-> At this point in time we would like to focus on Tracer implementations, final API polish and adoption in "glue" libraries between services, such as AsyncHTTPClient, gRPC and similar APIs.
->
-> ⚠️  ⚠️  ⚠️
+- 🧳 [swift-distributed-tracing-baggage](https://github.com/apple/swift-distributed-tracing-baggage) -- [`Baggage`](https://apple.github.io/swift-distributed-tracing-baggage/docs/current/InstrumentationBaggage/Structs/Baggage.html) (zero dependencies)
 
 ---
 
@@ -579,7 +564,7 @@ When creating a tracer you need to create two types:
 ```swift
 import Tracing
 
-private enum TraceIDKey: Baggage.Key {
+private enum TraceIDKey: BaggageKey {
   typealias Value = String
 }
 

diff --git a/Sources/Instrumentation/Instrument.swift b/Sources/Instrumentation/Instrument.swift
@@ -2,7 +2,8 @@
 //
 // This source file is part of the Swift Distributed Tracing open source project
 //
-// Copyright (c) 2020 Apple Inc. and the Swift Distributed Tracing project authors
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -11,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import CoreBaggage
+import InstrumentationBaggage
 
 /// Conforming types are used to extract values from a specific `Carrier`.
 public protocol Extractor {