Skip to content

Commit

Permalink
Merge pull request #598 from axw/central-config-docs
Browse files Browse the repository at this point in the history
docs: add mentions of central config
  • Loading branch information
axw authored Jul 31, 2019
2 parents 7796d5a + 23a3553 commit 245fbdc
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@
== Configuration

To adapt the Elastic APM Go agent to your needs, you can configure it using
environment variables.
one of the following three methods, in descending order of precedence:

1. {kibana-ref}/agent-configuration.html[APM Agent Configuration via Kibana]
2. In code, using the <<tracer-config-api, Tracer Config API>>
3. Environment variables

Configuration defined via Kibana will take precedence over the same
configuration defined in code, which takes precedence over environment
variables. If configuration is defined via Kibana, and then that is
later removed, the agent will revert to configuration defined locally
via either the Tracer Config API or environment variables.

By default, the agent will attempt to send data to the Elastic APM Server
at `http://localhost:8200`, to simplify development and testing. To send
Expand Down Expand Up @@ -469,3 +479,18 @@ logger. The only two levels used by the logger are "error" and "debug". By defau
logging is disabled. You must specify `ELASTIC_APM_LOG_FILE` to enable it.

This environment variable will be ignored if a logger is configured programatically.

[float]
[[config-central-config]]
==== `ELASTIC_APM_CENTRAL_CONFIG`

[options="header"]
|============
| Environment | Default
| `ELASTIC_APM_CENTRAL_CONFIG` | `true`
|============

Activate APM Agent Configuration via Kibana. By default the agent will poll the server
for agent configuration changes. This can be disabled by changing the setting to `false`.

NOTE: This feature requires APM Server v7.3 or later and that the APM Server is configured with `kibana.enabled: true`.

0 comments on commit 245fbdc

Please sign in to comment.