Restructure beats config options#4716
Conversation
7f4e9e0 to
0b75dab
Compare
0b75dab to
d565b57
Compare
e454ce6 to
822975f
Compare
| @@ -0,0 +1,11 @@ | |||
| [[packetbeat-reference-yml]] | |||
There was a problem hiding this comment.
Trying an experiment here. Is it worthwhile to provide this in the docs? This is sort of placeholder for a real quick reference that lists all config options.
There was a problem hiding this comment.
As discussed, let's add the reference file to all Beats docs.
|
@monicasarbu This is ready for a review. I have a few issues I need to address (either before or after the PR is merged):
|
|
@dedemorton I don't see any issue if you point directly to the reference file. |
|
|
||
| [[exported-fields-php_fpm]] | ||
| == php_fpm Fields | ||
| == PHP-FPM Fields |
There was a problem hiding this comment.
@monicasarbu In my edits, I'm being consistent with our general approach of using the name of the product/service that's being monitored (for example, PHP-FPM) when we describe the module. Otherwise, especially in headings, it sort of looks like we are misspelling product names. But I'm wondering...do you think this might cause people to use the wrong module names in their configs (like php-fpm instead of php_fpm)? We do show a config example, so I might be overthinking this.
There was a problem hiding this comment.
I would say to leave the name of the module as it shows in the configuration (with _ instead of -) as otherwise might be confusing for the user.
* Restructure Filebeat and Libbeat config options * Restructure Heartbeat config options * Restructure Packetbeat config options * Experiment: show packetbeat.reference.yml in the docs * Restructure Winlogbeat config options * Restructure Metricbeat config options * Restructure Auditbeat config options * Add reference configs to the docs * Move include statement for general options for consistency
* Restructure Filebeat and Libbeat config options * Restructure Heartbeat config options * Restructure Packetbeat config options * Experiment: show packetbeat.reference.yml in the docs * Restructure Winlogbeat config options * Restructure Metricbeat config options * Restructure Auditbeat config options * Add reference configs to the docs * Move include statement for general options for consistency
* Restructure Filebeat and Libbeat config options * Restructure Heartbeat config options * Restructure Packetbeat config options * Experiment: show packetbeat.reference.yml in the docs * Restructure Winlogbeat config options * Restructure Metricbeat config options * Restructure Auditbeat config options * Add reference configs to the docs * Move include statement for general options for consistency
This resolves #4422 plus applies the same structural changes to all the Beats documentation. Here's a link to the docs for preview (a bit outdated because I've pushed changes to the files since I published the example). Please ignore the fact that the URL says logstash. I kept kicking Firebase, but it wouldn't let me create and deploy to a new app.
This PR mostly covers structural and style changes. I also added some missing content, moved some stuff around, and changed some text to improve the flow. The only new content (other than some filler text) is what I've added to filebeat-modules-options.asciidoc. Other stuff that appears new was just moved from another file. I needed to move things to restructure the TOC.
Summary of changes:
Changes for all beats:
referencefolder in the source (it was lame)Additional changes for Filebeat:
Additional changes for Packetbeat:
I lost track of the changes for the other beats, so I can't summarize them here.