Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] APM Agent configuration documentation #86

Closed
8 of 9 tasks
bmorelli25 opened this issue May 6, 2019 · 2 comments
Closed
8 of 9 tasks

[docs] APM Agent configuration documentation #86

bmorelli25 opened this issue May 6, 2019 · 2 comments
Assignees
Labels
Milestone

Comments

@bmorelli25
Copy link
Member

bmorelli25 commented May 6, 2019

PRs & docs:


Agent config will take precedence over local config. Documentation for each agent should reflect that:


Here's some boilerplate documentation for APM Agent configuration (thanks to the Node.js team). Some of the agents use tables instead of unordered lists, so just adapt as necessary to your agent.

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

* *Type:* Boolean
* *Default:* `true`
* *Env:* `ELASTIC_APM_CENTRAL_CONFIG`

Enable {kibana-ref}/agent-configuration.html[APM Agent Configuration via Kibana].
If set to `true`, the client will poll the APM Server regularly for new agent configuration.

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

Info:

APM meta: #4
Agents meta-issue: #76
Server issue: elastic/apm-server#2126
Kibana issue: elastic/kibana#34990 elastic/kibana#39555
Integration testing issue: elastic/apm-integration-testing#436
Optimization / caching issue: elastic/apm-server#2220

Alert users that:

  • it may take some time for config changes to take effect.
  • Different server versions may cause problems
  • Add documentation that the user should make sure to define sane defaults in case the APM Server is offline (see Agent remote configuration #76 (comment))
@jalvz
Copy link
Contributor

jalvz commented May 24, 2019

Side note: this introduces an apm-server.kibana setting that needs documentation as well. Is the same one as setup.kibana in other Beats, but under the apm-server namespace instead of kibana.

@bmorelli25 bmorelli25 changed the title [docs] Config Management documentation [docs] APM Agent management documentation Jun 27, 2019
@bmorelli25 bmorelli25 changed the title [docs] APM Agent management documentation [docs] APM Agent configuration documentation Jul 1, 2019
@bmorelli25
Copy link
Member Author

All Agents, except for .NET, have an open or merged PR for these docs. .NET has an issue opened, which is linked to above. Closing this meta issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants