Skip to content

Commit

Permalink
ref: Update BrowserTracing options description
Browse files Browse the repository at this point in the history
  • Loading branch information
Lms24 committed Oct 5, 2022
1 parent 28a1b91 commit fe94263
Showing 1 changed file with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,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 @@ -88,31 +94,25 @@ 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.

The default is `true`.

### \_experiments

### _experiments

This is an object containing experimental flags for features that may involve breaking changes that haven't yet landed in a new major version.
This is an object containing experimental flags for features that may involve breaking changes that haven't yet landed in a new major version.

The default is

```
{
enableLongTasks: true
}
```

#### _experiments.enableLongTasks
#### \_experiments.enableLongTasks

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

Expand Down

0 comments on commit fe94263

Please sign in to comment.