Skip to content

Commit 9398a01

Browse files
authored
feat(js): Update automatic instrumentation docs (#12194)
1 parent 44d21cd commit 9398a01

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/platforms/javascript/common/tracing/instrumentation/automatic-instrumentation.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Automatic Instrumentation
3-
description: "Learn what transactions are captured after tracing is enabled."
3+
description: "Learn what spans are captured after tracing is enabled."
44
sidebar_order: 10
55
notSupported:
66
- javascript.cordova
77
---
88

99
<Note>
1010

11-
Capturing transactions requires that you first <PlatformLink to="/tracing/">set up tracing in your app</PlatformLink> if you haven't already.
11+
Capturing spans requires that you first <PlatformLink to="/tracing/">set up tracing in your app</PlatformLink> if you haven't already.
1212

1313
</Note>
1414

@@ -59,7 +59,7 @@ The `tracingOrigins` option was renamed `tracePropagationTargets` and deprecated
5959

6060
</Note>
6161

62-
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.
62+
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 spans together as part of a single trace.
6363

6464
**The `tracePropagationTargets` option matches the entire request URL, not just the domain. Using stricter regex to match certain parts of the URL ensures that requests don't unnecessarily have additional headers attached.**
6565

@@ -90,37 +90,37 @@ will be created for all requests.
9090

9191
### idleTimeout
9292

93-
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.
93+
The idle time, measured in ms, to wait until the pageload/navigation span will be finished, if there are no unfinished spans. The pageload/navigation span will use the end timestamp of the last finished span as the endtime.
9494

9595
The default is `1000`.
9696

9797
### finalTimeout
9898

99-
The maximum duration of the transaction, measured in ms. If the transaction duration hits the `finalTimeout` value, it will be finished.
99+
The maximum duration of the pageload/naivgation span, measured in ms. If the duration exceeds the `finalTimeout` value, it will be finished.
100100

101101
The default is `30000`.
102102

103-
### heartbeatInterval
103+
### childSpanTimeout
104104

105-
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.
105+
The time, measured in ms, that a child span may run. If the last started child span is still running for more than this time, the pageload/navigation span will be finished.
106106

107-
The default is `5000`.
107+
The default is `15000`.
108108

109109
### instrumentNavigation
110110

111-
This flag enables or disables creation of `navigation` transaction on history changes.
111+
This flag enables or disables creation of `navigation` span on history changes.
112112

113113
The default is `true`.
114114

115115
### instrumentPageLoad
116116

117-
This flag enables or disables creation of `pageload` transaction on first pageload.
117+
This flag enables or disables creation of `pageload` span on first pageload.
118118

119119
The default is `true`.
120120

121121
### markBackgroundSpans
122122

123-
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.
123+
This option flags pageload/navigation spans 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.
124124

125125
The default is `true`.
126126

0 commit comments

Comments
 (0)