You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration.asciidoc
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ While initializing the agent you can provide the following configuration options
10
10
* *Type:* String
11
11
* *Required*
12
12
13
-
The Elastic APM service name is used to differentiate data from each of your services.
13
+
The Elastic APM service name is used to differentiate data from each of your services.
14
14
Can only contain alphanumeric characters, spaces, underscores, and dashes (must match ^[a-zA-Z0-9 _-]+$).
15
15
16
16
[float]
@@ -33,7 +33,7 @@ The server prefix URL used to make requests to the APM Server. Some ad blockers
33
33
from the browser if the default server prefix URL is being used. Using a custom server prefix URL can be used to
34
34
evade the ad blocker.
35
35
36
-
NOTE: If the default server prefix URL is overwritten, the reverse proxy that sits between the
36
+
NOTE: If the default server prefix URL is overwritten, the reverse proxy that sits between the
37
37
APM Server and the rum agent must reroute traffic to `/intake/v${apiVersion}/rum/events`
38
38
so the APM Server knows what intake API to use.
39
39
@@ -47,7 +47,7 @@ so the APM Server knows what intake API to use.
47
47
The version of the app.
48
48
This could be the version from your `package.json` file,
49
49
a git commit reference,
50
-
or any other string that might help you reference a specific version.
50
+
or any other string that might help you reference a specific version.
51
51
This option is used on the APM Server to find the right sourcemap file to apply to the stack trace.
52
52
53
53
@@ -78,8 +78,8 @@ var options = {
78
78
* *Type:* Boolean
79
79
* *Default:* `true`
80
80
81
-
A Boolean value that specifies if the agent should automatically instrument the application to collect
82
-
performance metrics for the application.
81
+
A Boolean value that specifies if the agent should automatically instrument the application to collect
82
+
performance metrics for the application.
83
83
84
84
NOTE: Both active and instrument needs to be true for instrumentation to be running.
85
85
@@ -234,7 +234,7 @@ Distributed tracing is enabled by default. Use this option to disable it.
234
234
235
235
This option can be set to an array containing one or more Strings or RegExp objects and determines which origins should be monitored as part of distributed tracing.
236
236
This option is consulted when the agent is about to add the distributed tracing HTTP header (`traceparent`) to a request.
237
-
Please note that each item in the array should be a valid URL containing the origin (other parts of the url are ignored) or a RegExp object. If an item in the array is a string, an exact match will be performed. If it's a RegExp object, its test function will be called with the request origin.
237
+
Please note that each item in the array should be a valid URL containing the origin (other parts of the url are ignored) or a RegExp object. If an item in the array is a string, an exact match will be performed. If it's a RegExp object, its test function will be called with the request origin.
238
238
239
239
[source,js]
240
240
----
@@ -252,7 +252,7 @@ var options = {
252
252
253
253
When distributed tracing is enabled, this option can be used to propagate the https://www.w3.org/TR/trace-context/#tracestate-header[tracestate]
254
254
HTTP header to the configured origins. Before enabling this flag, make sure to change your <<server-configuration, server configuration>> to avoid
255
-
Cross-Origin Resource Sharing errors.
255
+
Cross-Origin Resource Sharing errors.
256
256
257
257
[float]
258
258
[[event-throttling]]
@@ -294,7 +294,7 @@ In most cases, this means when the tab/window of the page is closed.
294
294
295
295
NOTE: Currently, only <<transaction-sample-rate, transaction sample rate>> can be configured via Kibana.
296
296
297
-
NOTE: This feature requires APM Server v7.5 or later and that the APM Server is configured with `kibana.enabled: true`.
297
+
NOTE: This feature requires APM Server v7.5 or later.
298
298
More information is available in {apm-app-ref}/agent-configuration.html[APM Agent configuration].
299
299
300
300
@@ -307,7 +307,7 @@ More information is available in {apm-app-ref}/agent-configuration.html[APM Agen
307
307
* *Default:* `[]`
308
308
309
309
An array containing a list of transaction names that should be ignored when sending the payload to the APM server.
310
-
It can be set to an array containing one or more Strings or RegExp objects. If an element in the array is a String, an exact match will be performed.
310
+
It can be set to an array containing one or more Strings or RegExp objects. If an element in the array is a String, an exact match will be performed.
311
311
If an element in the array is a RegExp object, its test function will be called with the name of the transation.
312
312
313
313
[source,js]
@@ -360,12 +360,12 @@ Arguments:
360
360
361
361
`apmRequest` can be used to change or reject requests that are made to the
362
362
APM Server. This config can be set to a function, which is called whenever the agent
363
-
needs to make a request to the APM Server.
363
+
needs to make a request to the APM Server.
364
+
365
+
The callback function is called with a single argument and is expected to return
366
+
an output synchronously. If the return value is `true` then the agent continues
367
+
with making the (potentially modified) request to the APM Server.
364
368
365
-
The callback function is called with a single argument and is expected to return
366
-
an output synchronously. If the return value is `true` then the agent continues
367
-
with making the (potentially modified) request to the APM Server.
368
-
369
369
If this function returns a falsy value the request is discarded with a warning in the console.
370
370
371
371
The following example adds a header to the HTTP request:
Copy file name to clipboardExpand all lines: docs/supported-technologies.asciidoc
+5Lines changed: 5 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,6 +117,11 @@ The agent supports <<framework-integrations,integrations with certain frameworks
117
117
To instrument custom metrics, like rendering time or mounting time of components on frameworks like React, Angular, Vue,
118
118
etc., use the <<custom-transactions,custom transactions API>>.
119
119
120
+
The core RUM agent supports websites based on multi-page (MPA) and single-page architectures (SPA). The core RUM agent can be used on its own with SPA sites, but we recommend using our framework-specific integrations for the following reasons:
121
+
122
+
* *Pages are better grouped by routes*: This results in the `transaction.name` field mapping to the actual application route path declared in the SPA application.
123
+
* *Exact SPA navigation rendering*: Integration packages hook into the component lifecycle and measure the duration of the SPA transaction correctly. The core RUM agent is unable to determine when an SPA navigation is rendered and instead waits for the last network request before considering the SPA transition is finished.
124
+
* *Improved error capturing*: For example, when an error is thrown inside an Angular application, the framework integration will automatically capture it. The core RUM agent, however, is unable to capture the error as the default error handler doesn’t rethrow the error as a browser event.
0 commit comments