2019-07-10 23:29:29 +02:00
|
|
|
[role="xpack"]
|
|
|
|
[[agent-configuration]]
|
2020-04-15 16:54:26 +02:00
|
|
|
=== APM Agent central configuration
|
2019-07-10 23:29:29 +02:00
|
|
|
|
2020-04-15 16:54:26 +02:00
|
|
|
++++
|
|
|
|
<titleabbrev>Configure APM agents with central config</titleabbrev>
|
|
|
|
++++
|
2019-07-10 23:29:29 +02:00
|
|
|
|
2020-04-15 16:54:26 +02:00
|
|
|
APM Agent configuration allows you to fine-tune your agent configuration from within the APM app.
|
|
|
|
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 APM app will let you know when your agents have applied your configurations.
|
2019-07-10 23:29:29 +02:00
|
|
|
|
|
|
|
[role="screenshot"]
|
|
|
|
image::apm/images/apm-agent-configuration.png[APM Agent configuration in Kibana]
|
|
|
|
|
|
|
|
[float]
|
|
|
|
==== Precedence
|
|
|
|
|
2020-04-15 16:54:26 +02:00
|
|
|
Configurations set from the APM app take precedence over configurations set locally in each Agent.
|
2019-07-10 23:29:29 +02:00
|
|
|
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.
|
2020-04-15 16:54:26 +02:00
|
|
|
For this reason, it is still essential to set custom default configurations locally in each of your agents.
|
2019-07-10 23:29:29 +02:00
|
|
|
|
|
|
|
[float]
|
|
|
|
==== APM Server setup
|
|
|
|
|
|
|
|
This feature requires {apm-server-ref}/setup-kibana-endpoint.html[Kibana endpoint configuration] in APM Server.
|
|
|
|
|
2020-04-15 16:54:26 +02:00
|
|
|
APM Server acts as a proxy between the agents and Kibana.
|
2019-07-10 23:29:29 +02:00
|
|
|
Kibana communicates any changed settings to APM Server so that your agents only need to poll APM Server to determine which settings have changed.
|
|
|
|
|
|
|
|
[float]
|
|
|
|
==== Supported configurations
|
|
|
|
|
2020-04-15 16:54:26 +02:00
|
|
|
Each Agent has a list of supported configurations.
|
2020-04-02 23:19:40 +02:00
|
|
|
After selecting a Service name and environment in the APM app,
|
2020-04-15 16:54:26 +02:00
|
|
|
a list of all supported configuration options,
|
2020-04-02 23:19:40 +02:00
|
|
|
including descriptions and default values, will be displayed.
|
|
|
|
|
2020-04-15 16:54:26 +02:00
|
|
|
Supported configurations are also tagged with the image:./images/dynamic-config.svg[] badge in each Agent's configuration reference:
|
2020-04-02 23:19:40 +02:00
|
|
|
|
|
|
|
[horizontal]
|
|
|
|
Go Agent:: {apm-go-ref}/configuration.html[Configuration reference]
|
|
|
|
Java Agent:: {apm-java-ref}/configuration.html[Configuration reference]
|
|
|
|
.NET Agent:: {apm-dotnet-ref}/configuration.html[Configuration reference]
|
|
|
|
Node.js Agent:: {apm-node-ref}/configuration.html[Configuration reference]
|
|
|
|
Python Agent:: {apm-py-ref}/configuration.html[Configuration reference]
|
|
|
|
Ruby Agent:: {apm-ruby-ref}/configuration.html[Configuration reference]
|
|
|
|
Real User Monitoring (RUM) Agent:: {apm-rum-ref}/configuration.html[Configuration reference]
|