Skip to content

Commit cf16c0a

Browse files
committed
Add recordingSpan and currentSpan methods to TracerProtocol
**Motivation:** Currently, it is only possible to implicitly work with the current span by transparently creating a child span (using ServiceContext.current) under the hood. This is sufficient for almost all use-cases, but does not work in case a piece of code wants to add an event to the current span without having a handle on said span, e.g. if the span was created by a library. **Modifications:** I added a `recordingSpan(identifiedBy context: ServiceContext) -> Span?` requirement to `TracerProtocol`. This way, `Tracer` implementations may look up and return a span identified by the data they stored in the provided `ServiceContext`. It's worth noting that this method is only intended for obtaining spans which are still recording as opposed to already ended ones that may not even be in memory anymore. I also added a default implementation of this method to avoid introducing a breaking change. On top of this new protocol requirement, I added an extension to `TracerProtocol` with sugar to obtain the current span based on the task-local `ServiceContext`. **Result:** Library authors and application developers are now able to look up the current recording span to interact with it by e.g. adding events and attributes.
1 parent 55a0bf7 commit cf16c0a

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

Sources/Tracing/TracerProtocol.swift

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@ public protocol Tracer: LegacyTracer {
5959
file fileID: String,
6060
line: UInt
6161
) -> Self.Span
62+
63+
/// Retrieve the recording span for the given `ServiceContext`.
64+
///
65+
/// - Note: This API does not enable look up of already finished spans.
66+
/// - Parameter context: The context containing information that uniquely identifies the span being obtained.
67+
/// - Returns: The span identified by the given `ServiceContext` in case it's still recording.
68+
func recordingSpan(identifiedBy context: ServiceContext) -> Span?
6269
}
6370

6471
@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal ServiceContext
@@ -106,6 +113,23 @@ extension Tracer {
106113
line: line
107114
)
108115
}
116+
117+
/// Attempt to retrieve the span for the given `ServiceContext`.
118+
///
119+
/// - Parameter context: The context containing information that uniquely identifies the span being obtained.
120+
/// - Returns: The span which created the given `ServiceContext`.
121+
public func recordingSpan(identifiedBy context: ServiceContext) -> Span? {
122+
nil
123+
}
124+
125+
/// Attempt to retrieve the current recording span based on the task-local `ServiceContext`.
126+
///
127+
/// - Returns: A span if one can be obtained via the task-local `ServiceContext`.
128+
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
129+
public func currentSpan() -> Span? {
130+
guard let context = ServiceContext.current else { return nil }
131+
return recordingSpan(identifiedBy: context)
132+
}
109133
}
110134

111135
// ==== ----------------------------------------------------------------------------------------------------------------

0 commit comments

Comments
 (0)