remove Timestamp type, use DispatchWallTime

Author: ktoso

Sources/Instrumentation/NoOpInstrument.swift

@@ -15,8 +15,7 @@ import CoreBaggage
 
 /// A "no op" implementation of an `Instrument`.
 public struct NoOpInstrument: Instrument {
-    public init() {
-    }
+    public init() {}
 
     public func inject<Carrier, Inject>(_ baggage: Baggage, into carrier: inout Carrier, using injector: Inject)
         where Inject: Injector, Carrier == Inject.Carrier {

Sources/Tracing/NoOpTracer.swift

@@ -12,6 +12,7 @@
 //===----------------------------------------------------------------------===//
 
 @_exported import Baggage
+import Dispatch
 @_exported import Instrumentation
 
 /// No operation Tracer, used when no tracing is required.
@@ -20,7 +21,7 @@ public struct NoOpTracer: Tracer {
         _ operationName: String,
         baggage: Baggage,
         ofKind kind: SpanKind,
-        at timestamp: Timestamp
+        at time: DispatchWallTime
     ) -> Span {
         return NoOpSpan(baggage: baggage)
     }
@@ -62,7 +63,7 @@ public struct NoOpTracer: Tracer {
             }
         }
 
-        public func end(at timestamp: Timestamp) {
+        public func end(at time: DispatchWallTime) {
             // ignore
         }
     }

Sources/Tracing/Span.swift

@@ -12,6 +12,7 @@
 //===----------------------------------------------------------------------===//
 
 @_exported import Baggage
+import Dispatch
 
 /// 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`
@@ -46,7 +47,7 @@ public protocol Span: AnyObject {
     /// - Parameter link: The `SpanLink` to add to this `Span`.
     func addLink(_ link: SpanLink)
 
-    /// End this `Span` at the given timestamp.
+    /// End this `Span` at the given time.
     ///
     /// ### Rules about ending Spans
     /// A Span must be ended only ONCE. Ending a Span multiple times or never at all is considered a programming error.
@@ -56,14 +57,14 @@ public protocol Span: AnyObject {
     /// Implementations SHOULD prevent double-emitting by marking a span as ended internally, however it still is a
     /// programming mistake to rely on this behavior.
     ///
-    /// - Parameter timestamp: The `Timestamp` at which the span ended.
+    /// - Parameter time: The `DispatchWallTime` at which the span ended.
     ///
-    /// - SeeAlso: `Span.end()` which automatically uses the "current" time as timestamp.
-    func end(at timestamp: Timestamp)
+    /// - SeeAlso: `Span.end()` which automatically uses the "current" time.
+    func end(at time: DispatchWallTime)
 }
 
 extension Span {
-    /// End this `Span` at the current timestamp.
+    /// End this `Span` at the current time.
     ///
     /// ### Rules about ending Spans
     /// A Span must be ended only ONCE. Ending a Span multiple times or never at all is considered a programming error.
@@ -73,9 +74,9 @@ extension Span {
     /// Implementations SHOULD prevent double-emitting by marking a span as ended internally, however it still is a
     /// programming mistake to rely on this behavior.
     ///
-    /// - Parameter timestamp: The `Timestamp` at which the span ended.
+    /// - Parameter time: The `DispatchWallTime` at which the span ended.
     ///
-    /// - SeeAlso: `Span.end(at:)` which allows passing in a specific timestamp, e.g. if the operation was ended and recorded somewhere and we need to post-factum record it.
+    /// - SeeAlso: `Span.end(at:)` which allows passing in a specific time, e.g. if the operation was ended and recorded somewhere and we need to post-factum record it.
     ///   Generally though prefer using the `end()` version of this API in user code and structure your system such that it can be called in the right place and time.
     public func end() {
         self.end(at: .now())
@@ -100,18 +101,18 @@ public struct SpanEvent: Equatable {
     /// One or more `SpanAttribute`s with the same restrictions as defined for `Span` attributes.
     public var attributes: SpanAttributes
 
-    /// The `Timestamp` at which this event occurred.
-    public let timestamp: Timestamp
+    /// The `DispatchWallTime` at which this event occurred.
+    public let time: DispatchWallTime
 
     /// Create a new `SpanEvent`.
     /// - Parameters:
     ///   - name: The human-readable name of this event.
     ///   - attributes: attributes describing this event. Defaults to no attributes.
-    ///   - timestamp: The `Timestamp` at which this event occurred. Defaults to `.now()`.
-    public init(name: String, attributes: SpanAttributes = [:], at timestamp: Timestamp = .now()) {
+    ///   - time: The `DispatchWallTime` at which this event occurred. Defaults to `.now()`.
+    public init(name: String, attributes: SpanAttributes = [:], at time: DispatchWallTime = .now()) {
         self.name = name
         self.attributes = attributes
-        self.timestamp = timestamp
+        self.time = time
     }
 }
 

Sources/Tracing/Timestamp.swift

@@ -12,23 +12,24 @@
 //===----------------------------------------------------------------------===//
 
 @_exported import Baggage
+import Dispatch
 @_exported 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 Tracer: Instrument {
-    /// Start a new `Span` with the given `Baggage` at a given timestamp.
+    /// Start a new `Span` with the given `Baggage` at a given time.
     ///
     /// - Parameters:
     ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
     ///   - baggage: The `Baggage` providing information on where to start the new `Span`.
     ///   - kind: The `SpanKind` of the new `Span`.
-    ///   - timestamp: The `DispatchTime` at which to start the new `Span`.
+    ///   - time: The `DispatchTime` at which to start the new `Span`.
     func startSpan(
         _ operationName: String,
         baggage: Baggage,
         ofKind kind: SpanKind,
-        at timestamp: Timestamp
+        at time: DispatchWallTime
     ) -> Span
 
     /// Export all ended spans to the configured backend that have not yet been exported.

Sources/Tracing/Tracer.swift

@@ -38,7 +38,6 @@ class LinuxMainRunnerImpl: LinuxMainRunner {
              testCase(InstrumentationSystemTests.allTests),
              testCase(SpanAttributeSemanticsTests.allTests),
              testCase(SpanTests.allTests),
-             testCase(TimestampTests.allTests),
              testCase(TracedLockTests.allTests),
              testCase(TracerTests.allTests),
              testCase(TracingInstrumentationSystemTests.allTests),

Tests/LinuxMain.swift

@@ -143,15 +143,15 @@ final class SpanTests: XCTestCase {
 
         let parent = TestSpan(
             operationName: "client",
-            startTimestamp: .now(),
+            startTime: .now(),
             baggage: parentBaggage,
             kind: .client,
             onEnd: { _ in }
         )
         let childBaggage = Baggage.topLevel
         let child = TestSpan(
             operationName: "server",
-            startTimestamp: .now(),
+            startTime: .now(),
             baggage: childBaggage,
             kind: .server,
             onEnd: { _ in }

Tests/TracingTests/SpanTests.swift

@@ -12,6 +12,7 @@
 //===----------------------------------------------------------------------===//
 
 import Baggage
+import Dispatch
 import Foundation
 import Instrumentation
 import Tracing
@@ -23,11 +24,11 @@ final class TestTracer: Tracer {
         _ operationName: String,
         baggage: Baggage,
         ofKind kind: SpanKind,
-        at timestamp: Timestamp
+        at time: DispatchWallTime
     ) -> Span {
         let span = TestSpan(
             operationName: operationName,
-            startTimestamp: timestamp,
+            startTime: time,
             baggage: baggage,
             kind: kind
         ) { _ in }
@@ -77,8 +78,8 @@ final class TestSpan: Span {
 
     private var status: SpanStatus?
 
-    private let startTimestamp: Timestamp
-    private(set) var endTimestamp: Timestamp?
+    private let startTime: DispatchWallTime
+    private(set) var endTime: DispatchWallTime?
 
     let baggage: Baggage
 
@@ -102,13 +103,13 @@ final class TestSpan: Span {
 
     init(
         operationName: String,
-        startTimestamp: Timestamp,
+        startTime: DispatchWallTime,
         baggage: Baggage,
         kind: SpanKind,
         onEnd: @escaping (Span) -> Void
     ) {
         self.operationName = operationName
-        self.startTimestamp = startTimestamp
+        self.startTime = startTime
         self.baggage = baggage
         self.onEnd = onEnd
         self.kind = kind
@@ -129,8 +130,8 @@ final class TestSpan: Span {
 
     func recordError(_ error: Error) {}
 
-    func end(at timestamp: Timestamp) {
-        self.endTimestamp = timestamp
+    func end(at time: DispatchWallTime) {
+        self.endTime = time
         self.onEnd(self)
     }
 }