IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

›

Configuration

edit

Configuration

edit

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

`serviceName`

edit

Type: String
Required

Your Elastic APM service name.

`serverUrl`

edit

Type: String
Default: http://localhost:8200

The URL used to make requests to the APM Server.

`serviceVersion`

edit

Type: String

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.

`active`

edit

Type: Boolean
Default: true

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
}

`logLevel`

edit

Type: String
Default: 'warn'

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.

`flushInterval`

edit

Type: Number
Default: 500

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.

After each flush of the queue, the next flush isn’t scheduled until an item is added to the queue.