General configuration options

Example config file:

apm-server:
  hosts: ["localhost:8200"]
  rum:
    enabled: true

output:
  elasticsearch:
    hosts: ElasticsearchAddress:9200

queue.mem.events: 4096

max_procs: 4

If you are using an X-Pack secured version of Elastic Stack, you need to specify credentials in the config file before you run the commands that set up and start APM Server. For example:

output.elasticsearch:
  hosts: ["ElasticsearchAddress:9200"]
  username: "elastic"
  password: "elastic"

Configuration options: apm-server.*

host

Defines the host and port the server is listening on. Use "unix:/path/to.sock" to listen on a unix domain socket. Defaults to localhost:8200.

max_header_size

Maximum permitted size of a request’s header accepted by the server to be processed (in Bytes). Defaults to 1048576 Bytes (1 MB).

read_timeout

Maximum permitted duration for reading an entire request. Defaults to 30 seconds.

write_timeout

Maximum permitted duration for writing a response. Defaults to 30 seconds.

shutdown_timeout

Maximum duration in seconds before releasing resources when shutting down the server. Defaults to 5 seconds.

max_event_size

Maximum permitted size of an event accepted by the server to be processed (in Bytes). Defaults to 307200 Bytes.

Configuration options: general

max_connections

Maximum number of TCP connections to accept simultaneously. Default value is 0, which means unlimited.

secret_token

Authorization token for sending data to the APM server. If a token is set, the agents must send it in the following format: Authorization: Bearer <secret-token>. The token is not used for RUM endpoints. By default, no authorization token is set.

It is recommended to use an authorization token in combination with SSL enabled. Read more about Securing APM Server and the secret token.

capture_personal_data

If true, APM Server captures the IP of the instrumented service and its User Agent if any. Enabled by default.

expvar.enabled

When set to true APM Server exposes golang expvar. Disabled by default.

expvar.url

Configure the url to expose expvar. Defaults to debug/vars.

instrumentation.enabled

Enables self instrumentation of the APM Server itself. Disabled by default.

register.ingest.pipeline.enabled

Loads pipeline definitions to Elasticsearch on APM Server startup. Defaults to false.

register.ingest.pipeline.overwrite

Overwrites existing pipeline definitions in Elasticsearch. Defaults to true.

Configuration options: queue.mem.*

Data is buffered in a memory queue before it is published to the configured output. queue.mem.* settings modify the queue behavior.

events

Maximum number of events the memory queue can buffer. Read more about how this setting can be used for tuning data ingestion. Default value is 4096.

flush.min_events

Hints the minimum number of events stored in the queue, before providing a batch of events to the outputs. A value of 0 (the default) ensures events are immediately available to be sent to the outputs.

flush.timeout

Maximum duration after which events are available to the outputs, if the number of events stored in the queue is < min_flush_events. Default value is 1 second.

Configuration options: max_procs

max_procs

Sets the maximum number of CPUs that can be executing simultaneously. The default is the number of logical CPUs available in the system.