Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add activeSpan method to TracerProtocol #160

Merged
merged 3 commits into from
Jan 14, 2025
Merged

Add activeSpan method to TracerProtocol #160

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
daf4e6b
Add recordingSpan and currentSpan methods to TracerProtocol
slashmo Dec 16, 2024
d2a4716
Remove currentSpan() syntax sugar
slashmo Jan 14, 2025
6ae210e
Rename recordingSpan(context:) to activeSpan(context:)
slashmo Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions Sources/Tracing/TracerProtocol.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,14 @@ public protocol Tracer: LegacyTracer {
file fileID: String,
line: UInt
) -> Self.Span

/// Retrieve the recording span for the given `ServiceContext`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/recording/active

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😬 Thanks for noticing. I'll create a follow-up to rename the comment.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in #164

///
/// - Note: This API does not enable look up of already finished spans.
/// It was added retroactively with a default implementation returning `nil` and therefore isn't guaranteed to be implemented by all `Tracer`s.
/// - Parameter context: The context containing information that uniquely identifies the span being obtained.
/// - Returns: The span identified by the given `ServiceContext` in case it's still recording.
func activeSpan(identifiedBy context: ServiceContext) -> Span?
}

@available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *) // for TaskLocal ServiceContext
Expand Down Expand Up @@ -106,6 +114,15 @@ extension Tracer {
line: line
)
}

/// Default implementation for ``activeSpan(identifiedBy:)`` which always returns `nil`.
/// This default exists in order to facilitate source-compatible introduction of the ``activeSpan(identifiedBy:)`` protocol requirement.
///
/// - Parameter context: The context containing information that uniquely identifies the span being obtained.
/// - Returns: `nil`.
public func activeSpan(identifiedBy context: ServiceContext) -> Span? {
nil
}
}

// ==== ----------------------------------------------------------------------------------------------------------------
Expand Down
Loading