Skip to content

Commit dd5bece

Browse files
authored
Add trace-propagation-targets to unified API options (#5382)
1 parent 6720695 commit dd5bece

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

src/platforms/common/configuration/options.mdx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ If the callback is not set, or it returns `undefined`, the default naming scheme
437437

438438
<ConfigKey name="enabled" supported={["javascript", "node"]}>
439439

440-
Specifies whether this SDK should send events to Sentry. Defaults to `true`. Setting this to `enabled: false` doesn't prevent all overhead from Sentry instrumentation. To disable Sentry completely, depending on environment, call `Sentry.init` conditionally.
440+
Specifies whether this SDK should send events to Sentry. Defaults to `true`. Setting this to `enabled: false` doesn't prevent all overhead from Sentry instrumentation. To disable Sentry completely, depending on environment, call `Sentry.init` conditionally.
441441

442442
</ConfigKey>
443443

@@ -595,6 +595,18 @@ An optional property that configures which downstream services receive the `sent
595595

596596
</ConfigKey>
597597

598+
<ConfigKey name="trace-propagation-targets" supported={["node"]}>
599+
600+
An optional property that controls which downstream services receive tracing data, in the form of a `sentry-trace` and a `baggage` header attached to any outgoing HTTP requests.
601+
602+
The option may contain a list of strings or regex against which the URLs of outgoing requests are matched.
603+
If one of the entries in the list matches the URL of an outgoing request, trace data will be attached to that request.
604+
String entries do not have to be full matches, meaning the URL of a request is matched when it _contains_ a string provided through the option.
605+
606+
If <PlatformIdentifier name="trace-propagation-targets" /> is not provided, trace data is attached to every outgoing request from the instrumented client.
607+
608+
</ConfigKey>
609+
598610
</PlatformSection>
599611

600612
<PlatformSection supported={["react-native", "javascript.cordova", "javascript.capacitor", "flutter"]}>
@@ -605,7 +617,6 @@ An optional property that configures which downstream services receive the `sent
605617

606618
An optional property that configures which features are in experimental mode. This property is either an `Object Type` with properties or a key/value `TypedDict`, depending the language. Experimental features are still in-progress and may have bugs. We recognize the irony.
607619

608-
609620
</ConfigKey>
610621

611622
## Hybrid SDK Options

0 commit comments

Comments
 (0)