Skip to content

Commit 953aeda

Browse files
Lms24lforst
authored andcommitted
ref: Update BrowserTracing options description (#5605)
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
1 parent 02968e6 commit 953aeda

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Supported options:
5252

5353
### tracingOrigins
5454

55-
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.
55+
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.
5656

5757
**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.**
5858

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

7777
### idleTimeout
7878

79-
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.
79+
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.
8080

8181
The default is `1000`.
8282

83+
### finalTimeout
84+
85+
The maximum duration of the transaction, measured in ms. If the transaction duration hits the `finalTimeout` value, it will be finished.
86+
87+
The default is `30000`.
88+
8389
### startTransactionOnLocationChange
8490

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

9399
The default is `true`.
94100

95-
### maxTransactionDuration
96-
97-
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.
98-
99-
The default is `600`.
100-
101101
### markBackgroundTransactions
102102

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

0 commit comments

Comments
 (0)