Configuration

While initializing the agent you can provide the following configuration options:

Your Elastic APM service name.

The URL used to make requests to the APM Server.

The version of the app. This could be the version from your package.json file, a git commit reference, or any other string that might help you pinpoint a specific version. Furthermore this option is used on the APM Server to find the right sourcemap file to apply to the stack trace.

A boolean specifying if the agent should be active or not. If active, the agent will send APM transactions and track errors. This option can be used to deactivate the agent in your staging environment. It can also be used to sample a number of clients, here is an example to sample 10% of the page loads:

var options = {
  active: Math.random() < 0.1
}

A boolean specifying if the agent should automatically instrument the application to collect performance metrics for the application.

A list of instrumentations which can be disabled. When disabled, no transactions/spans will be created for that type. Valid options:

Environment where the service being monitored is deployed, e.g. "production", "development", "test", etc.

Environments allow you to easily filter data on a global level in the APM app. It’s important to be consistent when naming environments across agents. See environment selector in the APM app for more information.

Set the verbosity level for the agent. Note that this does not have any influence on the types of errors that are sent to the APM Server. This option is useful when you want to report an issue with the agent to us.

Possible levels are: trace, debug, info, warn, error.

Enable/disable the tracking and collection of breakdown metrics for the transaction.

The agent maintains two in-memory queues to record transactions and errors when they are added. This option sets the flush interval in milliseconds for these queues.

Use this option to override the page load transaction’s trace ID.

Use this option to override the page load transaction’s sampled property.

This option overrides the ID of the span that is generated for receiving the initial document.

This option sets the name for the page load transaction. See the custom initial page load transaction names documentation for strategies on using this method.

Distributed tracing is enabled by default, however you can use this configuration to disable it.

This option is an array of strings and determines which origins should be monitored as part of distributed tracing. More specificly this option is consulted when the agent is about to add distributed tracing http header (elastic-apm-traceparent) to a request. Please note that each item in the array should be a valid url and at least include the origin part (other parts of the url are ignored).

var options = {
  distributedTracingOrigins: ['https://example.com']
}

To throttle the number of errors send to the APM Server, you can use the following options:

By default the agent can only send (up to) 20 errors every 30000 milliseconds.

By default the agent can only send (up to) 20 transactions every 30000 milliseconds.

A number between 0.0 and 1.0 that specifies the sample rate of transactions, by default all transactions are sampled.

This option activates APM Agent Configuration via Kibana. When set to true, the agent starts fetching configurations via the APM Server during the initialization phase. These central configurations are cached in sessionStorage, and will not be fetched again until the session is closed and/or sessionStorage is cleared. In most cases, this means when the tab/window of the page is closed.

Array containing a list of transactions names that should be ignored when sending the payload to the APM server. 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. If an element in the array is a RegExp object, its test function will be called with the name of the transation.

const options = {
  ignoreTransactions: [/login*/, '/app']
}

Instructs the agent to start monitoring for browser tasks that block the UI thread and might delay other user inputs by affecting the overall page responsiveness. Learn more about long task spans and how to interpret them.