-
Notifications
You must be signed in to change notification settings - Fork 417
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.
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
Clarify documentation for current_root_span #9758
Comments
Thanks for noting this, @timmc-edx. We'll clarify the docs. |
This issue has been automatically closed after a period of inactivity. If it's a |
@emmettbutler Is this something you're still planning on fixing? It got auto-closed as stale but I don't see any changes to the docs. |
@timmc-edx - Thanks for reporting this, I have taken an attempt at trying to clarify this wording with #11764 and need the rest of the team to review, but I agree with you that it should be your interpretation of To clarify this a bit further in case anyone else stumbles upon this: In a distributed trace assuming two python applications, ie: AppA --> AppB:
|
Following up on #9758, our current definition of current_root_span is a bit misleading. This attempts to clarify the definition since in a distributed trace, you can't actually use this to grab the root span. (The only thing it consistently returns is "local root"). ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
The documentation for
ddtrace.Tracer.current_root_span
is ambiguous regarding whether this is A) the root span of the entire trace, B) the root span of the current process, or C) the service entry span:Reading the source code, this line implies B, at least to my eyes.
It would be great if the docs could be made clear on this point.
The text was updated successfully, but these errors were encountered: