Skip to content

Commit e3854da

Browse files
committed
Docs: Simplifying setup by using module configuration variant syntax (elastic#40879)
Now that elastic/beats#9118 is merged, starting 7.1 users will be able configure Metricbeat for monitoring Elasticsearch nodes using a simpler syntax. Previously, users would have to run `metricbeat modules enable elasticsearch` to enable the `elasticsearch` Metricbeat module, then configure the module for Stack Monitoring by manually editing `modules.d/elasticsearch.yml`. Going forward, users will be able to achieve the same effect by running `metricbeat modules enable elasticsearch-xpack`. This PR updates the docs with this change. Related: elastic/kibana#34599
1 parent 2206491 commit e3854da

File tree

1 file changed

+9
-32
lines changed

1 file changed

+9
-32
lines changed

docs/reference/monitoring/configuring-metricbeat.asciidoc

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -81,53 +81,30 @@ run the following command:
8181

8282
["source","sh",subs="attributes,callouts"]
8383
----------------------------------------------------------------------
84-
metricbeat modules enable elasticsearch
84+
metricbeat modules enable elasticsearch-xpack
8585
----------------------------------------------------------------------
8686

8787
For more information, see
8888
{metricbeat-ref}/configuration-metricbeat.html[Specify which modules to run] and
8989
{metricbeat-ref}/metricbeat-module-elasticsearch.html[{es} module].
9090
--
9191

92-
.. Configure the {es} module in {metricbeat}. +
93-
+
94-
--
95-
You must specify the following settings in the `modules.d/elasticsearch.yml` file:
96-
97-
[source,yaml]
98-
----------------------------------
99-
- module: elasticsearch
100-
metricsets:
101-
- ccr
102-
- cluster_stats
103-
- index
104-
- index_recovery
105-
- index_summary
106-
- ml_job
107-
- node_stats
108-
- shard
109-
period: 10s
110-
hosts: ["http://localhost:9200"] <1>
111-
xpack.enabled: true <2>
112-
----------------------------------
113-
<1> This setting identifies the host and port number that are used to access {es}.
114-
<2> This setting ensures that {kib} can read this monitoring data successfully.
115-
That is to say, it's stored in the same location and format as monitoring data
116-
that is sent by <<es-monitoring-exporters,exporters>>.
117-
--
92+
.. By default the module will collect {es} monitoring metrics from `http://localhost:9200`.
93+
If the local {es} node has a different address, you must specify it via the `hosts` setting
94+
in the `modules.d/elasticsearch-xpack.yml` file.
11895

119-
.. If Elastic {security-features} are enabled, you must also provide a user ID
96+
.. If Elastic {security-features} are enabled, you must also provide a user ID
12097
and password so that {metricbeat} can collect metrics successfully.
12198

122-
... Create a user on the production cluster that has the
99+
... Create a user on the production cluster that has the
123100
{stack-ov}/built-in-roles.html[`remote_monitoring_collector` built-in role].
124101
Alternatively, use the {stack-ov}/built-in-users.html[`remote_monitoring_user` built-in user].
125102

126-
... Add the `username` and `password` settings to the {es} module configuration
103+
... Add the `username` and `password` settings to the {es} module configuration
127104
file.
128105
+
129106
--
130-
For example, add the following settings in the `modules.d/elasticsearch.yml` file:
107+
For example, add the following settings in the `modules.d/elasticsearch-xpack.yml` file:
131108

132109
[source,yaml]
133110
----------------------------------
@@ -140,7 +117,7 @@ For example, add the following settings in the `modules.d/elasticsearch.yml` fil
140117

141118
.. If you configured {es} to use <<configuring-tls,encrypted communications>>,
142119
you must access it via HTTPS. For example, use a `hosts` setting like
143-
`https://localhost:9200` in the `modules.d/elasticsearch.yml` file.
120+
`https://localhost:9200` in the `modules.d/elasticsearch-xpack.yml` file.
144121

145122
.. Identify where to send the monitoring data. +
146123
+

0 commit comments

Comments
 (0)