Remove timestamp, kind and status getters from Span (#127)

Author: pokryfka

Sources/TracingInstrumentation/NoOpTracingInstrument.swift

@@ -46,20 +46,12 @@ public struct NoOpTracingInstrument: TracingInstrument {
         Carrier == Extractor.Carrier {}
 
     public struct NoOpSpan: Span {
-        public var operationName: String = ""
-        public var status: SpanStatus?
-        public let kind: SpanKind = .internal
-
-        public var startTimestamp: Timestamp {
-            return .now()
-        }
-
-        public var endTimestamp: Timestamp?
-
         public var context: BaggageContext {
             return .init()
         }
 
+        public mutating func setStatus(_ status: SpanStatus) {}
+
         public mutating func addLink(_ link: SpanLink) {}
 
         public mutating func addEvent(_ event: SpanEvent) {}

Sources/TracingInstrumentation/Span.swift

@@ -19,24 +19,13 @@ import Baggage
 ///
 /// - SeeAlso: [OpenTelemetry Specification: Span](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md#span).
 public protocol Span {
-    /// The operation name is a human-readable string which concisely identifies the work represented by the `Span`.
-    var operationName: String { get }
-
-    /// The kind of this span.
-    var kind: SpanKind { get }
-
-    /// The status of this span.
-    var status: SpanStatus? { get set }
-
-    /// The `Timestamp` of when the `Span` was started.
-    var startTimestamp: Timestamp { get }
-
-    /// The `Timestamp` of when the `Span` has ended.
-    var endTimestamp: Timestamp? { get }
-
     /// The read-only `BaggageContext` of this `Span`, set when starting this `Span`.
     var context: BaggageContext { get }
 
+    /// 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)

Tests/TracingInstrumentationTests/TracedLockTests.swift

@@ -89,16 +89,12 @@ private final class TracedLockPrintlnTracer: TracingInstrument {
         Carrier == Extractor.Carrier {}
 
     struct TracedLockPrintlnSpan: Span {
-        let operationName: String
-        let kind: SpanKind
+        private let operationName: String
+        private let kind: SpanKind
 
-        var status: SpanStatus? {
-            didSet {
-                self.isRecording = self.status != nil
-            }
-        }
+        private var status: SpanStatus?
 
-        let startTimestamp: Timestamp
+        private let startTimestamp: Timestamp
         private(set) var endTimestamp: Timestamp?
 
         let context: BaggageContext
@@ -133,6 +129,11 @@ private final class TracedLockPrintlnTracer: TracingInstrument {
             print("  span [\(self.operationName): \(self.context[TaskIDKey.self] ?? "no-name")] @ \(self.startTimestamp): start")
         }
 
+        mutating func setStatus(_ status: SpanStatus) {
+            self.status = status
+            self.isRecording = true
+        }
+
         mutating func addLink(_ link: SpanLink) {
             self.links.append(link)
         }

Tests/TracingInstrumentationTests/TracingInstrumentTests.swift

@@ -108,16 +108,12 @@ extension TestTracer {
 // MARK: - TestSpan
 
 struct TestSpan: Span {
-    let operationName: String
-    let kind: SpanKind
+    private let operationName: String
+    private let kind: SpanKind
 
-    var status: SpanStatus? {
-        didSet {
-            self.isRecording = self.status != nil
-        }
-    }
+    private var status: SpanStatus?
 
-    let startTimestamp: Timestamp
+    private let startTimestamp: Timestamp
     private(set) var endTimestamp: Timestamp?
 
     let context: BaggageContext
@@ -154,6 +150,11 @@ struct TestSpan: Span {
         self.kind = kind
     }
 
+    mutating func setStatus(_ status: SpanStatus) {
+        self.status = status
+        self.isRecording = true
+    }
+
     mutating func addLink(_ link: SpanLink) {
         self.links.append(link)
     }

UseCases/Sources/InstrumentsAppTracing/OSSignpostTracing.swift

@@ -81,7 +81,7 @@ public struct OSSignpostTracingInstrument: TracingInstrument {
 @available(tvOS 10.0, *)
 @available(watchOS 3.0, *)
 final class OSSignpostSpan: Span {
-    let operationName: String
+    private let operationName: String
     var context: BaggageContext
 
     private let log: OSLog
@@ -95,11 +95,8 @@ final class OSSignpostSpan: Span {
 
     public let isRecording: Bool
 
-    public let startTimestamp: Timestamp
-    public var endTimestamp: Timestamp?
-
-    public var status: SpanStatus?
-    public let kind: SpanKind = .internal
+    private let startTimestamp: Timestamp
+    private var endTimestamp: Timestamp?
 
     public var baggage: BaggageContext {
         self.context
@@ -194,6 +191,8 @@ final class OSSignpostSpan: Span {
         self.context.signpostTraceParentIDs += [id]
     }
 
+    func setStatus(_ status: SpanStatus) {}
+    
     public func addEvent(_ event: SpanEvent) {
         guard self.isRecording else { return }