- Notifications
You must be signed in to change notification settings - Fork 123
Description
Summary
Central configuration will be enabled for all dynamic parameters in 7.7. These new parameters need to be documented somewhere.
Currently
Currently, we document supported parameters in the Kibana reference. This makes sense, as prior to this update, all Agents supported the same few configurations. With more configurations coming online, this might not make sense for 7.7.
Solution
We should make a note of supported configuration options in each Agent reference. There are a few ways we could do this...
Custom badge
A custom badge would be very easy to scan for. This could help supported parameters stand out, and would link to more information on the feature. As a quick example, I created this badge and added it to the first two configurations in the Python reference:
or...
Unfortunately, these badges have to be inline, and we're very limited in terms of how asciidoctor displays something like this.
Just another paragraph
Doesn't pop as much, but maybe it doesn't need to.
Related issues
- Official name of the feature
APM Agent central configuration, per Agent remote configuration #76 (comment). - Agent support: Enable Remote Config for all dynamic parameters. #213 (comment)
- Discussion: Enable Remote Config for all dynamic parameters. #213
Related PRs
- Removes config list from the Kibana reference: docs: Update APM central config documentation kibana#61893.