Merge pull request #141 from slashmo/refactor/tracer-naming

slashmo · web-flow · commit 75795926e29c · 2020-08-31T15:58:15.000+02:00
Drop Instrument suffix in TracingInstrument &amp; TracingInstrumentation
diff --git a/Package.swift b/Package.swift
@@ -5,7 +5,7 @@ let package = Package(
     name: "gsoc-swift-tracing",
     products: [
         .library(name: "Instrumentation", targets: ["Instrumentation"]),
-        .library(name: "TracingInstrumentation", targets: ["TracingInstrumentation"]),
+        .library(name: "Tracing", targets: ["Tracing"]),
         .library(name: "NIOInstrumentation", targets: ["NIOInstrumentation"]),
         .library(name: "OpenTelemetryInstrumentationSupport", targets: ["OpenTelemetryInstrumentationSupport"])
     ],
@@ -34,16 +34,16 @@ let package = Package(
         ),
 
         .target(
-            name: "TracingInstrumentation",
+            name: "Tracing",
             dependencies: [
                 "Instrumentation",
             ]
         ),
         .testTarget(
-            name: "TracingInstrumentationTests",
+            name: "TracingTests",
             dependencies: [
                 "Instrumentation",
-                "TracingInstrumentation",
+                "Tracing",
                 "BaggageLogging",
             ]
         ),
@@ -66,7 +66,7 @@ let package = Package(
         .target(
             name: "OpenTelemetryInstrumentationSupport",
             dependencies: [
-                .target(name: "TracingInstrumentation")
+                .target(name: "Tracing")
             ]
         ),
         .testTarget(
diff --git a/Sources/Instrumentation/MultiplexInstrument.swift b/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) }
     }
 }
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+EndUser.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+EndUser.swift
@@ -11,7 +11,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import TracingInstrumentation
+import Tracing
 
 extension SpanAttributeName {
     /// - See: EndUserAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+GRPCSemantics.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+GRPCSemantics.swift
@@ -11,7 +11,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import TracingInstrumentation
+import Tracing
 
 extension SpanAttributeName {
     /// - See: GRPCAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+HTTPSemantics.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+HTTPSemantics.swift
@@ -11,7 +11,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import TracingInstrumentation
+import Tracing
 
 extension SpanAttributeName {
     /// - See: HTTPAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+NetSemantics.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+NetSemantics.swift
@@ -11,7 +11,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import TracingInstrumentation
+import Tracing
 
 extension SpanAttributeName {
     /// - See: NetAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+PeerSemantics.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+PeerSemantics.swift
@@ -11,7 +11,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import TracingInstrumentation
+import Tracing
 
 extension SpanAttributeName {
     /// - See: PeerAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+RPCSemantics.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttribute+RPCSemantics.swift
@@ -11,7 +11,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import TracingInstrumentation
+import Tracing
 
 extension SpanAttributeName {
     /// - See: RPCAttributes
diff --git a/Sources/OpenTelemetryInstrumentationSupport/SpanAttributeName.swift b/Sources/OpenTelemetryInstrumentationSupport/SpanAttributeName.swift
@@ -11,7 +11,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import TracingInstrumentation
+import Tracing
 
 /// Namespace for attribute key constants used with `SpanAttributes`.
 public enum SpanAttributeName {}
diff --git a/Sources/Tracing/InstrumentationSystem+Tracing.swift b/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()
     }
 }
diff --git a/Sources/Tracing/NoOpTracer.swift b/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,
diff --git a/Sources/Tracing/Span.swift b/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]
     }
 }
diff --git a/Sources/Tracing/Timestamp.swift b/Sources/Tracing/Timestamp.swift
diff --git a/Sources/Tracing/Tracer.swift b/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:
diff --git a/Sources/TracingBenchmarkTools/ArgParser.swift b/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) }
         )
     }
 
diff --git a/Tests/InstrumentationTests/InstrumentTests.swift b/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
     }
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
@@ -24,7 +24,7 @@ import XCTest
    @testable import InstrumentationTests
    @testable import NIOInstrumentationTests
    @testable import OpenTelemetryInstrumentationSupportTests
-   @testable import TracingInstrumentationTests
+   @testable import TracingTests
 
 // This protocol is necessary to we can call the 'run' method (on an existential of this protocol)
 // without the compiler noticing that we're calling a deprecated function.
@@ -43,7 +43,7 @@ class LinuxMainRunnerImpl: LinuxMainRunner {
              testCase(SpanTests.allTests),
              testCase(TimestampTests.allTests),
              testCase(TracedLockTests.allTests),
-             testCase(TracingInstrumentTests.allTests),
+             testCase(TracerTests.allTests),
         ])
     }
 }
diff --git a/Tests/NIOInstrumentationTests/FakeTracer.swift b/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
     }
diff --git a/Tests/OpenTelemetryInstrumentationSupportTests/SpanAttributeSemanticsTests.swift b/Tests/OpenTelemetryInstrumentationSupportTests/SpanAttributeSemanticsTests.swift
@@ -14,7 +14,7 @@
 import Baggage
 import Instrumentation
 import OpenTelemetryInstrumentationSupport
-import TracingInstrumentation
+import Tracing
 import XCTest
 
 final class SpanAttributeSemanticsTests: XCTestCase {
diff --git a/Tests/TracingTests/SpanTests+XCTest.swift b/Tests/TracingTests/SpanTests+XCTest.swift
diff --git a/Tests/TracingTests/SpanTests.swift b/Tests/TracingTests/SpanTests.swift
@@ -13,7 +13,7 @@
 
 import Baggage
 import Instrumentation
-import TracingInstrumentation
+import Tracing
 import XCTest
 
 final class SpanTests: XCTestCase {
diff --git a/Tests/TracingTests/TimestampTests+XCTest.swift b/Tests/TracingTests/TimestampTests+XCTest.swift
diff --git a/Tests/TracingTests/TimestampTests.swift b/Tests/TracingTests/TimestampTests.swift
@@ -12,7 +12,7 @@
 //===----------------------------------------------------------------------===//
 
 import Instrumentation
-import TracingInstrumentation
+import Tracing
 import XCTest
 
 final class TimestampTests: XCTestCase {
diff --git a/Tests/TracingTests/TracedLock.swift b/Tests/TracingTests/TracedLock.swift
@@ -14,7 +14,7 @@
 import Baggage
 import Foundation
 import Instrumentation
-import TracingInstrumentation
+import Tracing
 
 final class TracedLock {
     let name: String
@@ -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) {
diff --git a/Tests/TracingTests/TracedLockTests+XCTest.swift b/Tests/TracingTests/TracedLockTests+XCTest.swift
diff --git a/Tests/TracingTests/TracedLockTests.swift b/Tests/TracingTests/TracedLockTests.swift
@@ -14,7 +14,7 @@
 import Baggage
 import BaggageLogging
 @testable import Instrumentation
-import TracingInstrumentation
+import Tracing
 import XCTest
 
 final class TracedLockTests: XCTestCase {
@@ -53,7 +53,7 @@ enum TaskIDKey: BaggageContextKey {
 // ==== ------------------------------------------------------------------------
 // MARK: PrintLn Tracer
 
-private final class TracedLockPrintlnTracer: TracingInstrument {
+private final class TracedLockPrintlnTracer: Tracer {
     func startSpan(
         named operationName: String,
         context: BaggageContextCarrier,
diff --git a/Tests/TracingTests/TracerTests+XCTest.swift b/Tests/TracingTests/TracerTests+XCTest.swift
@@ -11,7 +11,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// TracingInstrumentTests+XCTest.swift
+// TracerTests+XCTest.swift
 //
 import XCTest
 ///
@@ -20,13 +20,13 @@ import XCTest
 /// Do NOT edit this file directly as it will be regenerated automatically when needed.
 ///
 
-extension TracingInstrumentTests {
+extension TracerTests {
 
    @available(*, deprecated, message: "not actually deprecated. Just deprecated to allow deprecated tests (which test deprecated functionality) without warnings")
-   static var allTests : [(String, (TracingInstrumentTests) -> () throws -> Void)] {
+   static var allTests : [(String, (TracerTests) -> () throws -> Void)] {
       return [
                 ("testPlayground", testPlayground),
-                ("testItProvidesAccessToATracingInstrument", testItProvidesAccessToATracingInstrument),
+                ("testItProvidesAccessToATracer", testItProvidesAccessToATracer),
            ]
    }
 }
diff --git a/Tests/TracingTests/TracerTests.swift b/Tests/TracingTests/TracerTests.swift
diff --git a/UseCases/Package.swift b/UseCases/Package.swift
diff --git a/UseCases/Sources/HTTPEndToEnd/main.swift b/UseCases/Sources/HTTPEndToEnd/main.swift
diff --git a/UseCases/Sources/InstrumentsAppTracing/OSSignpostTracing.swift b/UseCases/Sources/InstrumentsAppTracing/OSSignpostTracing.swift
diff --git a/UseCases/Sources/InstrumentsAppTracing/main.swift b/UseCases/Sources/InstrumentsAppTracing/main.swift
diff --git a/UseCases/Sources/ManualAsyncHTTPClient/main.swift b/UseCases/Sources/ManualAsyncHTTPClient/main.swift
diff --git a/UseCases/Sources/ManualContextPropagation/main.swift b/UseCases/Sources/ManualContextPropagation/main.swift

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,8 @@ extension MultiplexInstrument: Instrument {`
`39`	`39`	`)`
`40`	`40`	`where`
`41`	`41`	`Injector: InjectorProtocol,`
`42`		`- Carrier == Injector.Carrier {`
	`42`	`+ Carrier == Injector.Carrier`
	`43`	`+ {`
`43`	`44`	`self.instruments.forEach { $0.inject(context, into: &carrier, using: injector) }`
`44`	`45`	`}`
`45`	`46`
`@@ -48,7 +49,8 @@ extension MultiplexInstrument: Instrument {`
`48`	`49`	`)`
`49`	`50`	`where`
`50`	`51`	`Carrier == Extractor.Carrier,`
`51`		`- Extractor: ExtractorProtocol {`
	`52`	`+ Extractor: ExtractorProtocol`
	`53`	`+ {`
`52`	`54`	`self.instruments.forEach { $0.extract(carrier, into: &context, using: extractor) }`
`53`	`55`	`}`
`54`	`56`	`}`