From d07d01901d0b1327de2cdbfd005c55f8d0d99a26 Mon Sep 17 00:00:00 2001 From: Lukas Stracke Date: Mon, 10 Oct 2022 14:40:13 +0200 Subject: [PATCH] feat: Add BrowserTracing heartbeatInterval option description (#5606) Add the JS SDK BrowserTracing integration's `heartbeatInterval` option that makes the previously hard-coded heartbeat interval configurable. --- .../instrumentation/automatic-instrumentation.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx b/src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx index 0aa74d78232b4..7d87054f79e34 100644 --- a/src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx +++ b/src/platforms/javascript/common/performance/instrumentation/automatic-instrumentation.mdx @@ -86,6 +86,12 @@ The maximum duration of the transaction, measured in ms. If the transaction dura The default is `30000`. +### 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.