Rename TracingInstrument to Tracer

Author: slashmo

Sources/Instrumentation/MultiplexInstrument.swift

@@ -39,7 +39,8 @@ extension MultiplexInstrument: Instrument {
     )
         where
         Injector: InjectorProtocol,
-        Carrier == Injector.Carrier {
+        Carrier == Injector.Carrier
+    {
         self.instruments.forEach { $0.inject(context, into: &carrier, using: injector) }
     }
 
@@ -48,7 +49,8 @@ extension MultiplexInstrument: Instrument {
     )
         where
         Carrier == Extractor.Carrier,
-        Extractor: ExtractorProtocol {
+        Extractor: ExtractorProtocol
+    {
         self.instruments.forEach { $0.extract(carrier, into: &context, using: extractor) }
     }
 }

Sources/Tracing/InstrumentationSystem+Tracing.swift

@@ -15,26 +15,26 @@ import Baggage
 import Instrumentation
 
 extension InstrumentationSystem {
-    /// Get a `TracingInstrument` instance of the given type.
+    /// Get a `Tracer` instance of the given type.
     ///
     /// When using `MultiplexInstrument`, this returns the first instance of the given type stored in the `MultiplexInstrument`.
     ///
     /// Usually tracing libraries will provide their own convenience getter, e.g. CoolTracing could provide `InstrumentationSystem.coolTracer`;
     /// if available, prefer using those APIs rather than relying on this general function.
     ///
-    /// - Parameter instrumentType: The type of `Instrument` you want to retrieve an instance for.
-    /// - Returns: An `Instrument` instance of the given type or `nil` if no `Instrument` of that type has been bootstrapped.
-    public static func tracingInstrument<T>(of instrumentType: T.Type) -> T? where T: TracingInstrument {
+    /// - Parameter tracerType: The type of `Tracer` you want to retrieve an instance for.
+    /// - Returns: A `Tracer` instance of the given type or `nil` if no `Tracer` of that type has been bootstrapped.
+    public static func tracer<T>(of tracerType: T.Type) -> T? where T: Tracer {
         return self._findInstrument(where: { $0 is T }) as? T
     }
 
-    /// Returns the `TracingInstrument` bootstrapped as part of the `InstrumentationSystem`.
+    /// Returns the `Tracer` bootstrapped as part of the `InstrumentationSystem`.
     ///
     /// If the system was bootstrapped with a `MultiplexInstrument` this function attempts to locate the _first_
-    /// tracing instrument as passed to the multiplex instrument. If none is found, a `NoOpTracingInstrument` is returned.
+    /// tracing instrument as passed to the multiplex instrument. If none is found, a `NoOpTracer` is returned.
     ///
-    /// - Returns: A `TracingInstrument` if the system was bootstrapped with one, and `NoOpTracingInstrument` otherwise.
-    public static var tracingInstrument: TracingInstrument {
-        return (self._findInstrument(where: { $0 is TracingInstrument }) as? TracingInstrument) ?? NoOpTracingInstrument()
+    /// - Returns: A `Tracer` if the system was bootstrapped with one, and `NoOpTracer` otherwise.
+    public static var tracer: Tracer {
+        return (self._findInstrument(where: { $0 is Tracer }) as? Tracer) ?? NoOpTracer()
     }
 }

Sources/Tracing/NoOpTracingInstrument.swift renamed to Sources/Tracing/NoOpTracer.swift

@@ -14,8 +14,8 @@
 import Baggage
 import Instrumentation
 
-/// No operation TracingInstrument, used when no tracing is required.
-public struct NoOpTracingInstrument: TracingInstrument {
+/// No operation Tracer, used when no tracing is required.
+public struct NoOpTracer: Tracer {
     public func startSpan(
         named operationName: String,
         context: BaggageContextCarrier,

Sources/Tracing/Span.swift

@@ -15,7 +15,7 @@ import Baggage
 
 /// A `Span` type that follows the OpenTracing/OpenTelemetry spec. The span itself should not be
 /// initializable via its public interface. `Span` creation should instead go through `tracer.startSpan`
-/// where `tracer` conforms to `TracingInstrument`.
+/// where `tracer` conforms to `Tracer`.
 ///
 /// - SeeAlso: [OpenTelemetry Specification: Span](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#span).
 public protocol Span {
@@ -25,7 +25,7 @@ public protocol Span {
     /// Set the status.
     /// - Parameter status: The status of this `Span`.
     mutating func setStatus(_ status: SpanStatus)
-    
+
     /// Add a `SpanEvent` in place.
     /// - Parameter event: The `SpanEvent` to add to this `Span`.
     mutating func addEvent(_ event: SpanEvent)
@@ -162,7 +162,8 @@ extension SpanAttributeNamespace {
     }
 
     public subscript<Namespace>(dynamicMember dynamicMember: KeyPath<SpanAttribute, Namespace>) -> Namespace
-        where Namespace: SpanAttributeNamespace {
+        where Namespace: SpanAttributeNamespace
+    {
         SpanAttribute.__namespace[keyPath: dynamicMember]
     }
 }
@@ -364,7 +365,8 @@ extension SpanAttributes {
     ///
     // TODO: document the pattern maybe on SpanAttributes?
     public subscript<Namespace>(dynamicMember dynamicMember: KeyPath<SpanAttribute, Namespace>) -> Namespace
-        where Namespace: SpanAttributeNamespace {
+        where Namespace: SpanAttributeNamespace
+    {
         SpanAttribute.__namespace[keyPath: dynamicMember]
     }
 }

Sources/Tracing/TracingInstrument.swift renamed to Sources/Tracing/Tracer.swift

@@ -16,7 +16,7 @@ import Instrumentation
 
 /// An `Instrument` with added functionality for distributed tracing. Is uses the span-based tracing model and is
 /// based on the OpenTracing/OpenTelemetry spec.
-public protocol TracingInstrument: Instrument {
+public protocol Tracer: Instrument {
     /// Start a new `Span` within the given `BaggageContext` at a given timestamp.
     /// - Parameters:
     ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
@@ -39,7 +39,7 @@ public protocol TracingInstrument: Instrument {
     func forceFlush()
 }
 
-extension TracingInstrument {
+extension Tracer {
     /// Start a new `Span` within the given `BaggageContext`. This passes `nil` as the timestamp to the tracer, which
     /// usually means it should default to the current timestamp.
     /// - Parameters:

Sources/TracingBenchmarkTools/ArgParser.swift

@@ -219,7 +219,7 @@ class ArgumentParser<U> {
     ) {
         self.arguments.append(
             Argument(name: name, help: help)
-            { try self.parseArgument(name, property, defaultValue, parser) }
+                { try self.parseArgument(name, property, defaultValue, parser) }
         )
     }
 

Tests/InstrumentationTests/InstrumentTests.swift

@@ -66,7 +66,8 @@ private final class FirstFakeTracer: Instrument {
     )
         where
         Injector: InjectorProtocol,
-        Carrier == Injector.Carrier {
+        Carrier == Injector.Carrier
+    {
         guard let traceID = context[TraceIDKey.self] else { return }
         injector.inject(traceID, forKey: FirstFakeTracer.headerName, into: &carrier)
     }
@@ -76,7 +77,8 @@ private final class FirstFakeTracer: Instrument {
     )
         where
         Extractor: ExtractorProtocol,
-        Carrier == Extractor.Carrier {
+        Carrier == Extractor.Carrier
+    {
         let traceID = extractor.extract(key: FirstFakeTracer.headerName, from: carrier) ?? FirstFakeTracer.defaultTraceID
         context[TraceIDKey.self] = traceID
     }
@@ -97,7 +99,8 @@ private final class SecondFakeTracer: Instrument {
     )
         where
         Injector: InjectorProtocol,
-        Carrier == Injector.Carrier {
+        Carrier == Injector.Carrier
+    {
         guard let traceID = context[TraceIDKey.self] else { return }
         injector.inject(traceID, forKey: SecondFakeTracer.headerName, into: &carrier)
     }
@@ -107,7 +110,8 @@ private final class SecondFakeTracer: Instrument {
     )
         where
         Extractor: ExtractorProtocol,
-        Carrier == Extractor.Carrier {
+        Carrier == Extractor.Carrier
+    {
         let traceID = extractor.extract(key: SecondFakeTracer.headerName, from: carrier) ?? SecondFakeTracer.defaultTraceID
         context[TraceIDKey.self] = traceID
     }

Tests/LinuxMain.swift

@@ -43,7 +43,7 @@ class LinuxMainRunnerImpl: LinuxMainRunner {
              testCase(SpanTests.allTests),
              testCase(TimestampTests.allTests),
              testCase(TracedLockTests.allTests),
-             testCase(TracingInstrumentTests.allTests),
+             testCase(TracerTests.allTests),
         ])
     }
 }

Tests/NIOInstrumentationTests/FakeTracer.swift

@@ -29,7 +29,8 @@ final class FakeTracer: Instrument {
     )
         where
         Injector: InjectorProtocol,
-        Carrier == Injector.Carrier {
+        Carrier == Injector.Carrier
+    {
         guard let traceID = context[TraceIDKey.self] else { return }
         injector.inject(traceID, forKey: FakeTracer.headerName, into: &carrier)
     }
@@ -39,7 +40,8 @@ final class FakeTracer: Instrument {
     )
         where
         Extractor: ExtractorProtocol,
-        Carrier == Extractor.Carrier {
+        Carrier == Extractor.Carrier
+    {
         let traceID = extractor.extract(key: FakeTracer.headerName, from: carrier) ?? FakeTracer.defaultTraceID
         context[TraceIDKey.self] = traceID
     }

Tests/TracingTests/TracedLock.swift

@@ -30,7 +30,7 @@ final class TracedLock {
     func lock(context: BaggageContext) {
         // time here
         self.underlyingLock.lock()
-        self.activeSpan = InstrumentationSystem.tracingInstrument.startSpan(named: self.name, context: context)
+        self.activeSpan = InstrumentationSystem.tracer.startSpan(named: self.name, context: context)
     }
 
     func unlock(context: BaggageContext) {