IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« API Reference Advanced Topics »
Elastic Docs ›

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.

Error throttling

edit

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

errorThrottleLimit

edit
  • Type: Number
  • Default: 20

errorThrottleInterval

edit
  • Type: Number
  • Default: 30000

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

Transaction throttling

edit

transactionThrottleLimit

edit
  • Type: Number
  • Default: 20

transactionThrottleInterval

edit
  • Type: Number
  • Default: 30000

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

transactionSampleRate

edit
  • Type: Number
  • Default: 1.0

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

pageLoadTraceId

edit
  • Type: String

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

pageLoadSampled

edit
  • Type: String

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

pageLoadSpanId

edit
  • Type: String

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

pageLoadTransactionName

edit
  • Type: String

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.

distributedTracing

edit
  • Type: Boolean
  • Default: true

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

distributedTracingOrigins

edit
  • Type: Array
  • Default: []

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']
}
« API Reference Advanced Topics »