Skip to content

docs(java): Add docs for propagateTraceparent option #14859

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+25 −1
Open

docs(java): Add docs for propagateTraceparent option #14859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
950077e
docs(java): Add docs for propagateTraceparent option
markushi Sep 10, 2025
c0c31c3
Address PR feedback
markushi Sep 11, 2025
0728451
Fix develop docs links
markushi Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/platforms/android/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,12 @@ If <PlatformIdentifier name="trace-propagation-targets" /> is not provided, trac

</ConfigKey>

<ConfigKey name="propagate-traceparent">

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.

</ConfigKey>

<ConfigKey name="trace-options-requests">

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.
Expand Down
6 changes: 6 additions & 0 deletions docs/platforms/android/tracing/trace-propagation/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,9 @@ 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](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.
6 changes: 6 additions & 0 deletions docs/platforms/java/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,12 @@ If <PlatformIdentifier name="trace-propagation-targets" /> is not provided, trac

</ConfigKey>

<ConfigKey name="propagate-traceparent">

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.

</ConfigKey>

<ConfigKey name="trace-options-requests">

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.
Expand Down
8 changes: 7 additions & 1 deletion docs/platforms/java/common/tracing/trace-propagation/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,10 @@ Sentry.init(context, { options ->
"https://api.myproject.org/"
))
})
```
```

## 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](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.
Loading