Preserve the tracing span in the EndpointDriver task #1616
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The EndpointDriver is spawned in a task. Unless the span is copied into this task the current span is lost. Copying the current span means any tracing calls inside the driver, from e.g. a custom AsyncUdpSocket, are preserved in the span. This makes it easy to use different parent spans for different endpoints and have log messages appear with their parent span. Otherwise these log messages are not attached to a span.
flub
force-pushed
the
endpoint-driver-preserve-span
branch
from
3a0f317
to
ed096d8
Compare
djc
approved these changes
Jul 26, 2023
Ralith
approved these changes
Jul 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The EndpointDriver is spawned in a task. Unless the span is copied into this task the current span is lost.
Copying the current span means any tracing calls inside the driver, from e.g. a custom AsyncUdpSocket, are preserved in the span. This makes it easy to use different parent spans for different endpoints and have log messages appear with their parent span. Otherwise these log messages are not attached to a span.
An alternative is to create a new span using
tracing::info_span!("endpointdriver")instead of copying the current span. This new span would also be correctly attached to the current span as a child.