chore(integrations): make implementation details internal [3.0] #11916
Conversation
This file contains hidden or 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
|
|
Datadog ReportBranch report: ✅ 0 Failed, 130 Passed, 1468 Skipped, 4m 47.51s Total duration (35m 29.13s time saved) |
BenchmarksBenchmark execution time: 2025-01-21 19:43:43 Comparing candidate commit dc211da in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 394 metrics, 2 unstable metrics. |
mabdinur
force-pushed
the
munir/remove-patch-unpatch-get-version-from-public-api
branch
from
8b94fa0 to
8c63bfc
Compare
mabdinur
commented
Jan 14, 2025
mabdinur
commented
Jan 14, 2025
mabdinur
commented
Jan 14, 2025
mabdinur
force-pushed
the
munir/remove-patch-unpatch-get-version-from-public-api
branch
from
77f2c20 to
15474f8
Compare
mabdinur
commented
Jan 14, 2025
@quinna-h to support this use case we can continue expose |
erikayasuda
approved these changes
Jan 16, 2025
ZStriker19
reviewed
Jan 16, 2025
ZStriker19
approved these changes
Jan 16, 2025
gnufede
approved these changes
Jan 17, 2025
juan-fernandez
approved these changes
Jan 20, 2025
Yun-Kim
approved these changes
Jan 20, 2025
mabdinur
changed the title
…2002) ## Motivation - Create a unified public interface for all contrib utils. We will deprecate and redesign this interface in v3.0. - Ensure the `ddtrace.contrib.internal` package is self contained and does rely on `ddtrace.contrib` public interfaces. ## Changes - Deprecates `ddtrace.contrib.redis_utils` module. Expose all public redis_utils in `ddtrace.contrib.trace_utils` (for now). - Deprecates `ddtrace.contrib.trace_utils_async` module. Expose all public async utils to `ddtrace.contrib.trace_utils`. - Deprecates `trace_handlers`, `func_name`, `module_name`, and `require_modules` functions exposed in `ddtrace.contrib.__init__`. These functions are internal to ddtrace. - Moves the implementation details of `trace_utils`, `trace_utils_async`, and `redis_utils` to `ddtrace.contrib.internal.trace_util`. ## 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](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 - [ ] 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)
![datadog-datadog-prod-us1[bot]](https://avatars.githubusercontent.com/u/365230?s=60&v=4){kind=small}
…patch-get-version-from-public-api
emmettbutler
approved these changes
Jan 21, 2025
mabdinur
force-pushed
the
munir/remove-patch-unpatch-get-version-from-public-api
branch
2 times, most recently
from
0c3f738 to
4ff2283
Compare
mabdinur
force-pushed
the
munir/remove-patch-unpatch-get-version-from-public-api
branch
2 times, most recently
from
0feafec to
dc211da
Compare
mabdinur
deleted the
munir/remove-patch-unpatch-get-version-from-public-api
branch
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.
Requires: chore: avoids using deprecated modules in tests and log injection [3.0 prep].
Follow up to: #11918
import ddtrace.auto,ddtrace-runorddtrace.patch(...):ddtrace.contrib.<integration_name>.patch()ddtrace.contrib.<integration_name>.unpatch()ddtrace.contrib.<integration_name>.get_version()patch(),unpatch(), andget_version()functions toddtrace/contrib/internal/. These integrations do not need a public API.ddtrace/contrib/internal/: chore(trace_utils): move implementation details to internal [3.0] #12002Checklist
Reviewer Checklist