Fix trace and traceSync not creating root spans when newRoot is true #214
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
…eating new root spans even when a context with a span is attached to the root zone
|
QA +1 CI is sufficient |
aaronforest-wf
approved these changes
Mar 3, 2025
matthewnitschke-wk
approved these changes
Mar 4, 2025
| attributes: spanAttributes, | ||
| kind: spanKind, | ||
| links: spanLinks); | ||
| // TODO: use start span option `newRoot` instead |
There was a problem hiding this comment.
Has this TODO essentially been resolved now? thoughts on removing it here and below?
There was a problem hiding this comment.
No. The option is only on the sdk's implementation class of the api's interface which doesn't have the option. The next breaking release (0.16.0) will need to contain the change to add the new option to the interface that will allow us to remove this TODO and simplify the code down to just invoking the method on the given interface
|
@Workiva/release-management-p |
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.
Which problem is this PR solving?
traceandtraceSynchave anewRootoptional parameter that works by usingContext.rootto start the span. However, if there is a context with a span attached to the root zone, then usingContext.rootwill make the span a child of the one held by the context attached to the root zone.Short description of the change
The
Tracerdefined by the SDK supports thenewRootoptional parameter that results in appropriately configuring the span's parent span context to be invalid regardless of any span potentially visible via the given context.However, the
Tracerdefined by the API does not support thenewRootoptional parameter. Ideally, this interface would be updated to include the optional parameter. But this is a breaking change.Therefore, to resolve the issue of
newRootnot creating root spans,traceandtraceSynctype check thetracerto see if it is the SDK'sTracer. If so, the tracer'snewRootoption is used. Otherwise, the API'straceris used as usual.How Has This Been Tested?
The unit tests added in this PR were ran with and without the changes. Without the changes, the unit tests fail. With the changes, the unit tests pass.
Checklist: