-
Notifications
You must be signed in to change notification settings - Fork 475
fix(sampling): ensure agent based sampling is not reset after forking and on tracer.configure [backport 3.9] #13744
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
Conversation
… and on tracer.configure (#13560) Builds on 7fbdc9f - Fix: Avoids reinitializing the SpanAggregator on `tracer.configure(...)` and when an application forks. Instead `SpanAggregator.reset()` is called. This operation ensures global configurations are re-applied, trace buffer can be reset, and trace writer is recreated. This ensures agent based sampling rules are not reset. - Clean up - Removes `writer` parameter from `SpanAggregator.__init__(...)` with this change the intialization of the global writer is an implementation detail of the SpanAggregator. There is no longer a need to supply the `SpanAggregator` with a writer on the initialization of the global tracer. - Moves all implementation details of resetting the `SpanAggregator` from `Tracer.configure(...)` and `Tracer._recreate(...)` to `SpanAggregator.reset(...)`. - Removes the initialization of the SpanAggregator from `_default_span_processors_factory`. With this change the global tracer's SpanAggregator is never re-created. It's only modified when `tracer.configure(..)` is used. - Rename `DatadogSampler._service_based_samplers` property to `DatadogSampler._agent_based_sampler` to improve clarity. These sampling rules are no longer supplied via environment variables or a programatic api, they can only be set by the Datadog Agent. - Splits `SpanAggregator.trace_proccessors` into two properties `SpanAggregator.dd_proccessors` and `SpanAggregator.user_processors`. `SpanAggregator.users_proccessors` is set after application startup via `Tracer.configure(..)` while `SpanAggregator.dd_proccessors` is internal to the ddtrace library and should only be set by ddtrace components. This separation allows us to avoid recreating all trace processors when `tracer.configure()` is called. - Adds a more descriptive release note to an unreleased fix. ## 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) --------- Co-authored-by: Brett Langdon <[email protected]> (cherry picked from commit ca79351)
|
|
Bootstrap import analysisComparison of import times between this PR and base. SummaryThe average import time from this PR is: 277 ± 3 ms. The average import time from base is: 280 ± 3 ms. The import time difference between this PR and base is: -2.5 ± 0.1 ms. Import time breakdownThe following import paths have grown:
|
BenchmarksBenchmark execution time: 2025-06-26 19:20:20 Comparing candidate commit 2acd3ee in PR branch Found 0 performance improvements and 4 performance regressions! Performance is the same for 415 metrics, 3 unstable metrics. scenario:iastaspectsospath-ospathbasename_aspect
scenario:iastaspectsospath-ospathnormcase_aspect
scenario:iastaspectsospath-ospathsplitdrive_aspect
scenario:telemetryaddmetric-1-distribution-metric-1-times
|
Backport ca79351 from #13560 to 3.9.
Builds on 7fbdc9f
Fix: Avoids reinitializing the SpanAggregator on
tracer.configure(...)and when an application forks. InsteadSpanAggregator.reset()is called. This operation ensures global configurations are re-applied, trace buffer can be reset, and trace writer is recreated. This ensures agent based sampling rules are not reset.Clean up
writerparameter fromSpanAggregator.__init__(...)with this change the intialization of the global writer is an implementation detail of the SpanAggregator. There is no longer a need to supply theSpanAggregatorwith a writer on the initialization of the global tracer.SpanAggregatorfromTracer.configure(...)andTracer._recreate(...)toSpanAggregator.reset(...)._default_span_processors_factory. With this change the global tracer's SpanAggregator is never re-created. It's only modified whentracer.configure(..)is used.DatadogSampler._service_based_samplersproperty toDatadogSampler._agent_based_samplerto improve clarity. These sampling rules are no longer supplied via environment variables or a programatic api, they can only be set by the Datadog Agent.SpanAggregator.trace_proccessorsinto two propertiesSpanAggregator.dd_proccessorsandSpanAggregator.user_processors.SpanAggregator.users_proccessorsis set after application startup viaTracer.configure(..)whileSpanAggregator.dd_proccessorsis internal to the ddtrace library and should only be set by ddtrace components. This separation allows us to avoid recreating all trace processors whentracer.configure()is called.Adds a more descriptive release note to an unreleased fix.
Checklist
Reviewer Checklist