APM agent central configuration

Note

APM agent central configuration is not compatible with Elastic Cloud Serverless.

APM Agent configuration allows you to fine-tune your APM agent configuration from within the Applications UI. Changes are automatically propagated to your APM agents, so there’s no need to redeploy.

To get started, choose the services and environments you wish to configure. The Applications UI will let you know when your APM agents have applied your configurations.

APM Agent configuration in Kibana

Precedence ¶

Configurations set from the Applications UI take precedence over configurations set locally in each APM agent. However, if APM Server is slow to respond, is offline, reports an error, etc., APM agents will use local defaults until they’re able to update the configuration. For this reason, it is still essential to set custom default configurations locally in each of your APM agents.

Supported configurations ¶

Each APM agent has a list of supported configurations. After selecting a Service name and environment in the Applications UI, a list of all supported configuration options, including descriptions and default values, will be displayed.

Supported configurations are also tagged with the dynamic config badge in each APM agent’s configuration reference:

Android agent
Configuration reference
Go agent
Configuration reference
iOS agent
Configuration reference
Java agent
Configuration reference
.NET agent
Configuration reference
Node.js agent
Configuration reference
PHP agent
Configuration reference
Python agent
Configuration reference
Ruby agent
Configuration reference
Real User Monitoring (RUM) agent
Configuration reference

APM Server configuration ¶

For most users, APM agent configuration should work out-of-the-box. If you run into trouble, it may be because you’re not using the Elasticsearch output, or because your Elasticsearch credentials don’t have sufficient privileges.

See configure APM agent configuration to learn how to configure APM Server to avoid these problems.