General configuration options

Example config file:

apm-server:
  host: "localhost:8200"
  rum:
    enabled: true

output:
  elasticsearch:
    hosts: ElasticsearchAddress:9200

queue.mem.events: 4096

max_procs: 4

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

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.

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

Maximum amount of time to wait for the next incoming request before underlying connection is closed. Defaults to 45 seconds.

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

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

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

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

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

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.

In versions prior to 7.14.0, secret token authorization was known as apm-server.secret_token. In 7.14.0 this was renamed apm-server.auth.secret_token. The old configuration will continue to work until 8.0.0, and the new configuration will take precedence.

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

Sets the default service environment to associate with data and requests received from agents which have no service environment defined.

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

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

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

Loads the default pipeline definition to Elasticsearch on APM Server startup. Defaults to true.

Overwrites the existing APM pipeline definition in Elasticsearch. Defaults to false.

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

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.

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.

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

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

Write events to Elasticsearch data streams instead of indices. Events will be written to traces-*, logs-*, and metrics-* data streams. Enabling data streams disables the setup of index templates, ILM policies, and ingest pipelines. Defaults to false.

Wait for the apm Fleet integration to be installed by Kibana. Requires either apm-server.kibana.enabled or for the Elasticsearch output to be configured. Defaults to true.