Skip to content

Add trace-propagation-targets to unified API options #5382

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

Merged
merged 2 commits into from
Aug 5, 2022
Merged

Add trace-propagation-targets to unified API options #5382

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4646bb2
Add trace-propagation-targets to unified API options
Aug 4, 2022
fb054b8
Clarify option a bit
Aug 5, 2022
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
15 changes: 13 additions & 2 deletions src/platforms/common/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,7 +437,7 @@ If the callback is not set, or it returns `undefined`, the default naming scheme

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

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.
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.

</ConfigKey>

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

</ConfigKey>

<ConfigKey name="trace-propagation-targets" supported={["node"]}>

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.

The option may contain a list of strings or regex against which the URLs of outgoing requests are matched.
If one of the entries in the list matches the URL of an outgoing request, trace data will be attached to that request.
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.

If <PlatformIdentifier name="trace-propagation-targets" /> is not provided, trace data is attached to every outgoing request from the instrumented client.

</ConfigKey>

</PlatformSection>

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

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.


</ConfigKey>

## Hybrid SDK Options
Expand Down