Skip to content

Commit

Permalink
ref: Update BrowserTracing options description (#5605)
Browse files Browse the repository at this point in the history
Bring the JS SDK `BrowserTracing` integration options up to date with the currently available options:

* add `finalTimeout` option introduced in v7
* remove `maxTransactionDuration` option dropped in v7
* improve `idleTimeout` description
  • Loading branch information
Lms24 committed Oct 6, 2022
1 parent f16163f commit d20482c
Showing 1 changed file with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Supported options:

### tracingOrigins

A list of strings and regular expressions. The JavaScript SDK will attach the `sentry-trace` and `baggage` headers to all outgoing XHR/fetch requests whose destination contains a string in the list or matches a regex in the list. If your frontend is making requests to a different domain, you'll need to add it there to propagate the `sentry-trace` and `baggage` headers to the backend services, which is required to link transactions together as part of a single trace.
A list of strings and regular expressions. The JavaScript SDK will attach the `sentry-trace` and `baggage` headers to all outgoing XHR/fetch requests whose destination contains a string in the list or matches a regex in the list. If your frontend is making requests to a different domain, you'll need to add it there to propagate the `sentry-trace` and `baggage` headers to the backend services, which is required to link transactions together as part of a single trace.

**The `tracingOrigins` option matches against the whole request URL, not just the domain. Using stricter regex to match certain parts of the URL ensures that requests do not unnecessarily have the additional headers attached.**

Expand All @@ -76,10 +76,16 @@ This function can be used to filter out unwanted spans such as XHR's running hea

### idleTimeout

The idle time, measured in ms, to wait until the transaction will be finished. The transaction will use the end timestamp of the last finished span as the endtime for the transaction.
The idle time, measured in ms, to wait until the transaction will be finished, if there are no unfinished spans. The transaction will use the end timestamp of the last finished span as the endtime for the transaction.

The default is `1000`.

### finalTimeout

The maximum duration of the transaction, measured in ms. If the transaction duration hits the `finalTimeout` value, it will be finished.

The default is `30000`.

### startTransactionOnLocationChange

This flag enables or disables creation of `navigation` transaction on history changes.
Expand All @@ -92,12 +98,6 @@ This flag enables or disables creation of `pageload` transaction on first pagelo

The default is `true`.

### maxTransactionDuration

The maximum duration of a transaction, measured in seconds, before it will be marked as "deadline_exceeded". If you never want transactions marked that way, set `maxTransactionDuration` to 0.

The default is `600`.

### markBackgroundTransactions

This option flags transactions when tabs are moved to the background with "cancelled". Because browser background tab timing is not suited for precise measurements of operations and can affect your statistics in nondeterministic ways, we recommend that this option be enabled.
Expand Down

1 comment on commit d20482c

@vercel
Copy link

@vercel vercel bot commented on d20482c Oct 6, 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.sentry.dev
docs.sentry.io
sentry-docs-git-master.sentry.dev

Please sign in to comment.