chore(configs): internalize global config module and ddtrace.config's rc and http attributes [3.0] #12055

mabdinur · 2025-01-23T20:18:00Z

Prefixes the following ddtrace.config attributes with an _. These attributes are internal to the tracer and should not be referenced or modified by users. Users should enable remote configuration and set http configurations via environment variables:
- http
- http_server
- trace_headers
- header_is_traced
- convert_rc_trace_sampling_rules
- enable_remote_configuration
- get_from
Deprecates ddtrace/settings/config.py and moves implementation details to ddtrace/settings/_config.py. Moving forward we will avoid exposing the implementation details for setting ddtrace configurations. All (or at least most) ddtrace configurations will be migrated to envier in v3.0.

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

github-actions · 2025-01-23T20:18:30Z

CODEOWNERS have been resolved as:

ddtrace/settings/_config.py                                             @DataDog/apm-core-python
releasenotes/notes/munir-deprecate-rc-http-configs-206f6c60ff383c05.yaml  @DataDog/apm-python
ddtrace/__init__.py                                                     @DataDog/apm-core-python
ddtrace/_monkey.py                                                      @DataDog/apm-core-python
ddtrace/_trace/sampler.py                                               @DataDog/apm-sdk-api-python
ddtrace/contrib/flask/__init__.py                                       @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/httplib/__init__.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/aiohttp/middlewares.py                         @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/botocore/patch.py                              @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/dramatiq/patch.py                              @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/httplib/patch.py                               @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/requests/connection.py                         @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/sanic/patch.py                                 @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/tornado/handlers.py                            @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/internal/trace_utils.py                                 @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/jinja2/__init__.py                                      @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/requests/__init__.py                                    @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/internal/remoteconfig/worker.py                                 @DataDog/remote-config @DataDog/apm-core-python
ddtrace/internal/sampling.py                                            @DataDog/apm-sdk-api-python
ddtrace/internal/writer/writer.py                                       @DataDog/apm-core-python
ddtrace/propagation/_database_monitoring.py                             @DataDog/apm-sdk-api-python
ddtrace/settings/__init__.py                                            @DataDog/apm-core-python
ddtrace/settings/config.py                                              @DataDog/python-guild @DataDog/apm-sdk-api-python
ddtrace/settings/dynamic_instrumentation.py                             @DataDog/debugger-python
ddtrace/settings/integration.py                                         @DataDog/apm-core-python
docs/advanced_usage.rst                                                 @DataDog/python-guild
tests/ci_visibility/test_ci_visibility.py                               @DataDog/ci-app-libraries
tests/contrib/httplib/test_httplib_distributed.py                       @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/jinja2/test_jinja2.py                                     @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/requests/test_requests.py                                 @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/requests/test_requests_distributed.py                     @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/tornado/test_tornado_web.py                               @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/vertica/test_vertica.py                                   @DataDog/apm-core-python @DataDog/apm-idm-python
tests/internal/remoteconfig/test_remoteconfig.py                        @DataDog/remote-config @DataDog/apm-core-python
tests/internal/test_settings.py                                         @DataDog/apm-core-python
tests/telemetry/test_writer.py                                          @DataDog/apm-python
tests/tracer/test_env_vars.py                                           @DataDog/apm-sdk-api-python
tests/tracer/test_global_config.py                                      @DataDog/apm-sdk-api-python
tests/tracer/test_instance_config.py                                    @DataDog/apm-sdk-api-python
tests/tracer/test_settings.py                                           @DataDog/apm-sdk-api-python
tests/tracer/test_trace_utils.py                                        @DataDog/apm-sdk-api-python

datadog-dd-trace-py-rkomorn · 2025-01-23T21:54:42Z

Datadog Report

Branch report: munir/deprecate-configs
Commit report: 130b69b
Test service: dd-trace-py

✅ 0 Failed, 130 Passed, 1468 Skipped, 4m 42.63s Total duration (36m 29.15s time saved)

pr-commenter · 2025-01-23T22:52:26Z

Benchmarks

Benchmark execution time: 2025-01-24 18:22:30

Comparing candidate commit 130b69b in PR branch munir/deprecate-configs with baseline commit b90fa38 in branch main.

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

ddtrace/settings/_config.py

releasenotes/notes/munir-deprecate-rc-http-configs-206f6c60ff383c05.yaml

update rn more nits

releasenotes/notes/munir-deprecate-rc-http-configs-206f6c60ff383c05.yaml

Co-authored-by: Emmett Butler <[email protected]>

releasenotes/notes/munir-deprecate-rc-http-configs-206f6c60ff383c05.yaml

github-actions · 2025-01-24T21:03:42Z

The backport to 2.20 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.20 2.20
# Navigate to the new working tree
cd .worktrees/backport-2.20
# Create a new branch
git switch --create backport-12055-to-2.20
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 48c6547b8eb0cd10be7229ca78cc52704f62e14d
# Push it to GitHub
git push --set-upstream origin backport-12055-to-2.20
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.20

Then, create a pull request where the base branch is 2.20 and the compare/head branch is backport-12055-to-2.20.

Prefixes the following `ddtrace.config` attributes with an `_`. These attributes are internal to the tracer and should not be referenced or modified by users: - http - http_server - trace_headers - header_is_traced - convert_rc_trace_sampling_rules - enable_remote_configuration - get_from Users should enable remote configuration and set `http` configurations via environment variables. - [ ] 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 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)

mabdinur force-pushed the munir/deprecate-configs branch from 24f5c72 to 1bc3d74 Compare January 23, 2025 20:25

mabdinur changed the title ~~chore(ddtrace.config): make rc and integration configs/methods internal~~ chore(configs): make rc and http configs internal Jan 23, 2025

mabdinur force-pushed the munir/deprecate-configs branch 2 times, most recently from 37c1907 to e8d8a7f Compare January 23, 2025 21:53

mabdinur force-pushed the munir/deprecate-configs branch from e8d8a7f to cd4acb3 Compare January 23, 2025 21:56

mabdinur added the backport 2.20 label Jan 23, 2025

DataDog deleted a comment from pr-commenter bot Jan 23, 2025

mabdinur marked this pull request as ready for review January 23, 2025 21:57

mabdinur requested review from a team as code owners January 23, 2025 21:57

mabdinur requested review from ZStriker19, emmettbutler and quinna-h January 23, 2025 21:57

mabdinur changed the title ~~chore(configs): make rc and http configs internal~~ chore(configs): make rc and http configs internal [3.0] Jan 23, 2025

mabdinur force-pushed the munir/deprecate-configs branch from cd4acb3 to 19d845c Compare January 23, 2025 22:03

chore(configs): lock down integration configs

fcc884b

mabdinur force-pushed the munir/deprecate-configs branch from 19d845c to fcc884b Compare January 23, 2025 22:08

mabdinur requested a review from a team as a code owner January 23, 2025 22:11

rn

d617660

mabdinur force-pushed the munir/deprecate-configs branch from 55e0493 to d617660 Compare January 23, 2025 22:12

Merge branch 'main' into munir/deprecate-configs

e3b4e8b

mabdinur enabled auto-merge (squash) January 23, 2025 23:20

mabdinur requested a review from erikayasuda January 23, 2025 23:20

datadog-datadog-prod-us1 bot reviewed Jan 23, 2025

View reviewed changes

mabdinur commented Jan 23, 2025

View reviewed changes

releasenotes/notes/munir-deprecate-rc-http-configs-206f6c60ff383c05.yaml Outdated Show resolved Hide resolved

mabdinur requested a review from a team as a code owner January 23, 2025 23:47

mabdinur requested review from nikita-tkachenko-datadog and vitor-de-araujo January 23, 2025 23:47

mabdinur force-pushed the munir/deprecate-configs branch from b1c43f5 to 3597a14 Compare January 23, 2025 23:59

mabdinur requested a review from a team as a code owner January 23, 2025 23:59

deprecate config module

9cb55dc

update rn more nits

mabdinur force-pushed the munir/deprecate-configs branch from 3597a14 to 9cb55dc Compare January 24, 2025 00:00

mabdinur changed the title ~~chore(configs): make rc and http configs internal [3.0]~~ chore(configs): internalize config module and rc and http attributes [3.0] Jan 24, 2025

mabdinur changed the title ~~chore(configs): internalize config module and rc and http attributes [3.0]~~ chore(configs): internalize config module and ddtrace.config's rc and http attributes [3.0] Jan 24, 2025

mabdinur changed the title ~~chore(configs): internalize config module and ddtrace.config's rc and http attributes [3.0]~~ chore(configs): internalize global config module and ddtrace.config's rc and http attributes [3.0] Jan 24, 2025

vitor-de-araujo approved these changes Jan 24, 2025

View reviewed changes

emmettbutler approved these changes Jan 24, 2025

View reviewed changes

releasenotes/notes/munir-deprecate-rc-http-configs-206f6c60ff383c05.yaml Outdated Show resolved Hide resolved

rn

4cc7862

Co-authored-by: Emmett Butler <[email protected]>

P403n1x87 approved these changes Jan 24, 2025

View reviewed changes

ZStriker19 reviewed Jan 24, 2025

View reviewed changes

releasenotes/notes/munir-deprecate-rc-http-configs-206f6c60ff383c05.yaml Show resolved Hide resolved

ZStriker19 approved these changes Jan 24, 2025

View reviewed changes

mabdinur added 2 commits January 24, 2025 12:36

Merge remote-tracking branch 'origin/main' into munir/deprecate-configs

1247721

rn

130b69b

mabdinur merged commit 48c6547 into main Jan 24, 2025
748 checks passed

mabdinur deleted the munir/deprecate-configs branch January 24, 2025 21:03

mabdinur mentioned this pull request Jan 24, 2025

chore(configs): make rc and http configs internal [3.0] [backport #12055 2.20] #12086

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(configs): internalize global config module and ddtrace.config's rc and http attributes [3.0] #12055

chore(configs): internalize global config module and ddtrace.config's rc and http attributes [3.0] #12055

mabdinur commented Jan 23, 2025 •

edited by vitor-de-araujo

Loading

github-actions bot commented Jan 23, 2025 •

edited

Loading

datadog-dd-trace-py-rkomorn bot commented Jan 23, 2025 •

edited

Loading

pr-commenter bot commented Jan 23, 2025 •

edited

Loading

github-actions bot commented Jan 24, 2025

chore(configs): internalize global config module and ddtrace.config's rc and http attributes [3.0] #12055

chore(configs): internalize global config module and ddtrace.config's rc and http attributes [3.0] #12055

Conversation

mabdinur commented Jan 23, 2025 • edited by vitor-de-araujo Loading

Checklist

Reviewer Checklist

github-actions bot commented Jan 23, 2025 • edited Loading

datadog-dd-trace-py-rkomorn bot commented Jan 23, 2025 • edited Loading

Datadog Report

pr-commenter bot commented Jan 23, 2025 • edited Loading

Benchmarks

github-actions bot commented Jan 24, 2025

mabdinur commented Jan 23, 2025 •

edited by vitor-de-araujo

Loading

github-actions bot commented Jan 23, 2025 •

edited

Loading

datadog-dd-trace-py-rkomorn bot commented Jan 23, 2025 •

edited

Loading

pr-commenter bot commented Jan 23, 2025 •

edited

Loading