Set reference config as config for docs #6671
Conversation
metricbeat/metricbeat.reference.yml
Outdated
|
|
||
| # Path to server status. Default server-status | ||
| #server_status_path: "server-status" | ||
| server_status_path: "server-status" | ||
|
|
There was a problem hiding this comment.
I've looked at the configuration, I see sometime we define enabled: false and sometime we don't, I think we should be explicit and it should be defined all the time.
I am saying this because your changes is removing that option.
| # If both the `by_cpu` and `by_memory` options are used, the union of the two sets | ||
| # is included. | ||
| #process.include_top_n: | ||
| # |
There was a problem hiding this comment.
cleaned it up in our beat.reference.yml.
ruflin
force-pushed
the
reference-config
branch
from
079c69f
to
c228ef3
Compare
|
Cleaned up version pushed. |
|
This should be rebased and run |
| period: 15m | ||
| metricsets: | ||
| - uptime | ||
| # A list of filesystem types to ignore. The filesystem metricset will not |
There was a problem hiding this comment.
We decided awhile back ago to strip out most comments from config examples because it meant updating duplicate content and making the docs longer. I think short comments are probably OK, but the comments here seem like that might get out-of-date over time. I worry that we'll forget to update the comments here.
There was a problem hiding this comment.
This is from our reference docs and are the ones that should be most up-to-date. This part is auto generated.
|
Will need a rebase :( |
Having the reference file as example config in the docs has the advantage that all config options are shown. The assumption here is that users already know the short version of the config from the config file and come here to learn additional details. * Clean up nginx reference config to be more similar to others
|
Ready to go. |
Having the reference file as example config in the docs has the advantage that all config options are shown.