Backports the following commits to 7.x: - Docs: Simplifying setup by using module configuration variant syntax (#40879)
This commit is contained in:
parent
2206491277
commit
5990c54801
|
@ -81,7 +81,7 @@ run the following command:
|
||||||
|
|
||||||
["source","sh",subs="attributes,callouts"]
|
["source","sh",subs="attributes,callouts"]
|
||||||
----------------------------------------------------------------------
|
----------------------------------------------------------------------
|
||||||
metricbeat modules enable elasticsearch
|
metricbeat modules enable elasticsearch-xpack
|
||||||
----------------------------------------------------------------------
|
----------------------------------------------------------------------
|
||||||
|
|
||||||
For more information, see
|
For more information, see
|
||||||
|
@ -89,45 +89,22 @@ For more information, see
|
||||||
{metricbeat-ref}/metricbeat-module-elasticsearch.html[{es} module].
|
{metricbeat-ref}/metricbeat-module-elasticsearch.html[{es} module].
|
||||||
--
|
--
|
||||||
|
|
||||||
.. Configure the {es} module in {metricbeat}. +
|
.. By default the module will collect {es} monitoring metrics from `http://localhost:9200`.
|
||||||
+
|
If the local {es} node has a different address, you must specify it via the `hosts` setting
|
||||||
--
|
in the `modules.d/elasticsearch-xpack.yml` file.
|
||||||
You must specify the following settings in the `modules.d/elasticsearch.yml` file:
|
|
||||||
|
|
||||||
[source,yaml]
|
.. If Elastic {security-features} are enabled, you must also provide a user ID
|
||||||
----------------------------------
|
|
||||||
- module: elasticsearch
|
|
||||||
metricsets:
|
|
||||||
- ccr
|
|
||||||
- cluster_stats
|
|
||||||
- index
|
|
||||||
- index_recovery
|
|
||||||
- index_summary
|
|
||||||
- ml_job
|
|
||||||
- node_stats
|
|
||||||
- shard
|
|
||||||
period: 10s
|
|
||||||
hosts: ["http://localhost:9200"] <1>
|
|
||||||
xpack.enabled: true <2>
|
|
||||||
----------------------------------
|
|
||||||
<1> This setting identifies the host and port number that are used to access {es}.
|
|
||||||
<2> This setting ensures that {kib} can read this monitoring data successfully.
|
|
||||||
That is to say, it's stored in the same location and format as monitoring data
|
|
||||||
that is sent by <<es-monitoring-exporters,exporters>>.
|
|
||||||
--
|
|
||||||
|
|
||||||
.. If Elastic {security-features} are enabled, you must also provide a user ID
|
|
||||||
and password so that {metricbeat} can collect metrics successfully.
|
and password so that {metricbeat} can collect metrics successfully.
|
||||||
|
|
||||||
... Create a user on the production cluster that has the
|
... Create a user on the production cluster that has the
|
||||||
{stack-ov}/built-in-roles.html[`remote_monitoring_collector` built-in role].
|
{stack-ov}/built-in-roles.html[`remote_monitoring_collector` built-in role].
|
||||||
Alternatively, use the {stack-ov}/built-in-users.html[`remote_monitoring_user` built-in user].
|
Alternatively, use the {stack-ov}/built-in-users.html[`remote_monitoring_user` built-in user].
|
||||||
|
|
||||||
... Add the `username` and `password` settings to the {es} module configuration
|
... Add the `username` and `password` settings to the {es} module configuration
|
||||||
file.
|
file.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
For example, add the following settings in the `modules.d/elasticsearch.yml` file:
|
For example, add the following settings in the `modules.d/elasticsearch-xpack.yml` file:
|
||||||
|
|
||||||
[source,yaml]
|
[source,yaml]
|
||||||
----------------------------------
|
----------------------------------
|
||||||
|
@ -140,7 +117,7 @@ For example, add the following settings in the `modules.d/elasticsearch.yml` fil
|
||||||
|
|
||||||
.. If you configured {es} to use <<configuring-tls,encrypted communications>>,
|
.. If you configured {es} to use <<configuring-tls,encrypted communications>>,
|
||||||
you must access it via HTTPS. For example, use a `hosts` setting like
|
you must access it via HTTPS. For example, use a `hosts` setting like
|
||||||
`https://localhost:9200` in the `modules.d/elasticsearch.yml` file.
|
`https://localhost:9200` in the `modules.d/elasticsearch-xpack.yml` file.
|
||||||
|
|
||||||
.. Identify where to send the monitoring data. +
|
.. Identify where to send the monitoring data. +
|
||||||
+
|
+
|
||||||
|
|
Loading…
Reference in New Issue