Skip to content

Commit fe94263

Browse files
committed
ref: Update BrowserTracing options description
1 parent 28a1b91 commit fe94263

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,16 @@ This function can be used to filter out unwanted spans such as XHR's running hea
7272

7373
### idleTimeout
7474

75-
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.
75+
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.
7676

7777
The default is `1000`.
7878

79+
### finalTimeout
80+
81+
The maximum duration of the transaction, measured in ms. If the transaction duration hits the `finalTimeout` value, it will be finished.
82+
83+
The default is `30000`.
84+
7985
### startTransactionOnLocationChange
8086

8187
This flag enables or disables creation of `navigation` transaction on history changes.
@@ -88,31 +94,25 @@ This flag enables or disables creation of `pageload` transaction on first pagelo
8894

8995
The default is `true`.
9096

91-
### maxTransactionDuration
92-
93-
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.
94-
95-
The default is `600`.
96-
9797
### markBackgroundTransactions
9898

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

101101
The default is `true`.
102102

103+
### \_experiments
103104

104-
### _experiments
105-
106-
This is an object containing experimental flags for features that may involve breaking changes that haven't yet landed in a new major version.
105+
This is an object containing experimental flags for features that may involve breaking changes that haven't yet landed in a new major version.
107106

108107
The default is
108+
109109
```
110110
{
111111
enableLongTasks: true
112112
}
113113
```
114114

115-
#### _experiments.enableLongTasks
115+
#### \_experiments.enableLongTasks
116116

117117
This experimental option determines whether spans for long tasks automatically get created.
118118

0 commit comments

Comments
 (0)