Skip to content

Commit

Permalink
feat: Add BrowserTracing heartbeatInterval option description
Browse files Browse the repository at this point in the history
  • Loading branch information
Lms24 committed Oct 6, 2022
1 parent 3540efd commit de29728
Showing 1 changed file with 7 additions and 1 deletion.
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 Down Expand Up @@ -80,6 +80,12 @@ The idle time, measured in ms, to wait until the transaction will be finished. T

The default is `1000`.

### heartbeatInterval

The time, measured in ms, one heartbeat takes. If no new spans were started or no open spans finished within **three heartbeats**, the transaction will be finished. The heartbeat count restarts whenever a new span is created or an open span is finished.

The default is `5000`.

### startTransactionOnLocationChange

This flag enables or disables creation of `navigation` transaction on history changes.
Expand Down

0 comments on commit de29728

Please sign in to comment.