From 950077e85c9aef9fc752721a97c624ab2dd0bf3d Mon Sep 17 00:00:00 2001 From: Markus Hintersteiner Date: Wed, 10 Sep 2025 10:06:56 +0200 Subject: [PATCH 1/3] docs(java): Add docs for propagateTraceparent option --- docs/platforms/android/configuration/options.mdx | 6 ++++++ .../platforms/android/tracing/trace-propagation/index.mdx | 6 ++++++ docs/platforms/java/common/configuration/options.mdx | 6 ++++++ .../java/common/tracing/trace-propagation/index.mdx | 8 +++++++- 4 files changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/platforms/android/configuration/options.mdx b/docs/platforms/android/configuration/options.mdx index 359869f0bed8a6..e6152ab7a45dca 100644 --- a/docs/platforms/android/configuration/options.mdx +++ b/docs/platforms/android/configuration/options.mdx @@ -327,6 +327,12 @@ If is not provided, trac + + +Controls whether the SDK should propagate the W3C `traceparent` HTTP header alongside the `sentry-trace` and `baggage` headers for distributed tracing. This option defaults to `false` and is available starting from SDK version 8.22.0. + + + Set this boolean to `false` to disable tracing for `OPTIONS` requests. This options default value will likely be changed in the next major version, meaning you will have to set it to `true` if you want to keep tracing `OPTIONS` requests. diff --git a/docs/platforms/android/tracing/trace-propagation/index.mdx b/docs/platforms/android/tracing/trace-propagation/index.mdx index 8661a8cb00572f..5157cc7530e2b0 100644 --- a/docs/platforms/android/tracing/trace-propagation/index.mdx +++ b/docs/platforms/android/tracing/trace-propagation/index.mdx @@ -63,3 +63,9 @@ SentryAndroid.init(context, { options -> )) }) ``` + +## W3C Traceparent Header Support + +Starting from version 8.22.0, the Android SDK also supports the W3C `traceparent` HTTP header. This header follows the W3C Trace Context specification and provides interoperability with other tracing systems that support this standard. + +To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/android/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. diff --git a/docs/platforms/java/common/configuration/options.mdx b/docs/platforms/java/common/configuration/options.mdx index 8e4ddcceeba0fa..0c02827b50a9de 100644 --- a/docs/platforms/java/common/configuration/options.mdx +++ b/docs/platforms/java/common/configuration/options.mdx @@ -277,6 +277,12 @@ If is not provided, trac + + +Controls whether the SDK should propagate the W3C `traceparent` HTTP header alongside the `sentry-trace` and `baggage` headers for distributed tracing. This option defaults to `false` and is available starting from SDK version 8.22.0. + + + Set this boolean to `false` to disable tracing for `OPTIONS` requests. This options default value will likely be changed in the next major version, meaning you will have to set it to `true` if you want to keep tracing `OPTIONS` requests. diff --git a/docs/platforms/java/common/tracing/trace-propagation/index.mdx b/docs/platforms/java/common/tracing/trace-propagation/index.mdx index 7aaff1a8837763..9b39dd1fd3adb5 100644 --- a/docs/platforms/java/common/tracing/trace-propagation/index.mdx +++ b/docs/platforms/java/common/tracing/trace-propagation/index.mdx @@ -62,4 +62,10 @@ Sentry.init(context, { options -> "https://api.myproject.org/" )) }) -``` \ No newline at end of file +``` + +## W3C Traceparent Header Support + +Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header. This header follows the W3C Trace Context specification and provides interoperability with other tracing systems that support this standard. + +To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/java/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. \ No newline at end of file From c0c31c3d123a99a762b2b81f37e966cb28c53e78 Mon Sep 17 00:00:00 2001 From: Markus Hintersteiner Date: Thu, 11 Sep 2025 12:15:11 +0200 Subject: [PATCH 2/3] Address PR feedback --- docs/platforms/android/tracing/trace-propagation/index.mdx | 2 +- docs/platforms/java/common/tracing/trace-propagation/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/android/tracing/trace-propagation/index.mdx b/docs/platforms/android/tracing/trace-propagation/index.mdx index 5157cc7530e2b0..73a6ccf3e02679 100644 --- a/docs/platforms/android/tracing/trace-propagation/index.mdx +++ b/docs/platforms/android/tracing/trace-propagation/index.mdx @@ -66,6 +66,6 @@ SentryAndroid.init(context, { options -> ## W3C Traceparent Header Support -Starting from version 8.22.0, the Android SDK also supports the W3C `traceparent` HTTP header. This header follows the W3C Trace Context specification and provides interoperability with other tracing systems that support this standard. +Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard. To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/android/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. diff --git a/docs/platforms/java/common/tracing/trace-propagation/index.mdx b/docs/platforms/java/common/tracing/trace-propagation/index.mdx index 9b39dd1fd3adb5..1e17cf6ba067a6 100644 --- a/docs/platforms/java/common/tracing/trace-propagation/index.mdx +++ b/docs/platforms/java/common/tracing/trace-propagation/index.mdx @@ -66,6 +66,6 @@ Sentry.init(context, { options -> ## W3C Traceparent Header Support -Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header. This header follows the W3C Trace Context specification and provides interoperability with other tracing systems that support this standard. +Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard. To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/java/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. \ No newline at end of file From 07284510d35d667572cba5d5d69c1399df655f01 Mon Sep 17 00:00:00 2001 From: Markus Hintersteiner Date: Thu, 11 Sep 2025 13:52:47 +0200 Subject: [PATCH 3/3] Fix develop docs links --- docs/platforms/android/tracing/trace-propagation/index.mdx | 2 +- docs/platforms/java/common/tracing/trace-propagation/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/platforms/android/tracing/trace-propagation/index.mdx b/docs/platforms/android/tracing/trace-propagation/index.mdx index 73a6ccf3e02679..f43f11619e5f42 100644 --- a/docs/platforms/android/tracing/trace-propagation/index.mdx +++ b/docs/platforms/android/tracing/trace-propagation/index.mdx @@ -66,6 +66,6 @@ SentryAndroid.init(context, { options -> ## W3C Traceparent Header Support -Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard. +Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](https://develop.sentry.dev/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard. To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/android/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. diff --git a/docs/platforms/java/common/tracing/trace-propagation/index.mdx b/docs/platforms/java/common/tracing/trace-propagation/index.mdx index 1e17cf6ba067a6..4faa3f17830d93 100644 --- a/docs/platforms/java/common/tracing/trace-propagation/index.mdx +++ b/docs/platforms/java/common/tracing/trace-propagation/index.mdx @@ -66,6 +66,6 @@ Sentry.init(context, { options -> ## W3C Traceparent Header Support -Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard. +Starting from version 8.22.0, the Java SDK also supports the W3C `traceparent` HTTP header for outgoing requests. This header follows the [W3C Trace Context specification](https://develop.sentry.dev/sdk/telemetry/traces/distributed-tracing/#w3c-trace-context-header) and provides interoperability with other tracing systems that support this standard. To enable W3C `traceparent` header propagation, set the [`propagateTraceparent`](/platforms/java/configuration/options/#propagate-traceparent) option to `true`. When enabled, the `traceparent` header will be propagated alongside the `sentry-trace` and `baggage` headers to outgoing HTTP requests. Like the other headers, it's attached to all requests by default, or only to requests matching your `tracePropagationTargets` configuration if you've specified one. \ No newline at end of file