Skip to content

Commit

Permalink
Add trace-propagation-targets to unified API options (#5382)
Browse files Browse the repository at this point in the history
lforst authored Aug 5, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 6720695 commit dd5bece
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions src/platforms/common/configuration/options.mdx
Original file line number Diff line number Diff line change
@@ -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>

@@ -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"]}>
@@ -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

1 comment on commit dd5bece

@vercel
Copy link

@vercel vercel bot commented on dd5bece Aug 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

sentry-docs – ./

sentry-docs-git-master.sentry.dev
sentry-docs.sentry.dev
docs.sentry.io

Please sign in to comment.