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.

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

Baggage Initial Documentation #25644

Closed
wants to merge 12 commits into from
9 changes: 8 additions & 1 deletion content/en/tracing/glossary/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ For additional definitions and descriptions of important APM terms such as _span
| [Retention Filters](#retention-filters) | Retention filters are tag-based controls set within the Datadog UI that determine what spans to index in Datadog for 15 days. |
| [Ingestion Controls](#ingestion-controls) | Ingestion controls are used to send up to 100% of traces to Datadog for live search and analytics for 15 minutes.
| [Instrumentation](#instrumentation) | Instrumentation is the process of adding code to your application to capture and report observability data. |
| [Baggage](#baggage) | Baggage is contextual information that is passed between traces, metrics, and logs in the form of key-value pairs. |

## Services

Expand Down Expand Up @@ -106,6 +107,12 @@ You can use custom instrumentation by embedding tracing code directly into your

To learn more, read [Application Instrumentation][26].

## Baggage

Baggage allows you to propagate key-value pairs (also known as baggage items) across service boundaries in a distributed system. Unlike trace context, which focuses on trace identifiers, baggage allows for the transmission of business data and other contextual information alongside traces.

To learn more, read supported [propagation formats][27] for your application's language.
tushar-datadog marked this conversation as resolved.
Show resolved Hide resolved

## Further Reading

{{< partial name="whats-next/whats-next.html" >}}
Expand Down Expand Up @@ -135,4 +142,4 @@ To learn more, read [Application Instrumentation][26].
[24]: /tracing/trace_collection/automatic_instrumentation/single-step-apm
[25]: /tracing/trace_collection/automatic_instrumentation/dd_libraries/
[26]: /tracing/trace_collection/
[27]: /tracing/trace_collection/trace_context_propagation
[27]: /tracing/trace_collection/trace_context_propagation/#supported-formats
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ By default, the Datadog SDK extracts and injects distributed tracing headers usi

- [Datadog][1] (takes higher precedence when extracting headers)
- [W3C Trace Context][2]
- [Baggage][10]

This default configuration maximizes compatibility with older Datadog SDK versions and products while allowing interoperability with other distributed tracing systems like OpenTelemetry.

Expand All @@ -46,6 +47,7 @@ Use the following environment variables to configure formats for reading and wri
**Default**: `datadog,tracecontext` <br>
**Note**: With multiple formats, extraction follows the specified order (for example, `datadog,tracecontext` checks Datadog headers first). The first valid context continues the trace; additional valid contexts become span links.


`OTEL_PROPAGATORS`
: Specifies trace context propagation formats for both extraction and injection (comma-separated list). Lowest precedence; ignored if any other Datadog trace context propagation environment variable is set.<br>
**Note**: Only use this configuration when migrating an application from the OpenTelemetry SDK to the Datadog SDK. For more information on this configuration and other OpenTelemetry environment variables, see [Using OpenTelemetry Environment Variables with Datadog SDKs][9].
Expand All @@ -70,6 +72,7 @@ The Datadog SDK supports the following trace context formats:
| [W3C Trace Context][2] | `tracecontext` |
| [B3 Single][3] | _Language Dependent Value_ |
| [B3 Multi][4] | `b3multi` |
| [Baggage][10] | `baggage` |
| [None][5] | `none` |

## Language support
Expand Down Expand Up @@ -623,6 +626,10 @@ When the Datadog SDK is configured with the Datadog format for extraction or inj

When the Datadog SDK is configured with the None format for extraction or injection (possibly both), the Datadog SDK does _not_ interact with request headers, meaning that the corresponding context propagation operation does nothing.

### Baggage format

Baggage propagation through OpenTelemetry's W3C-compatible headers is enabled by default.

## Further reading

{{< partial name="whats-next/whats-next.html" >}}
Expand All @@ -636,3 +643,4 @@ When the Datadog SDK is configured with the None format for extraction or inject
[7]: /real_user_monitoring/platform/connect_rum_and_traces
[8]: /synthetics/platform/apm
[9]: /opentelemetry/interoperability/environment_variable_support
[10]: https://www.w3.org/TR/baggage/
Loading