Skip to content

Commit e9972f9

Browse files
chore(docs): update baggage tags config (#13577)
## 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: Rachel Yang <[email protected]>
1 parent 733711e commit e9972f9

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

docs/configuration.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -919,11 +919,9 @@ Other
919919
default: "user.id,account.id,session.id"
920920

921921
description: |
922-
A comma-separated list of baggage keys to be automatically attached as tags on spans.
923-
For each key specified, if a corresponding baggage key is present and has a non-empty value,
924-
the key-value pair will be added to the span's metadata using the key name formatted as ``baggage.<key>``.
925-
If you want to turn off this feature, set the configuration value to an empty string.
926-
When set to `*`, **all** baggage keys will be converted into span tags. Use with caution: this may unintentionally expose sensitive or internal data if not used intentionally.
922+
A comma-separated list of baggage keys, sent via HTTP headers, to automatically tag as baggage.<key> on the local root span.
923+
Only baggage extracted from incoming headers is supported. Baggage set via ``Context.set_baggage_item(..., ...)`` is not included. Keys must have non-empty values.
924+
Set to * to tag all baggage keys (use with caution to avoid exposing sensitive data). Set to an empty string to disable the feature.
927925

928926
version_added:
929927
v3.6.0:

0 commit comments

Comments
 (0)