Reporter configuration optionsedit

secret_tokenedit

This string is used to ensure that only your agents can send data to your APM server.

Both the agents and the APM server have to be configured with the same secret token. Use if APM Server requires a token.

DefaultTypeDynamic

<none>

String

false

Java System PropertiesProperty fileEnvironment

elastic.apm.secret_token

secret_token

ELASTIC_APM_SECRET_TOKEN

server_urlsedit

The URLs must be fully qualified, including protocol (http or https) and port.

Fails over to the next APM Server URL in the event of connection errors. Achieves load-balancing by shuffling the list of configured URLs. When multiple agents are active, they’ll tend towards spreading evenly across the set of servers due to randomization.

If outgoing HTTP traffic has to go through a proxy,you can use the Java system properties http.proxyHost and http.proxyPort to set that up. See also [Java’s proxy documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html) for more information.

Note

This configuration can only be reloaded dynamically as of 1.8.0

DefaultTypeDynamic

http://localhost:8200

List

true

Java System PropertiesProperty fileEnvironment

elastic.apm.server_urls

server_urls

ELASTIC_APM_SERVER_URLS

server_timeoutedit

If a request to the APM server takes longer than the configured timeout, the request is cancelled and the event (exception or transaction) is discarded. Set to 0 to disable timeouts.

Warning

If timeouts are disabled or set to a high value, your app could experience memory issues if the APM server times out.

Supports the duration suffixes ms, s and m. Example: 5s. The default unit for this option is s

DefaultTypeDynamic

5s

TimeDuration

true

Java System PropertiesProperty fileEnvironment

elastic.apm.server_timeout

server_timeout

ELASTIC_APM_SERVER_TIMEOUT

verify_server_certedit

By default, the agent verifies the SSL certificate if you use an HTTPS connection to the APM server.

Verification can be disabled by changing this setting to false.

DefaultTypeDynamic

true

Boolean

false

Java System PropertiesProperty fileEnvironment

elastic.apm.verify_server_cert

verify_server_cert

ELASTIC_APM_VERIFY_SERVER_CERT

max_queue_sizeedit

The maximum size of buffered events.

Events like transactions and spans are buffered when the agent can’t keep up with sending them to the APM Server or if the APM server is down.

If the queue is full, events are rejected which means you will lose transactions and spans in that case. This guards the application from crashing in case the APM server is unavailable for a longer period of time.

A lower value will decrease the heap overhead of the agent, while a higher value makes it less likely to lose events in case of a temporary spike in throughput.

DefaultTypeDynamic

512

Integer

true

Java System PropertiesProperty fileEnvironment

elastic.apm.max_queue_size

max_queue_size

ELASTIC_APM_MAX_QUEUE_SIZE

include_process_argsedit

Whether each transaction should have the process arguments attached. Disabled by default to save disk space.

DefaultTypeDynamic

false

Boolean

false

Java System PropertiesProperty fileEnvironment

elastic.apm.include_process_args

include_process_args

ELASTIC_APM_INCLUDE_PROCESS_ARGS

api_request_timeedit

Maximum time to keep an HTTP request to the APM Server open for.

Note

This value has to be lower than the APM Server’s read_timeout setting.

Supports the duration suffixes ms, s and m. Example: 10s. The default unit for this option is s

DefaultTypeDynamic

10s

TimeDuration

true

Java System PropertiesProperty fileEnvironment

elastic.apm.api_request_time

api_request_time

ELASTIC_APM_API_REQUEST_TIME

api_request_sizeedit

The maximum total compressed size of the request body which is sent to the APM server intake api via a chunked encoding (HTTP streaming). Note that a small overshoot is possible.

Allowed byte units are b, kb and mb. 1kb is equal to 1024b.

DefaultTypeDynamic

768kb

ByteValue

true

Java System PropertiesProperty fileEnvironment

elastic.apm.api_request_size

api_request_size

ELASTIC_APM_API_REQUEST_SIZE

metrics_interval ( [1.3.0] Added in 1.3.0. )edit

The interval at which the agent sends metrics to the APM Server. Must be at least 1s. Set to 0s to deactivate.

Supports the duration suffixes ms, s and m. Example: 30s. The default unit for this option is s

DefaultTypeDynamic

30s

TimeDuration

false

Java System PropertiesProperty fileEnvironment

elastic.apm.metrics_interval

metrics_interval

ELASTIC_APM_METRICS_INTERVAL

disable_metrics ( [1.3.0] Added in 1.3.0. )edit

Disables the collection of certain metrics. If the name of a metric matches any of the wildcard expressions, it will not be collected. Example: foo.*,bar.*

This option supports the wildcard *, which matches zero or more characters. Examples: /foo/*/bar/*/baz*, *foo*. Matching is case insensitive by default. Prepending an element with (?-i) makes the matching case sensitive.

DefaultTypeDynamic

<none>

List

false

Java System PropertiesProperty fileEnvironment

elastic.apm.disable_metrics

disable_metrics

ELASTIC_APM_DISABLE_METRICS