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.

api_keyedit

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

Agents can use API keys as a replacement of secret token, APM server can have multiple API keys. When both secret token and API key are used, API key has priority and secret token is ignored. Use if APM Server requires an API key.

server_urledit

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

If SSL is enabled on the APM Server, use the https protocol. For more information, see SSL/TLS communication with APM Server.

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 for more information.

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 SSL is enabled on the APM Server, use the https protocol. For more information, see SSL/TLS communication with APM Server.

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 for more information.

disable_sendedit

If set to true, the agent will work as usual, except from any task requiring communication with the APM server. Events will be dropped and the agent won’t be able to receive central configuration, which means that any other configuration cannot be changed in this state without restarting the service. An example use case for this would be maintaining the ability to create traces and log trace/transaction/span IDs through the log correlation feature, without setting up an APM Server.

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.

Supports the duration suffixes ms, s and m. Example: 5s.

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.

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.

include_process_argsedit

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

api_request_timeedit

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

Supports the duration suffixes ms, s and m. Example: 10s.

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.

metrics_interval ( [1.3.0] Added in 1.3.0. )edit

The interval at which the agent sends metrics to the APM Server, rounded down to the nearest second (ie 3783ms would be applied as 3000ms). If there is an interval (step) defined in the Meter, that interval (to the nearest second) will instead be used, for that Meter. If the Meter step interval is less than 1 second, the meter will not be reported. Must be at least 1s. Set to 0s to deactivate.

Supports the duration suffixes ms, s and m. Example: 30s.

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.