Skip to content

Commit b5a1a53

Browse files
authored
docs(otlp): Update docs for client SDK w3c traceparent support (#15294)
<!-- Use this checklist to make sure your PR is ready for merge. You may delete any sections you don't need. --> ## DESCRIBE YOUR PR *Tell us what you're changing and why. If your PR **resolves an issue**, please link it so it closes automatically.* ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE <!-- Sentry employees and contractors can delete or ignore this section. --> Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/)
1 parent bf1f6ee commit b5a1a53

File tree

5 files changed

+26
-4
lines changed

5 files changed

+26
-4
lines changed

docs/concepts/otlp/index.mdx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,10 +223,20 @@ The following SDKs support the `propagateTraceparent` option:
223223
- <LinkWithPlatformIcon
224224
platform="android"
225225
label="Android"
226-
url="/platforms/android/configuration/options/#propagate-traceparent"
226+
url="/platforms/android/configuration/options/#propagateTraceparent"
227227
/>
228228
- <LinkWithPlatformIcon
229229
platform="dart.flutter"
230230
label="Flutter"
231-
url="/platforms/dart/guides/flutter/configuration/options/#propagate-traceparent"
231+
url="/platforms/dart/guides/flutter/configuration/options/#propagateTraceparent"
232+
/>
233+
- <LinkWithPlatformIcon
234+
platform="native"
235+
label="Native"
236+
url="/platforms/native/configuration/options/#propagate_traceparent"
237+
/>
238+
- <LinkWithPlatformIcon
239+
platform="react-native"
240+
label="React Native"
241+
url="/platforms/react-native/configuration/options/#propagateTraceparent"
232242
/>

docs/platforms/android/configuration/options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ If <PlatformIdentifier name="tracePropagationTargets" /> is not provided, trace
333333

334334
<SdkOption name="propagateTraceparent" type="bool" defaultValue="false" availableSince="8.22.0">
335335

336-
Controls whether the SDK should propagate the W3C `traceparent` HTTP header alongside the `sentry-trace` and `baggage` headers for distributed tracing.
336+
Controls whether the SDK should propagate the W3C `traceparent` HTTP header alongside the `sentry-trace` and `baggage` headers for outgoing HTTP requests.
337337

338338
</SdkOption>
339339

docs/platforms/dart/guides/flutter/configuration/options.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,12 @@ If <PlatformIdentifier name="tracePropagationTargets" /> is not provided, trace
268268

269269
</SdkOption>
270270

271+
<SdkOption name="propagateTraceparent" type="bool" defaultValue="false" availableSince="9.7.0">
272+
273+
Controls whether the SDK should propagate the W3C `traceparent` HTTP header alongside the `sentry-trace` and `baggage` headers for outgoing HTTP requests.
274+
275+
</SdkOption>
276+
271277
## Experimental Features
272278

273279
<SdkOption name="experimental" type="object">

docs/platforms/native/common/configuration/options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Whether Crashpad should delay application shutdown until the upload of the crash
6666

6767
</SdkOption>
6868

69-
<SdkOption name="propagate_traceparent" type="bool" defaultValue="false">
69+
<SdkOption name="propagate_traceparent" type="bool" defaultValue="false" availableSince="0.11.3">
7070

7171
Controls whether the SDK should propagate the W3C `traceparent` HTTP header alongside the `sentry-trace` header for [distributed tracing](https://docs.sentry.io/platforms/native/tracing/trace-propagation/custom-instrumentation/).
7272

docs/platforms/react-native/configuration/options.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,12 @@ If <PlatformIdentifier name="tracePropagationTargets" /> is not provided, trace
276276

277277
</SdkOption>
278278

279+
<SdkOption name="propagateTraceparent" type="bool" defaultValue="false" availableSince="7.4.0">
280+
281+
Controls whether the SDK should propagate the W3C `traceparent` HTTP header alongside the `sentry-trace` and `baggage` headers for outgoing HTTP requests.
282+
283+
</SdkOption>
284+
279285
## Experimental Features
280286

281287
<SdkOption name="experimental">

0 commit comments

Comments
 (0)