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.

Sign up for GitHub

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

Jump to bottom

[BUG]: Docs refer to deprecated tracer.configure call for trace filter configuration #12141

Open
JamesHarrison opened this issue Jan 29, 2025 · 1 comment · Fixed by #12147
Open

[BUG]: Docs refer to deprecated tracer.configure call for trace filter configuration #12141

JamesHarrison opened this issue Jan 29, 2025 · 1 comment · Fixed by #12147
Assignees
@mabdinur
Labels
bug

Comments

@JamesHarrison
Copy link

Tracer Version(s)

2.20

Python Version(s)

3.12

Pip Version(s)

pip 24.0

Bug Report

Currently configuring a trace filter per the docs like so:

tracer.configure(
    settings={
        "FILTERS": [
            FilterBoringTraces(r"http[s]*:\/\/.+\/(readyz|healthz)"),
        ],
    },
)

Results in this deprecation warning:

lib/python3.12/site-packages/ddtrace/_trace/tracer.py:498: DDTraceDeprecationWarning: Support for ``tracer.configure(...)`` with the settings parameter is deprecated in version '3.0.0': Please use the trace_processors parameter instead of settings['FILTERS'].

However, the docs still say this is the correct behaviour and trace_processors doesn't appear to be documented:

https://ddtrace.readthedocs.io/en/stable/advanced_usage.html#trace-filtering

The docs should be updated with correct usage in advance of deprecation notices being added.

Reproduction Code

No response

Error Logs

No response

Libraries in Use

No response

Operating System

No response
@mabdinur mabdinur mentioned this issue Jan 29, 2025
Merged
2 tasks
@mabdinur mabdinur self-assigned this Jan 29, 2025
@mabdinur
Copy link
Contributor

Hey @JamesHarrison,

Thanks for calling this out. I opened a PR to resolve this issue.

mabdinur added a commit that referenced this issue Jan 29, 2025
@mabdinur
docs: update trace filter docs (#12147)
8ff2ecb 
Resolves: #12141

## 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)
github-actions bot pushed a commit that referenced this issue Jan 29, 2025
@mabdinur @github-actions
docs: update trace filter docs (#12147)
72d7d3b 
Resolves: #12141

## 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)

(cherry picked from commit 8ff2ecb)
@github-actions github-actions bot mentioned this issue Jan 29, 2025
Merged
2 tasks
mabdinur added a commit that referenced this issue Jan 29, 2025
@github-actions @mabdinur
docs: update trace filter docs [backport 2.20] (#12149)
ccd6f75 
Backport 8ff2ecb from #12147 to 2.20.

Resolves: #12141

## 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: Munir Abdinur <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mabdinur mabdinur

Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update trace filter docs DataDog/dd-trace-py
2 participants
@JamesHarrison @mabdinur