minor readme change

Author: ktoso

README.md

@@ -189,7 +189,7 @@ You may want to restore the context once around both those calls, or if that is
 actor MySampleServer { 
 
   var context: ServiceContext = .topLevel
-  var userCode: SampleHTTPHandler
+  var userHandler: SampleHTTPHandler
 
   func onHeaders(headers: HTTPHeaders) async {
     await ServiceContext.withValue(self.context) { 

Sources/Tracing/Docs.docc/Guides/InstrumentYourLibrary.md

@@ -4,9 +4,9 @@
 
 ### Creating Spans
 
-- ``withSpan(_:baggage:ofKind:at:function:file:line:_:)-4o2b``
+- ``withSpan(_:context:ofKind:at:function:file:line:_:)-4o2b``
 
 ### Manual Span management
 
-- ``startSpan(_:baggage:ofKind:at:function:file:line:)-u1y4``
+- ``startSpan(_:context:ofKind:at:function:file:line:)-u1y4``
 - ``Span/end()``

Sources/Tracing/Docs.docc/Tracer.md

@@ -101,7 +101,7 @@ extension NoOpTracer: Tracer {
         file fileID: String,
         line: UInt
     ) -> NoOpSpan {
-        NoOpSpan(baggage: baggage())
+        NoOpSpan(context: context())
     }
 }
 #endif

Sources/Tracing/NoOpTracer.swift

@@ -697,18 +697,18 @@ public enum SpanKind {
 /// further describe the link.
 public struct SpanLink {
     /// A `ServiceContext` containing identifying information about the link target ``Span``.
-    public let baggage: ServiceContext
+    public let context: ServiceContext
 
     /// ``SpanAttributes`` further describing the connection between the ``Span``s.
     public let attributes: SpanAttributes
 
     /// Create a new `SpanLink`.
     ///
     /// - Parameters:
-    ///   - baggage: The `ServiceContext` identifying the targeted ``Span``.
+    ///   - context: The `ServiceContext` identifying the targeted ``Span``.
     ///   - attributes: ``SpanAttributes`` that further describe the link. Defaults to no attributes.
-    public init(baggage: ServiceContext, attributes: SpanAttributes) {
-        self.baggage = baggage
+    public init(context: ServiceContext, attributes: SpanAttributes) {
+        self.context = context
         self.attributes = attributes
     }
 }

Sources/Tracing/SpanProtocol.swift

@@ -100,7 +100,7 @@ public func startSpan(
     InstrumentationSystem.legacyTracer.startAnySpan(
         operationName,
         at: DefaultTracerClock.now,
-        context: baggage(),
+        context: context(),
         ofKind: kind,
         function: function,
         file: fileID,
@@ -112,12 +112,12 @@ public func startSpan(
 /// Start a new ``Span`` using the global bootstrapped tracer reimplementation.
 ///
 /// The current task-local `ServiceContext` is picked up and provided to the underlying tracer.
-/// It is also possible to pass a specific `baggage` explicitly, in which case attempting
-/// to pick up the task-local baggage is prevented. This can be useful when we know that
+/// It is also possible to pass a specific `context` explicitly, in which case attempting
+/// to pick up the task-local context is prevented. This can be useful when we know that
 /// we're about to start a top-level span, or if a span should be started from a different,
 /// stored away previously,
 ///
-/// - Note: Prefer ``withSpan(_:baggage:ofKind:at:function:file:line:_:)-4o2b`` to start
+/// - Note: Prefer ``withSpan(_:context:ofKind:at:function:file:line:_:)-4o2b`` to start
 ///   a span as it automatically takes care of ending the span, and recording errors when thrown.
 ///   Use `startSpan` iff you need to pass the span manually to a different
 ///   location in your source code to end it.
@@ -127,7 +127,7 @@ public func startSpan(
 ///
 /// - Parameters:
 ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
-///   - baggage: The `ServiceContext` providing information on where to start the new ``Span``.
+///   - context: The `ServiceContext` providing information on where to start the new ``Span``.
 ///   - kind: The ``SpanKind`` of the new ``Span``.
 ///   - instant: the time instant at which the span started
 ///   - function: The function name in which the span was started
@@ -136,7 +136,7 @@ public func startSpan(
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal ServiceContext
 public func startSpan(
     _ operationName: String,
-    baggage: @autoclosure () -> ServiceContext = .current ?? .topLevel,
+    context: @autoclosure () -> ServiceContext = .current ?? .topLevel,
     ofKind kind: SpanKind = .internal,
     at instant: @autoclosure () -> some TracerInstant = DefaultTracerClock.now,
     function: String = #function,
@@ -148,7 +148,7 @@ public func startSpan(
     InstrumentationSystem.tracer.startAnySpan(
         operationName,
         at: instant(),
-        baggage: baggage(),
+        context: context(),
         ofKind: kind,
         function: function,
         file: fileID,
@@ -163,8 +163,8 @@ public func startSpan(
 /// including recording the `error` in case the operation throws.
 ///
 /// The current task-local `ServiceContext` is picked up and provided to the underlying tracer.
-/// It is also possible to pass a specific `baggage` explicitly, in which case attempting
-/// to pick up the task-local baggage is prevented. This can be useful when we know that
+/// It is also possible to pass a specific `context` explicitly, in which case attempting
+/// to pick up the task-local context is prevented. This can be useful when we know that
 /// we're about to start a top-level span, or if a span should be started from a different,
 /// stored away previously,
 ///
@@ -174,7 +174,7 @@ public func startSpan(
 /// - Parameters:
 ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
 ///   - instant: the time instant at which the span started
-///   - baggage: The `ServiceContext` providing information on where to start the new ``Span``.
+///   - context: The `ServiceContext` providing information on where to start the new ``Span``.
 ///   - kind: The ``SpanKind`` of the new ``Span``.
 ///   - function: The function name in which the span was started
 ///   - fileID: The `fileID` where the span was started.
@@ -186,7 +186,7 @@ public func startSpan(
 public func withSpan<T, Instant: TracerInstant>(
     _ operationName: String,
     at instant: @autoclosure () -> Instant,
-    baggage: @autoclosure () -> ServiceContext = .current ?? .topLevel,
+    context: @autoclosure () -> ServiceContext = .current ?? .topLevel,
     ofKind kind: SpanKind = .internal,
     function: String = #function,
     file fileID: String = #fileID,
@@ -196,7 +196,7 @@ public func withSpan<T, Instant: TracerInstant>(
     try InstrumentationSystem.legacyTracer.withAnySpan(
         operationName,
         at: DefaultTracerClock.now,
-        baggage: baggage(),
+        context: context(),
         ofKind: kind,
         function: function,
         file: fileID,
@@ -210,8 +210,8 @@ public func withSpan<T, Instant: TracerInstant>(
 /// including recording the `error` in case the operation throws.
 ///
 /// The current task-local `ServiceContext` is picked up and provided to the underlying tracer.
-/// It is also possible to pass a specific `baggage` explicitly, in which case attempting
-/// to pick up the task-local baggage is prevented. This can be useful when we know that
+/// It is also possible to pass a specific `context` explicitly, in which case attempting
+/// to pick up the task-local context is prevented. This can be useful when we know that
 /// we're about to start a top-level span, or if a span should be started from a different,
 /// stored away previously,
 ///
@@ -220,7 +220,7 @@ public func withSpan<T, Instant: TracerInstant>(
 ///
 /// - Parameters:
 ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
-///   - baggage: The `ServiceContext` providing information on where to start the new ``Span``.
+///   - context: The `ServiceContext` providing information on where to start the new ``Span``.
 ///   - kind: The ``SpanKind`` of the new ``Span``.
 ///   - function: The function name in which the span was started
 ///   - fileID: The `fileID` where the span was started.
@@ -231,7 +231,7 @@ public func withSpan<T, Instant: TracerInstant>(
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal ServiceContext
 public func withSpan<T>(
     _ operationName: String,
-    baggage: @autoclosure () -> ServiceContext = .current ?? .topLevel,
+    context: @autoclosure () -> ServiceContext = .current ?? .topLevel,
     ofKind kind: SpanKind = .internal,
     function: String = #function,
     file fileID: String = #fileID,
@@ -241,7 +241,7 @@ public func withSpan<T>(
     try InstrumentationSystem.legacyTracer.withAnySpan(
         operationName,
         at: DefaultTracerClock.now,
-        baggage: baggage(),
+        context: context(),
         ofKind: kind,
         function: function,
         file: fileID,
@@ -257,8 +257,8 @@ public func withSpan<T>(
 /// including recording the `error` in case the operation throws.
 ///
 /// The current task-local `ServiceContext` is picked up and provided to the underlying tracer.
-/// It is also possible to pass a specific `baggage` explicitly, in which case attempting
-/// to pick up the task-local baggage is prevented. This can be useful when we know that
+/// It is also possible to pass a specific `context` explicitly, in which case attempting
+/// to pick up the task-local context is prevented. This can be useful when we know that
 /// we're about to start a top-level span, or if a span should be started from a different,
 /// stored away previously,
 ///
@@ -268,7 +268,7 @@ public func withSpan<T>(
 /// - Parameters:
 ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
 ///   - instant: the time instant at which the span started
-///   - baggage: The `ServiceContext` providing information on where to start the new ``Span``.
+///   - context: The `ServiceContext` providing information on where to start the new ``Span``.
 ///   - kind: The ``SpanKind`` of the new ``Span``.
 ///   - function: The function name in which the span was started
 ///   - fileID: The `fileID` where the span was started.
@@ -278,7 +278,7 @@ public func withSpan<T>(
 /// - Throws: the error the `operation` has thrown (if any)
 public func withSpan<T>(
     _ operationName: String,
-    baggage: @autoclosure () -> ServiceContext = .current ?? .topLevel,
+    context: @autoclosure () -> ServiceContext = .current ?? .topLevel,
     ofKind kind: SpanKind = .internal,
     at instant: @autoclosure () -> some TracerInstant = DefaultTracerClock.now,
     function: String = #function,
@@ -289,7 +289,7 @@ public func withSpan<T>(
     try InstrumentationSystem.legacyTracer.withAnySpan(
         operationName,
         at: instant(),
-        baggage: baggage(),
+        context: context(),
         ofKind: kind,
         function: function,
         file: fileID,
@@ -306,8 +306,8 @@ public func withSpan<T>(
 /// including recording the `error` in case the operation throws.
 ///
 /// The current task-local `ServiceContext` is picked up and provided to the underlying tracer.
-/// It is also possible to pass a specific `baggage` explicitly, in which case attempting
-/// to pick up the task-local baggage is prevented. This can be useful when we know that
+/// It is also possible to pass a specific `context` explicitly, in which case attempting
+/// to pick up the task-local context is prevented. This can be useful when we know that
 /// we're about to start a top-level span, or if a span should be started from a different,
 /// stored away previously,
 ///
@@ -317,7 +317,7 @@ public func withSpan<T>(
 /// - Parameters:
 ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
 ///   - instant: the time instant at which the span started
-///   - baggage: The `ServiceContext` providing information on where to start the new ``Span``.
+///   - context: The `ServiceContext` providing information on where to start the new ``Span``.
 ///   - kind: The ``SpanKind`` of the new ``Span``.
 ///   - function: The function name in which the span was started
 ///   - fileID: The `fileID` where the span was started.
@@ -329,7 +329,7 @@ public func withSpan<T>(
 public func withSpan<T, Instant: TracerInstant>(
     _ operationName: String,
     at instant: @autoclosure () -> Instant,
-    baggage: @autoclosure () -> ServiceContext = .current ?? .topLevel,
+    context: @autoclosure () -> ServiceContext = .current ?? .topLevel,
     ofKind kind: SpanKind = .internal,
     function: String = #function,
     file fileID: String = #fileID,
@@ -339,7 +339,7 @@ public func withSpan<T, Instant: TracerInstant>(
     try await InstrumentationSystem.legacyTracer.withAnySpan(
         operationName,
         at: DefaultTracerClock.now,
-        baggage: baggage(),
+        context: context(),
         ofKind: kind,
         function: function,
         file: fileID,
@@ -353,8 +353,8 @@ public func withSpan<T, Instant: TracerInstant>(
 /// including recording the `error` in case the operation throws.
 ///
 /// The current task-local `ServiceContext` is picked up and provided to the underlying tracer.
-/// It is also possible to pass a specific `baggage` explicitly, in which case attempting
-/// to pick up the task-local baggage is prevented. This can be useful when we know that
+/// It is also possible to pass a specific `context` explicitly, in which case attempting
+/// to pick up the task-local context is prevented. This can be useful when we know that
 /// we're about to start a top-level span, or if a span should be started from a different,
 /// stored away previously,
 ///
@@ -363,7 +363,7 @@ public func withSpan<T, Instant: TracerInstant>(
 ///
 /// - Parameters:
 ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
-///   - baggage: The `ServiceContext` providing information on where to start the new ``Span``.
+///   - context: The `ServiceContext` providing information on where to start the new ``Span``.
 ///   - kind: The ``SpanKind`` of the new ``Span``.
 ///   - function: The function name in which the span was started
 ///   - fileID: The `fileID` where the span was started.
@@ -374,7 +374,7 @@ public func withSpan<T, Instant: TracerInstant>(
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal ServiceContext
 public func withSpan<T>(
     _ operationName: String,
-    baggage: @autoclosure () -> ServiceContext = .current ?? .topLevel,
+    context: @autoclosure () -> ServiceContext = .current ?? .topLevel,
     ofKind kind: SpanKind = .internal,
     function: String = #function,
     file fileID: String = #fileID,
@@ -384,7 +384,7 @@ public func withSpan<T>(
     try await InstrumentationSystem.legacyTracer.withAnySpan(
         operationName,
         at: DefaultTracerClock.now,
-        baggage: baggage(),
+        context: context(),
         ofKind: kind,
         function: function,
         file: fileID,
@@ -399,8 +399,8 @@ public func withSpan<T>(
 /// including recording the `error` in case the operation throws.
 ///
 /// The current task-local `ServiceContext` is picked up and provided to the underlying tracer.
-/// It is also possible to pass a specific `baggage` explicitly, in which case attempting
-/// to pick up the task-local baggage is prevented. This can be useful when we know that
+/// It is also possible to pass a specific `context` explicitly, in which case attempting
+/// to pick up the task-local context is prevented. This can be useful when we know that
 /// we're about to start a top-level span, or if a span should be started from a different,
 /// stored away previously,
 ///
@@ -409,7 +409,7 @@ public func withSpan<T>(
 ///
 /// - Parameters:
 ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
-///   - baggage: The `ServiceContext` providing information on where to start the new ``Span``.
+///   - context: The `ServiceContext` providing information on where to start the new ``Span``.
 ///   - kind: The ``SpanKind`` of the new ``Span``.
 ///   - instant: the time instant at which the span started
 ///   - function: The function name in which the span was started
@@ -420,7 +420,7 @@ public func withSpan<T>(
 /// - Throws: the error the `operation` has thrown (if any)
 public func withSpan<T>(
     _ operationName: String,
-    baggage: @autoclosure () -> ServiceContext = .current ?? .topLevel,
+    context: @autoclosure () -> ServiceContext = .current ?? .topLevel,
     ofKind kind: SpanKind = .internal,
     at instant: @autoclosure () -> some TracerInstant = DefaultTracerClock.now,
     function: String = #function,
@@ -431,7 +431,7 @@ public func withSpan<T>(
     try await InstrumentationSystem.legacyTracer.withAnySpan(
         operationName,
         at: instant(),
-        baggage: baggage(),
+        context: context(),
         ofKind: kind,
         function: function,
         file: fileID,