Skip to content

[docs] Document new Central configuration support #232

@bmorelli25

Description

@bmorelli25

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:

Screen Shot 2020-03-30 at 11 06 58 AM

or...

Screen Shot 2020-03-30 at 9 33 25 AM

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.

Screen Shot 2020-03-30 at 11 07 25 AM

Related issues

Related PRs

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions