Skip to content

Commit 27d986b

Browse files
Adding Baggage Span Tags docs (#29821)
* Adding Baggage Span Tags docs * Update content/en/tracing/trace_collection/library_config/_index.md Co-authored-by: Brett Blue <[email protected]> * Update content/en/tracing/trace_collection/library_config/_index.md Co-authored-by: Brett Blue <[email protected]> * Update content/en/tracing/trace_collection/library_config/_index.md Co-authored-by: Brett Blue <[email protected]> * Update _index.md * Update content/en/tracing/trace_collection/library_config/_index.md Co-authored-by: Brett Blue <[email protected]> * Update content/en/tracing/trace_collection/library_config/_index.md Co-authored-by: Brett Blue <[email protected]> * Update content/en/tracing/trace_collection/trace_context_propagation/_index.md Co-authored-by: Brett Blue <[email protected]> * Update content/en/tracing/trace_collection/library_config/_index.md Co-authored-by: Brett Blue <[email protected]> * Update _index.md --------- Co-authored-by: Brett Blue <[email protected]>
1 parent 6b85c79 commit 27d986b

File tree

2 files changed

+26
-2
lines changed
  • content/en/tracing/trace_collection

2 files changed

+26
-2
lines changed

content/en/tracing/trace_collection/library_config/_index.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,26 @@ The following configuration options behave consistently across the latest versio
221221
- `cf-connecting-ip`
222222
- `cf-connecting-ipv6`
223223
224+
### Context propagation
225+
`DD_TRACE_BAGGAGE_MAX_ITEMS`
226+
: **Default**: `64` <br>
227+
**Supported Input**: A positive integer <br>
228+
**Description**: The maximum number of key-value pairs in the baggage header.
229+
230+
`DD_TRACE_BAGGAGE_MAX_BYTES`
231+
: **Default**: `8192` <br>
232+
**Supported Input**: A positive integer <br>
233+
**Description**: The maximum number of bytes in the baggage header value. Values less than 3 bytes prevent propagation, because this is the minimum size for a valid key-value pair (for example, `k=v`).
234+
235+
`DD_TRACE_BAGGAGE_TAG_KEYS`
236+
: **Default**: `user.id,session.id,account.id` <br>
237+
**Supported Input**: A comma-separated string representing a list of case-sensitive baggage keys <br>
238+
**Caveats**: Not supported in Java, Ruby, Go, C++, and .NET <br>
239+
**Description**: A comma-separated list of baggage keys that are automatically applied as span tags to the local root span. For example, a baggage key `user.id` is tagged as `baggage.user.id` <br>
240+
This feature only applies to baggage extracted from incoming HTTP headers. Baggage set with the baggage API is not included.
241+
- To tag all baggage items, set the value to `*`. Use this with caution to avoid exposing sensitive data in tags.
242+
- To disable this feature, set the value to an empty string.
243+
224244
225245
[1]: /developers/community/libraries/#apm-tracing-client-libraries
226246
[2]: /tracing/trace_collection/compatibility/java/#framework-integrations-disabled-by-default

content/en/tracing/trace_collection/trace_context_propagation/_index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -641,10 +641,13 @@ When the Datadog SDK is configured with the None format for extraction or inject
641641

642642
### Baggage
643643

644-
_Currently available in Python, Ruby, PHP, Java, Node.js, C++, Go and .NET. For other languages, please reach out to [Support][11]_
645-
646644
By default, Baggage is automatically propagated through a distributed request using OpenTelemetry's [W3C-compatible headers][10]. To disable baggage, set [DD_TRACE_PROPAGATION_STYLE][12] to `datadog,tracecontext`.
647645

646+
#### Adding baggage as span tags
647+
_Available in Python, PHP, and Node.js. For other languages, reach out to [Support][11]_
648+
649+
By default, `user.id,session.id,account.id` baggage keys are added as span tags. To customize this configuration, see [Context Propagation Configuration][13]. Specified baggage keys are automatically added as span tags `baggage.<key>` (for example, `baggage.user.id`).
650+
648651
## Further reading
649652

650653
{{< partial name="whats-next/whats-next.html" >}}
@@ -661,3 +664,4 @@ By default, Baggage is automatically propagated through a distributed request us
661664
[10]: https://www.w3.org/TR/baggage/
662665
[11]: /help
663666
[12]: #customize-trace-context-propagation
667+
[13]: /tracing/trace_collection/library_config#context-propagation

0 commit comments

Comments
 (0)