Set up Real User Monitoring (RUM) supportedit
The JavaScript RUM Agent offers real user monitoring (RUM) support.
Example config with RUM enabled:
apm-server.rum.enabled: true apm-server.rum.event_rate.limit: 300 apm-server.rum.event_rate.lru_size: 1000 apm-server.rum.allow_origins: ['*'] apm-server.rum.library_pattern: "node_modules|bower_components|~" apm-server.rum.exclude_from_grouping: "^/webpack" apm-server.rum.source_mapping.enabled: true apm-server.rum.source_mapping.cache.expiration: 5m apm-server.rum.source_mapping.index_pattern: "apm-*-sourcemap*"
Configurationedit
enabled
edit
To enable RUM support, set apm-server.rum.enabled
to true
.
By default this is disabled.
event_rate.limit
edit
Defines the maximum amount of events allowed to be sent to the APM Server RUM endpoint per ip per second. Defaults to 300.
event_rate.lru_size
edit
An LRU cache is used to keep a rate limit per IP for the most recently seen IPs. This setting defines the number of unique IPs that can be tracked in the cache. Sites with many concurrent clients should consider increasing this limit. Defaults to 1000.
allow_origins
edit
A list of permitted origins for RUM support.
User-agents send an Origin header that will be validated against this list.
This is done automatically by modern browsers as part of the CORS specification.
An origin is made of a protocol scheme, host and port, without the URL path.
Default value is set to ['*']
, which allows everything.
library_pattern
edit
RegExp to be matched against a stacktrace frame’s file_name
and abs_path
attributes.
If the RegExp matches, the stacktrace frame is considered to be a library frame.
When source mapping is applied, the error.culprit
is set to reflect the function and the filename
of the first non library frame.
This aims to provide an entry point for identifying issues.
Default value is "node_modules|bower_components|~"
.
exclude_from_grouping
edit
RegExp to be matched against a stacktrace frame’s file_name
.
If the RegExp matches, the stacktrace frame is excluded from being used for calculating error groups.
The default pattern excludes stacktrace frames that have a filename starting with /webpack
.
source_mapping.enabled
edit
Used to enable/disable sourcemapping for RUM events.
Defaults to true
.
source_mapping.elasticsearch
edit
Configure the Elasticsearch source map retrieval location, taking the same options as output.elasticsearch. This must be set when using an output other than Elasticsearch, and that output is writing to Elasticsearch. Otherwise leave this section empty.
source_mapping.cache.expiration
edit
If a source map has been uploaded to the APM Server, source mapping is automatically applied to documents sent to the RUM endpoint. Source maps are fetched from Elasticsearch and then kept in an in-memory cache for the configured time. Values configured without a time unit are treated as seconds. Default value is 5 minutes.
source_mapping.index_pattern
edit
Source maps are stored in a separate index apm-%{[observer.version]}-sourcemap
by default.
If changed, a matching index pattern needs to be specified here.
Ingest pipelinesedit
By default, register.ingest.pipeline.enabled
is set to true
.
This loads the default pipeline definition to Elasticsearch on APM Server startup.
The default pipeline is apm
. It adds user agent information to events and processes Geo-IP data,
which is especially useful for Elastic’s JavaScript RUM Agent.
You can view the pipeline configuration by navigating to the APM Server’s home directory and then
viewing ingest/pipeline/definition.json
.
To disable this, or any other pipeline, set output.elasticsearch.pipeline: _none
.