SpanProtocol -> Span after all

Rationale:

since passing around any SpanProtocol a lot looked terrible;

Also, less breakage in protocol renaming

Author: ktoso

Sources/Tracing/NoOpTracer.swift

@@ -18,7 +18,7 @@ import Dispatch
 
 /// Tracer that ignores all operations, used when no tracing is required.
 public struct NoOpTracer: LegacyTracerProtocol {
-    public typealias Span = NoOpSpan
+    public typealias TracerSpan = NoOpSpan
 
     public init() {}
 
@@ -28,7 +28,7 @@ public struct NoOpTracer: LegacyTracerProtocol {
                              at time: DispatchWallTime,
                              function: String,
                              file fileID: String,
-                             line: UInt) -> any SpanProtocol
+                             line: UInt) -> any Span
     {
         NoOpSpan(baggage: baggage())
     }
@@ -47,7 +47,7 @@ public struct NoOpTracer: LegacyTracerProtocol {
         // no-op
     }
 
-    public final class NoOpSpan: SpanProtocol {
+    public final class NoOpSpan: Span {
         public let baggage: Baggage
         public var isRecording: Bool {
             false

Sources/Tracing/SpanProtocol.swift

@@ -26,7 +26,7 @@ import struct Dispatch.DispatchWallTime
 /// Creating a `Span` is delegated to a ``Tracer`` and end users should never create them directly.
 ///
 /// - SeeAlso: For more details refer to the [OpenTelemetry Specification: Span](https://github.com/open-telemetry/opentelemetry-specification/blob/v0.7.0/specification/trace/api.md#span) which this type is compatible with.
-public protocol SpanProtocol: AnyObject, _SwiftTracingSendableSpan {
+public protocol Span: AnyObject, _SwiftTracingSendableSpan {
     /// The read-only `Baggage` of this `Span`, set when starting this `Span`.
     var baggage: Baggage { get }
 
@@ -91,7 +91,7 @@ public protocol SpanProtocol: AnyObject, _SwiftTracingSendableSpan {
     func end(at time: DispatchWallTime)
 }
 
-extension SpanProtocol {
+extension Span {
     /// End this `Span` at the current time.
     ///
     /// ### Rules about ending Spans
@@ -114,12 +114,12 @@ extension SpanProtocol {
     ///
     /// - Parameter other: The `Span` to link to.
     /// - Parameter attributes: The ``SpanAttributes`` describing this link. Defaults to no attributes.
-    public func addLink(_ other: SpanProtocol, attributes: SpanAttributes = [:]) {
+    public func addLink(_ other: Span, attributes: SpanAttributes = [:]) {
         self.addLink(SpanLink(baggage: other.baggage, attributes: attributes))
     }
 }
 
-extension SpanProtocol {
+extension Span {
     /// Record a failure described by the given error.
     ///
     /// - Parameters:
@@ -176,7 +176,6 @@ public struct SpanAttributeKey<T>: Hashable, ExpressibleByStringLiteral where T:
     }
 }
 
-#if swift(>=5.2)
 @dynamicMemberLookup
 public protocol SpanAttributeNamespace {
     /// Type that contains the nested attributes, e.g. HTTPAttributes which would contain `statusCode` and similar vars.
@@ -247,7 +246,6 @@ extension SpanAttributeNamespace {
         SpanAttribute.int(0)[keyPath: dynamicMember]
     }
 }
-#endif
 
 /// The value of an attribute used to describe a ``Span`` or ``SpanEvent``.
 ///

Sources/Tracing/Tracer.swift

@@ -58,7 +58,7 @@ extension Tracer {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line
-    ) -> any SpanProtocol {
+    ) -> any Span {
         // Effectively these end up calling the same method, however
         // we try to not use the deprecated methods ourselves anyway
         #if swift(>=5.7.0)
@@ -90,7 +90,7 @@ extension Tracer {
     /// we're about to start a top-level span, or if a span should be started from a different,
     /// stored away previously,
     ///
-    /// - Warning: You MUST NOT ``SpanProtocol/end()`` the span explicitly, because at the end of the `withSpan`
+    /// - Warning: You MUST NOT ``Span/end()`` the span explicitly, because at the end of the `withSpan`
     ///   operation closure returning the span will be closed automatically.
     ///
     /// - Parameters:
@@ -111,7 +111,7 @@ extension Tracer {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (any SpanProtocol) throws -> T
+        _ operation: (any Span) throws -> T
     ) rethrows -> T {
         #if swift(>=5.7.0)
         try InstrumentationSystem.legacyTracer.withAnySpan(
@@ -145,7 +145,7 @@ extension Tracer {
     /// we're about to start a top-level span, or if a span should be started from a different,
     /// stored away previously,
     ///
-    /// - Warning: You MUST NOT ``SpanProtocol/end()`` the span explicitly, because at the end of the `withSpan`
+    /// - Warning: You MUST NOT ``Span/end()`` the span explicitly, because at the end of the `withSpan`
     ///   operation closure returning the span will be closed automatically.
     ///
     /// - Parameters:
@@ -170,7 +170,7 @@ extension Tracer {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (any SpanProtocol) async throws -> T
+        _ operation: (any Span) async throws -> T
     ) async rethrows -> T {
         try await InstrumentationSystem.legacyTracer.withAnySpan(
             operationName,
@@ -194,7 +194,7 @@ extension Tracer {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (any SpanProtocol) async throws -> T
+        _ operation: (any Span) async throws -> T
     ) async rethrows -> T {
         try await InstrumentationSystem.legacyTracer.withAnySpan(
             operationName,

Sources/Tracing/TracerProtocol+Legacy.swift

@@ -18,7 +18,7 @@ import Dispatch
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal Baggage
 public protocol LegacyTracerProtocol: InstrumentProtocol {
-    /// Start a new span returning an existential ``SpanProtocol`` reference.
+    /// Start a new span returning an existential ``Span`` reference.
     ///
     /// This API will be deprecated as soon as Swift 5.9 is released, and the Swift 5.7 requiring `TracerProtocol`
     /// is recommended instead.
@@ -55,7 +55,7 @@ public protocol LegacyTracerProtocol: InstrumentProtocol {
         function: String,
         file fileID: String,
         line: UInt
-    ) -> any SpanProtocol
+    ) -> any Span
 
     /// Export all ended spans to the configured backend that have not yet been exported.
     ///
@@ -71,7 +71,7 @@ public protocol LegacyTracerProtocol: InstrumentProtocol {
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal Baggage
 extension LegacyTracerProtocol {
-    /// Start a new span returning an existential ``SpanProtocol`` reference.
+    /// Start a new span returning an existential ``Span`` reference.
     ///
     /// This API will be deprecated as soon as Swift 5.9 is released, and the Swift 5.7 requiring `TracerProtocol`
     /// is recommended instead.
@@ -108,7 +108,7 @@ extension LegacyTracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line
-    ) -> any SpanProtocol {
+    ) -> any Span {
         self.startAnySpan(
             operationName,
             baggage: baggage(),
@@ -120,7 +120,7 @@ extension LegacyTracerProtocol {
         )
     }
 
-    /// Start a new ``SpanProtocol`` and automatically end when the `operation` completes,
+    /// Start a new ``Span`` and automatically end when the `operation` completes,
     /// including recording the `error` in case the operation throws.
     ///
     /// This API will be deprecated as soon as Swift 5.9 is released, and the Swift 5.7 requiring `TracerProtocol`
@@ -161,7 +161,7 @@ extension LegacyTracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (any SpanProtocol) throws -> T
+        _ operation: (any Span) throws -> T
     ) rethrows -> T {
         let span = self.startAnySpan(operationName, baggage: baggage(), ofKind: kind, at: time, function: function, file: fileID, line: line)
         defer { span.end() }
@@ -175,7 +175,7 @@ extension LegacyTracerProtocol {
         }
     }
 
-    /// Start a new ``SpanProtocol`` and automatically end when the `operation` completes,
+    /// Start a new ``Span`` and automatically end when the `operation` completes,
     /// including recording the `error` in case the operation throws.
     ///
     /// This API will be deprecated as soon as Swift 5.9 is released, and the Swift 5.7 requiring `TracerProtocol`
@@ -216,7 +216,7 @@ extension LegacyTracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (any SpanProtocol) async throws -> T
+        _ operation: (any Span) async throws -> T
     ) async rethrows -> T {
         let span = self.startAnySpan(operationName, baggage: baggage(), ofKind: kind, at: time, function: function, file: fileID, line: line)
         defer { span.end() }
@@ -236,7 +236,7 @@ extension LegacyTracerProtocol {
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
 extension TracerProtocol {
-    /// Start a new span returning an existential ``SpanProtocol`` reference.
+    /// Start a new span returning an existential ``Span`` reference.
     ///
     /// This API will be deprecated as soon as Swift 5.9 is released, and the Swift 5.7 requiring `TracerProtocol`
     /// is recommended instead.
@@ -273,7 +273,7 @@ extension TracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line
-    ) -> any SpanProtocol {
+    ) -> any Span {
         self.startSpan(
             operationName,
             baggage: baggage(),
@@ -285,7 +285,7 @@ extension TracerProtocol {
         )
     }
 
-    /// Start a new ``SpanProtocol`` and automatically end when the `operation` completes,
+    /// Start a new ``Span`` and automatically end when the `operation` completes,
     /// including recording the `error` in case the operation throws.
     ///
     /// This API will be deprecated as soon as Swift 5.9 is released, and the Swift 5.7 requiring `TracerProtocol`
@@ -326,7 +326,7 @@ extension TracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (any SpanProtocol) throws -> T
+        _ operation: (any Span) throws -> T
     ) rethrows -> T {
         try self.withSpan(
             operationName,
@@ -341,7 +341,7 @@ extension TracerProtocol {
         }
     }
 
-    /// Start a new ``SpanProtocol`` and automatically end when the `operation` completes,
+    /// Start a new ``Span`` and automatically end when the `operation` completes,
     /// including recording the `error` in case the operation throws.
     ///
     /// This API will be deprecated as soon as Swift 5.9 is released, and the Swift 5.7 requiring `TracerProtocol`
@@ -384,7 +384,7 @@ extension TracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (any SpanProtocol) async throws -> T
+        _ operation: (any Span) async throws -> T
     ) async rethrows -> T {
         try await self.withSpan(
             operationName,
@@ -408,7 +408,7 @@ extension TracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (any SpanProtocol) async throws -> T
+        _ operation: (any Span) async throws -> T
     ) async rethrows -> T {
         try await self.withSpan(
             operationName,

Sources/Tracing/TracerProtocol.swift

@@ -22,11 +22,11 @@ import Dispatch
 #if swift(>=5.7.0)
 /// A tracer capable of creating new trace spans.
 ///
-/// A tracer is a special kind of instrument with the added ability to start a ``SpanProtocol``.
+/// A tracer is a special kind of instrument with the added ability to start a ``Span``.
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal Baggage
 public protocol TracerProtocol: LegacyTracerProtocol {
     /// The concrete type of span this tracer will be producing/
-    associatedtype Span: SpanProtocol
+    associatedtype TracerSpan: Span
 
     /// Start a new ``Span`` with the given `Baggage`.
     ///
@@ -60,7 +60,7 @@ public protocol TracerProtocol: LegacyTracerProtocol {
         function: String,
         file fileID: String,
         line: UInt
-    ) -> Self.Span
+    ) -> TracerSpan
 }
 
 @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal Baggage
@@ -97,7 +97,7 @@ extension TracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line
-    ) -> Self.Span {
+    ) -> TracerSpan {
         self.startSpan(
             operationName,
             baggage: baggage(),
@@ -124,7 +124,7 @@ extension TracerProtocol {
     /// we're about to start a top-level span, or if a span should be started from a different,
     /// stored away previously,
     ///
-    /// - Warning: You MUST NOT ``SpanProtocol/end()`` the span explicitly, because at the end of the `withSpan`
+    /// - Warning: You MUST NOT ``Span/end()`` the span explicitly, because at the end of the `withSpan`
     ///   operation closure returning the span will be closed automatically.
     ///
     /// - Parameters:
@@ -146,7 +146,7 @@ extension TracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (Self.Span) throws -> T
+        _ operation: (TracerSpan) throws -> T
     ) rethrows -> T {
         let span = self.startSpan(
             operationName,
@@ -177,7 +177,7 @@ extension TracerProtocol {
     /// we're about to start a top-level span, or if a span should be started from a different,
     /// stored away previously,
     ///
-    /// - Warning: You MUST NOT ``SpanProtocol/end()`` the span explicitly, because at the end of the `withSpan`
+    /// - Warning: You MUST NOT ``Span/end()`` the span explicitly, because at the end of the `withSpan`
     ///   operation closure returning the span will be closed automatically.
     ///
     /// - Parameters:
@@ -200,7 +200,7 @@ extension TracerProtocol {
         function: String = #function,
         file fileID: String = #fileID,
         line: UInt = #line,
-        _ operation: (Self.Span) async throws -> T
+        _ operation: (TracerSpan) async throws -> T
     ) async rethrows -> T {
         let span = self.startSpan(
             operationName,

Sources/_TracingBenchmarks/SpanAttributesDSLBenchmark.swift

@@ -69,7 +69,7 @@ public let SpanAttributesDSLBenchmarks: [BenchmarkInfo] = [
     ),
 ]
 
-private var span: (any SpanProtocol)!
+private var span: (any Span)!
 
 private func setUp() {
     span = InstrumentationSystem.legacyTracer.startAnySpan("something", baggage: .topLevel)

Tests/TracingTests/DynamicTracepointTracerTests.swift

@@ -164,7 +164,7 @@ final class DynamicTracepointTestTracer: LegacyTracerProtocol {
     }
 
     private(set) var spans: [TracepointSpan] = []
-    var onEndSpan: (SpanProtocol) -> Void = { _ in
+    var onEndSpan: (Span) -> Void = { _ in
     }
 
     func startAnySpan(
@@ -175,7 +175,7 @@ final class DynamicTracepointTestTracer: LegacyTracerProtocol {
         function: String,
         file fileID: String,
         line: UInt
-    ) -> any SpanProtocol {
+    ) -> any Span {
         let tracepoint = TracepointID(function: function, fileID: fileID, line: line)
         guard self.shouldRecord(tracepoint: tracepoint) else {
             return TracepointSpan.notRecording(file: fileID, line: line)
@@ -255,7 +255,7 @@ final class DynamicTracepointTestTracer: LegacyTracerProtocol {
 
 extension DynamicTracepointTestTracer {
     /// Only intended to be used in single-threaded testing.
-    final class TracepointSpan: Tracing.SpanProtocol {
+    final class TracepointSpan: Tracing.Span {
         private let kind: SpanKind
 
         private var status: SpanStatus?
@@ -333,7 +333,7 @@ extension DynamicTracepointTestTracer {
 
 #if compiler(>=5.7.0)
 extension DynamicTracepointTestTracer: TracerProtocol {
-    typealias Span = TracepointSpan
+    typealias TracerSpan = TracepointSpan
 
     func startSpan(_ operationName: String,
                    baggage: @autoclosure () -> Baggage,