-
Notifications
You must be signed in to change notification settings - Fork 395
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: deprecate the span= arguments on ExecutionContext methods #7957
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
emmettbutler
added
the
changelog/no-changelog
A changelog entry is not required for this PR.
label
Dec 19, 2023
majorgreys
approved these changes
Dec 20, 2023
BenchmarksBenchmark execution time: 2024-01-02 20:08:38 Comparing candidate commit e29200b in PR branch Found 3 performance improvements and 8 performance regressions! Performance is the same for 184 metrics, 9 unstable metrics. scenario:coreapiscenario-get_item_exists
scenario:coreapiscenario-get_item_missing
scenario:flasksimple-appsec-get
scenario:flasksimple-appsec-post
scenario:flasksimple-baseline
scenario:otelspan-add-metrics
scenario:otelspan-add-tags
scenario:otelspan-start
scenario:otelspan-start-finish
scenario:otelspan-start-finish-telemetry
|
ZStriker19
pushed a commit
to haozhun/dd-trace-py
that referenced
this pull request
Jan 8, 2024
…aDog#7957) This pull request deprecates the `span` arguments on `ExecutionContext` methods to indicate that they are only for backward compatibility and not meant to be used by newly written code. This has been the plan since the beginning of the core API in DataDog#6202 (comment). Deprecations are usually used for non-internal functionality, but I think a deprecation is appropriate in this internal case as we encourage broader usage of the core API. ## Checklist - [x] Change(s) are motivated and described in the PR description. - [x] Testing strategy is described if automated tests are not included in the PR. - [x] Risk is outlined (performance impact, potential for breakage, maintainability, etc). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] [Library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) are followed. If no release note is required, add label `changelog/no-changelog`. - [x] Documentation is included (in-code, generated user docs, [public corp docs](https://github.com/DataDog/documentation/)). - [x] Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Title is accurate. - [x] No unnecessary changes are introduced. - [x] Description motivates each change. - [x] Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes unless absolutely necessary. - [x] Testing strategy adequately addresses listed risk(s). - [x] Change is maintainable (easy to change, telemetry, documentation). - [x] Release note makes sense to a user of the library. - [x] Reviewer has explicitly acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment. - [x] 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) - [x] If this PR touches code that signs or publishes builds or packages, or handles credentials of any kind, I've requested a review from `@DataDog/security-design-and-guidance`. - [x] This PR doesn't touch any of that.
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.
This pull request deprecates the
span
arguments onExecutionContext
methods to indicate that they are only for backward compatibility and not meant to be used by newly written code. This has been the plan since the beginning of the core API in #6202 (comment).Deprecations are usually used for non-internal functionality, but I think a deprecation is appropriate in this internal case as we encourage broader usage of the core API.
This changed caused a failure in the fastapi framework test suite, which I think is the result of that test being too strict in its expectations. This pull request skips that test and adds a fallback that avoids the deprecation warning when fastapi is loaded. I've also opened tiangolo/fastapi#10876 making the fastapi framework test more permissive.
Checklist
changelog/no-changelog
.Reviewer Checklist
@DataDog/security-design-and-guidance
.