diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc index db7a9180eee4..6dece54c4d62 100644 --- a/CHANGELOG.next.asciidoc +++ b/CHANGELOG.next.asciidoc @@ -483,6 +483,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d - Remove io.time from windows {pull}22237[22237] - Change vsphere.datastore.capacity.used.pct value to betweeen 0 and 1. {pull}23148[23148] - Update config in `windows.yml` file. {issue}23027[23027]{pull}23327[23327] +- Add stack monitoring section to elasticsearch module documentation {pull}#23286[23286] *Packetbeat* diff --git a/metricbeat/docs/modules/elasticsearch.asciidoc b/metricbeat/docs/modules/elasticsearch.asciidoc index 18f9004a99ad..b0da11703c2c 100644 --- a/metricbeat/docs/modules/elasticsearch.asciidoc +++ b/metricbeat/docs/modules/elasticsearch.asciidoc @@ -12,6 +12,14 @@ The `elasticsearch` module collects metrics about {es}. The `elasticsearch` module works with {es} 6.7.0 and later. +[float] +=== Usage for Stack Monitoring + +The `elasticsearch` module can be used to collect metrics shown in our {stack} {monitor-features} +UI in {kib}. To enable this usage, set `xpack.enabled: true` and remove any `metricsets` +from the module's configuration. Alternatively, run `metricbeat modules disable elasticsearch` and +`metricbeat modules enable elasticsearch-xpack`. + [float] === Module-specific configuration notes @@ -24,11 +32,6 @@ the `hosts` list is interpreted by the module. * If `scope` is set to `cluster`, each entry in the `hosts` list indicates a single endpoint for a distinct {es} cluster (for example, a load-balancing proxy fronting the cluster). -The `elasticsearch` module can be used to collect metrics shown in our {stack} {monitor-features} -UI in {kib}. To enable this usage, set `xpack.enabled: true` and remove any `metricsets` -from the module's configuration. Alternatively, run `metricbeat modules disable elasticsearch` and -`metricbeat modules enable elasticsearch-xpack`. - [float] === Example configuration diff --git a/metricbeat/module/elasticsearch/_meta/docs.asciidoc b/metricbeat/module/elasticsearch/_meta/docs.asciidoc index b2b1a585a69c..db28ab50c74d 100644 --- a/metricbeat/module/elasticsearch/_meta/docs.asciidoc +++ b/metricbeat/module/elasticsearch/_meta/docs.asciidoc @@ -5,6 +5,14 @@ The `elasticsearch` module collects metrics about {es}. The `elasticsearch` module works with {es} 6.7.0 and later. +[float] +=== Usage for Stack Monitoring + +The `elasticsearch` module can be used to collect metrics shown in our {stack} {monitor-features} +UI in {kib}. To enable this usage, set `xpack.enabled: true` and remove any `metricsets` +from the module's configuration. Alternatively, run `metricbeat modules disable elasticsearch` and +`metricbeat modules enable elasticsearch-xpack`. + [float] === Module-specific configuration notes @@ -16,8 +24,3 @@ the `hosts` list is interpreted by the module. {es} cluster. * If `scope` is set to `cluster`, each entry in the `hosts` list indicates a single endpoint for a distinct {es} cluster (for example, a load-balancing proxy fronting the cluster). - -The `elasticsearch` module can be used to collect metrics shown in our {stack} {monitor-features} -UI in {kib}. To enable this usage, set `xpack.enabled: true` and remove any `metricsets` -from the module's configuration. Alternatively, run `metricbeat modules disable elasticsearch` and -`metricbeat modules enable elasticsearch-xpack`.