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.

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

chore: clarify usage and wording for current_root_span #11764

Merged
merged 5 commits into from
Jan 8, 2025

Conversation

wantsui
Copy link
Collaborator

@wantsui wantsui commented Dec 17, 2024

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

  • 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
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • 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 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

@wantsui wantsui changed the title Clarify usage and wording for current_root_span. chore: clarify usage and wording for current_root_span. Dec 17, 2024
@wantsui wantsui changed the title chore: clarify usage and wording for current_root_span. chore: clarify usage and wording for current_root_span Dec 17, 2024
@wantsui wantsui added the changelog/no-changelog A changelog entry is not required for this PR. label Dec 17, 2024
@wantsui wantsui marked this pull request as ready for review December 17, 2024 23:11
@wantsui wantsui requested a review from a team as a code owner December 17, 2024 23:11
Copy link
Contributor

CODEOWNERS have been resolved as:

ddtrace/_trace/tracer.py                                                @DataDog/apm-sdk-api-python

@pr-commenter
Copy link

pr-commenter bot commented Dec 17, 2024

Benchmarks

Benchmark execution time: 2025-01-08 21:44:44

Comparing candidate commit a8486ab in PR branch wantsui/clarify-current-root-span with baseline commit 6c61f40 in branch main.

Found 2 performance improvements and 1 performance regressions! Performance is the same for 391 metrics, 2 unstable metrics.

scenario:iast_aspects-ospathsplit_aspect

  • 🟥 execution_time [+339.948ns; +412.243ns] or [+8.772%; +10.637%]

scenario:iast_aspects-ospathsplitext_aspect

  • 🟩 execution_time [-445.651ns; -389.003ns] or [-11.098%; -9.687%]

scenario:iast_aspects-split_aspect

  • 🟩 execution_time [-181.622ns; -149.493ns] or [-9.481%; -7.804%]

@wantsui
Copy link
Collaborator Author

wantsui commented Jan 8, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 8, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-01-08 15:43:32 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2025-01-08 18:33:01 UTC ⚠️ MergeQueue: This merge request was unqueued

[email protected] unqueued this merge request

@wantsui
Copy link
Collaborator Author

wantsui commented Jan 8, 2025

/remove

@dd-devflow
Copy link

dd-devflow bot commented Jan 8, 2025

Devflow running: /remove

View all feedbacks in Devflow UI.


2025-01-08 18:32:59 UTC ℹ️ Devflow: /remove

@datadog-dd-trace-py-rkomorn
Copy link

datadog-dd-trace-py-rkomorn bot commented Jan 8, 2025

Datadog Report

Branch report: wantsui/clarify-current-root-span
Commit report: a8486ab
Test service: dd-trace-py

✅ 0 Failed, 87 Passed, 1468 Skipped, 3m 41.98s Total duration (35m 26.08s time saved)

@wantsui wantsui enabled auto-merge (squash) January 8, 2025 21:39
@wantsui wantsui merged commit 75bed24 into main Jan 8, 2025
637 checks passed
@wantsui wantsui deleted the wantsui/clarify-current-root-span branch January 8, 2025 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR. mergequeue-status: removed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants