Use ServiceContext instead of Baggage (#59)

Package.swift

@@ -9,7 +9,7 @@ let package = Package(
         .library(name: "OtlpGRPCSpanExporting", targets: ["OtlpGRPCSpanExporting"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-distributed-tracing.git", from: "1.0.0-beta.2"),
+        .package(url: "https://github.com/apple/swift-distributed-tracing.git", from: "1.0.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.5.1"),
         .package(url: "https://github.com/apple/swift-nio.git", from: "2.43.0"),
         .package(url: "https://github.com/grpc/grpc-swift.git", from: "1.0.0"),

README.md

@@ -131,15 +131,15 @@ Our demo application creates two spans: `hello` and `world`. To make things even
 the `hello` span:
 
 ```swift
-let rootSpan = InstrumentationSystem.tracer.startSpan("hello", baggage: .topLevel)
+let rootSpan = InstrumentationSystem.tracer.startSpan("hello", context: .topLevel)
 
 sleep(1)
 rootSpan.addEvent(SpanEvent(
     name: "Discovered the meaning of life",
     attributes: ["meaning_of_life": 42]
 ))
 
-let childSpan = InstrumentationSystem.tracer.startSpan("world", baggage: rootSpan.baggage)
+let childSpan = InstrumentationSystem.tracer.startSpan("world", context: rootSpan.context)
 
 sleep(1)
 childSpan.end()

Sources/OpenTelemetry/Logging/MetadataProvider+OTel.swift

@@ -11,8 +11,8 @@
 //
 //===----------------------------------------------------------------------===//
 
-import InstrumentationBaggage
 import Logging
+import ServiceContextModule
 
 @available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
 extension Logger.MetadataProvider {
@@ -24,7 +24,7 @@ extension Logger.MetadataProvider {
     /// - Returns: A metadata provider ready to use with Logging.
     public static func otel(traceIDKey: String = "trace-id", spanIDKey: String = "span-id") -> Logger.MetadataProvider {
         .init {
-            guard let spanContext = Baggage.current?.spanContext else { return [:] }
+            guard let spanContext = ServiceContext.current?.spanContext else { return [:] }
             return [
                 traceIDKey: "\(spanContext.traceID)",
                 spanIDKey: "\(spanContext.spanID)",

Sources/OpenTelemetry/Processing/SimpleSpanProcessor.swift

@@ -27,7 +27,7 @@ extension OTel {
         }
 
         public func processEndedSpan(_ span: OTel.RecordedSpan) {
-            guard span.context.traceFlags.contains(.sampled) else { return }
+            guard span.spanContext.traceFlags.contains(.sampled) else { return }
             _ = exporter.export([span])
         }
 

Sources/OpenTelemetry/RecordedSpan.swift

@@ -26,12 +26,12 @@ extension OTel {
         public let status: SpanStatus?
 
         /// The context of this span.
-        public let context: OTel.SpanContext
+        public let spanContext: OTel.SpanContext
 
-        /// The baggage propagated with this span.
+        /// The service context propagated with this span.
         ///
-        /// - Note: This `Baggage` doesn't contain the `OTel.SpanContext` as that's already unwrapped and accessible through `self.context`.
-        public let baggage: Baggage
+        /// - Note: This `ServiceContext` doesn't contain the `OTel.SpanContext` as that's already unwrapped and accessible through `self.context`.
+        public let context: ServiceContext
 
         /// The absolute time at which this span was started.
         public let startTime: UInt64
@@ -55,18 +55,18 @@ extension OTel {
 
 extension OTel.RecordedSpan {
     init?(_ span: OTel.Tracer.Span) {
-        guard let context = span.baggage.spanContext else { return nil }
+        guard let spanContext = span.context.spanContext else { return nil }
         guard let endTime = span.endTime else { return nil }
 
         operationName = span.operationName
         kind = span.kind
         status = span.status
-        self.context = context
+        self.spanContext = spanContext
 
-        // strip span context from baggage because it's already stored as `context`.
-        var baggage = span.baggage
-        baggage.spanContext = nil
-        self.baggage = baggage
+        // strip span context from service context because it's already stored as `context`.
+        var context = span.context
+        context.spanContext = nil
+        self.context = context
 
         startTime = span.startTime
         self.endTime = endTime

Sources/OpenTelemetry/Sampling/ConstantSampler.swift

@@ -32,7 +32,7 @@ extension OTel {
             traceID: OTel.TraceID,
             attributes: SpanAttributes,
             links: [SpanLink],
-            parentBaggage: Baggage
+            parentContext: ServiceContext
         ) -> OTel.SamplingResult {
             OTel.SamplingResult(decision: isOn ? .recordAndSample : .drop, attributes: [:])
         }

Sources/OpenTelemetry/Sampling/ParentBasedSampler.swift

@@ -53,16 +53,16 @@ extension OTel {
             traceID: OTel.TraceID,
             attributes: SpanAttributes,
             links: [SpanLink],
-            parentBaggage: Baggage
+            parentContext: ServiceContext
         ) -> OTel.SamplingResult {
-            guard let parentSpanContext = parentBaggage.spanContext else {
+            guard let parentSpanContext = parentContext.spanContext else {
                 return rootSampler.makeSamplingDecision(
                     operationName: operationName,
                     kind: kind,
                     traceID: traceID,
                     attributes: attributes,
                     links: links,
-                    parentBaggage: parentBaggage
+                    parentContext: parentContext
                 )
             }
 
@@ -85,7 +85,7 @@ extension OTel {
                 traceID: traceID,
                 attributes: attributes,
                 links: links,
-                parentBaggage: parentBaggage
+                parentContext: parentContext
             )
         }
     }

Sources/OpenTelemetry/Sampling/Sampler.swift

@@ -24,14 +24,14 @@ public protocol OTelSampler {
     ///   - traceID: The trace id, either propagated or newly generated.
     ///   - attributes: A set of default span attributes.
     ///   - links: A set of default span links.
-    ///   - parentBaggage: The parent baggage which might contain a `OTel.SpanContext`.
+    ///   - parentContext: The parent service context which might contain a `OTel.SpanContext`.
     /// - Returns: A decision on whether the span to be started should be dropped, only recorded, or recorded and sampled.
     func makeSamplingDecision(
         operationName: String,
         kind: SpanKind,
         traceID: OTel.TraceID,
         attributes: SpanAttributes,
         links: [SpanLink],
-        parentBaggage: Baggage
+        parentContext: ServiceContext
     ) -> OTel.SamplingResult
 }

Sources/OpenTelemetry/SpanContext/Baggage+SpanContext.swift → Sources/OpenTelemetry/SpanContext/ServiceContext+SpanContext.swift

@@ -11,9 +11,9 @@
 //
 //===----------------------------------------------------------------------===//
 
-import InstrumentationBaggage
+import ServiceContextModule
 
-extension Baggage {
+extension ServiceContext {
     public internal(set) var spanContext: OTel.SpanContext? {
         get {
             self[SpanContextKey.self]
@@ -31,7 +31,7 @@ extension OTel.SpanContext: CustomStringConvertible {
     }
 }
 
-private enum SpanContextKey: BaggageKey {
+private enum SpanContextKey: ServiceContextKey {
     typealias Value = OTel.SpanContext
 
     static var nameOverride: String? = "otel-span-context"

Sources/OpenTelemetry/Tracer.swift

@@ -45,11 +45,11 @@ extension OTel {
 extension OTel.Tracer: Instrument {
     public func extract<Carrier, Extract>(
         _ carrier: Carrier,
-        into baggage: inout Baggage,
+        into context: inout ServiceContext,
         using extractor: Extract
     ) where Carrier == Extract.Carrier, Extract: Extractor {
         do {
-            baggage.spanContext = try propagator.extractSpanContext(from: carrier, using: extractor)
+            context.spanContext = try propagator.extractSpanContext(from: carrier, using: extractor)
         } catch {
             logger.debug("Failed to extract span context", metadata: [
                 "carrier": .string(String(describing: carrier)),
@@ -59,11 +59,11 @@ extension OTel.Tracer: Instrument {
     }
 
     public func inject<Carrier, Inject>(
-        _ baggage: Baggage,
+        _ context: ServiceContext,
         into carrier: inout Carrier,
         using injector: Inject
     ) where Carrier == Inject.Carrier, Inject: Injector {
-        guard let spanContext = baggage.spanContext else { return }
+        guard let spanContext = context.spanContext else { return }
         propagator.inject(spanContext, into: &carrier, using: injector)
     }
 }
@@ -73,7 +73,7 @@ extension OTel.Tracer: Tracer {
 
     public func startAnySpan<Instant: TracerInstant>(
         _ operationName: String,
-        baggage: @autoclosure () -> Baggage,
+        context: @autoclosure () -> ServiceContext,
         ofKind kind: SpanKind,
         at instant: @autoclosure () -> Instant,
         function: String,
@@ -82,7 +82,7 @@ extension OTel.Tracer: Tracer {
     ) -> any Tracing.Span {
         startSpan(
             operationName,
-            baggage: baggage(),
+            context: context(),
             ofKind: kind,
             at: instant(),
             function: function,
@@ -93,21 +93,21 @@ extension OTel.Tracer: Tracer {
 
     public func startSpan<Instant: TracerInstant>(
         _ operationName: String,
-        baggage: @autoclosure () -> Baggage,
+        context: @autoclosure () -> ServiceContext,
         ofKind kind: SpanKind,
         at instant: @autoclosure () -> Instant,
         function: String,
         file fileID: String,
         line: UInt
     ) -> TracerSpan {
-        let parentBaggage = baggage()
-        var childBaggage = parentBaggage
+        let parentContext = context()
+        var childContext = parentContext
 
         let traceID: OTel.TraceID
         let traceState: OTel.TraceState?
         let spanID = idGenerator.generateSpanID()
 
-        if let parentSpanContext = parentBaggage.spanContext {
+        if let parentSpanContext = parentContext.spanContext {
             traceID = parentSpanContext.traceID
             traceState = parentSpanContext.traceState
         } else {
@@ -121,23 +121,23 @@ extension OTel.Tracer: Tracer {
             traceID: traceID,
             attributes: [:],
             links: [],
-            parentBaggage: parentBaggage
+            parentContext: parentContext
         )
         let traceFlags: OTel.TraceFlags = samplingResult.decision == .recordAndSample ? .sampled : []
         let spanContext = OTel.SpanContext(
             traceID: traceID,
             spanID: spanID,
-            parentSpanID: parentBaggage.spanContext?.spanID,
+            parentSpanID: parentContext.spanContext?.spanID,
             traceFlags: traceFlags,
             traceState: traceState,
             isRemote: false
         )
-        childBaggage.spanContext = spanContext
+        childContext.spanContext = spanContext
 
         if samplingResult.decision == .drop {
             return Span(
                 operationName: operationName,
-                baggage: childBaggage,
+                context: childContext,
                 kind: kind,
                 startTime: instant().nanosecondsSinceEpoch,
                 attributes: samplingResult.attributes,
@@ -151,7 +151,7 @@ extension OTel.Tracer: Tracer {
 
         return Span(
             operationName: operationName,
-            baggage: childBaggage,
+            context: childContext,
             kind: kind,
             startTime: instant().nanosecondsSinceEpoch,
             attributes: samplingResult.attributes,
@@ -184,7 +184,7 @@ extension OTel.Tracer {
         public let kind: SpanKind
         public private(set) var status: SpanStatus?
 
-        public let baggage: Baggage
+        public let context: ServiceContext
 
         public let isRecording: Bool
 
@@ -203,7 +203,7 @@ extension OTel.Tracer {
 
         init(
             operationName: String,
-            baggage: Baggage,
+            context: ServiceContext,
             kind: SpanKind,
             startTime: UInt64,
             attributes: SpanAttributes,
@@ -213,7 +213,7 @@ extension OTel.Tracer {
             onEnd: @escaping (OTel.RecordedSpan) -> Void
         ) {
             _operationName = operationName
-            self.baggage = baggage
+            self.context = context
             self.kind = kind
             self.startTime = startTime
             self.attributes = attributes
@@ -252,7 +252,7 @@ extension OTel.Tracer {
         public func end<Instant: TracerInstant>(at instant: @autoclosure () -> Instant) {
             lock.withLockVoid {
                 if let endTime = self.endTime {
-                    if let spanContext = baggage.spanContext {
+                    if let spanContext = context.spanContext {
                         logger.trace("Ignoring a span that was ended before", metadata: [
                             "previousEndTime": .stringConvertible(endTime),
                             "traceID": .stringConvertible(spanContext.traceID),

Sources/OtlpGRPCSpanExporting/TypeConversion/Span+Proto.swift

@@ -18,12 +18,12 @@ extension Opentelemetry_Proto_Trace_V1_Span {
     init(_ span: OTel.RecordedSpan) {
         self.name = span.operationName
         self.kind = SpanKind(span.kind)
-        self.traceID = Data(span.context.traceID.bytes)
-        self.spanID = Data(span.context.spanID.bytes)
-        if let parentSpanID = span.context.parentSpanID {
+        self.traceID = Data(span.spanContext.traceID.bytes)
+        self.spanID = Data(span.spanContext.spanID.bytes)
+        if let parentSpanID = span.spanContext.parentSpanID {
             self.parentSpanID = Data(parentSpanID.bytes)
         }
-        if let traceState = span.context.traceState {
+        if let traceState = span.spanContext.traceState {
             self.traceState = traceState.description
         }
         if let status = span.status {

Sources/OtlpGRPCSpanExporting/TypeConversion/SpanLink+Proto.swift

@@ -16,7 +16,7 @@ import Tracing
 
 extension Opentelemetry_Proto_Trace_V1_Span.Link {
     init?(_ spanLink: SpanLink) {
-        guard let spanContext = spanLink.baggage.spanContext else { return nil }
+        guard let spanContext = spanLink.context.spanContext else { return nil }
         self.traceID = Data(spanContext.traceID.bytes)
         self.spanID = Data(spanContext.spanID.bytes)
         if let traceState = spanContext.traceState {

Tests/OpenTelemetryTests/Helpers/MockSampler.swift

@@ -28,7 +28,7 @@ final class MockSampler: OTelSampler {
         traceID: OTel.TraceID,
         attributes: SpanAttributes,
         links: [SpanLink],
-        parentBaggage: Baggage
+        parentContext: ServiceContext
     ) -> OTel.SamplingResult {
         numberOfSamplingDecisions += 1
         return sampler.makeSamplingDecision(
@@ -37,7 +37,7 @@ final class MockSampler: OTelSampler {
             traceID: traceID,
             attributes: attributes,
             links: links,
-            parentBaggage: parentBaggage
+            parentContext: parentContext
         )
     }
 }

Tests/OpenTelemetryTests/Helpers/Span+Stub.swift

@@ -26,12 +26,12 @@ extension OTel.Tracer.Span {
         logger: Logger = Logger(label: #function),
         onEnd: @escaping (OTel.RecordedSpan) -> Void = { _ in }
     ) -> OTel.Tracer.Span {
-        var baggage = Baggage.topLevel
-        baggage.spanContext = spanContext
+        var context = ServiceContext.topLevel
+        context.spanContext = spanContext
 
         return OTel.Tracer.Span(
             operationName: operationName,
-            baggage: baggage,
+            context: context,
             kind: kind,
             startTime: startTime,
             attributes: attributes,