Skip to content

Commit ccd6f75

Browse files
docs: update trace filter docs [backport 2.20] (#12149)
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]>
1 parent a39d78e commit ccd6f75

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

docs/advanced_usage.rst

+2-6
Original file line numberDiff line numberDiff line change
@@ -342,11 +342,7 @@ all traces of incoming requests to a specific url::
342342
return None
343343
return trace
344344

345-
tracer.configure(settings={
346-
'FILTERS': [
347-
FilterbyName(),
348-
],
349-
})
345+
tracer.configure(trace_processors=[FilterbyName()])
350346

351347
The filters in the filters list will be applied sequentially to each trace
352348
and the resulting trace will either be sent to the Agent or discarded.
@@ -367,7 +363,7 @@ the pipeline or ``None`` if the trace should be discarded::
367363
...
368364

369365
# And then configure it with
370-
tracer.configure(settings={'FILTERS': [FilterExample()]})
366+
tracer.configure(trace_processors=[FilterExample()])
371367

372368
(see filters.py for other example implementations)
373369

docs/troubleshooting.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ While this is default behavior for integrations, users can add a trace filter to
9191
return trace
9292

9393

94-
tracer.configure(settings={'FILTERS': [ErrorFilter()]})
94+
tracer.configure(trace_processors=[ErrorFilter()])
9595

9696

9797

0 commit comments

Comments
 (0)