Elasticsearch module
Refer to the Elastic Integrations documentation.
Learn more
Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to the documentation for a detailed comparison of Beats and Elastic Agent.
The elasticsearch module collects metrics about Elasticsearch.
The elasticsearch module works with Elasticsearch 6.7.0 and later.
The elasticsearch module can be used to collect metrics shown in our Stack Monitoring UI in Kibana. 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.
When xpack mode is enabled, all the legacy metricsets are automatically enabled by default. This means that you do not need to manually enable them, and there will be no conflicts or issues because Metricbeat merges the user-defined metricsets with the ones that xpack mode forces to enable. As a result, you can seamlessly collect comprehensive metrics without worrying about dataset overlap or duplication.
metricbeat.modules:
- module: elasticsearch
xpack.enabled: true
metricsets:
- ingest_pipeline
period: 10s
When this module is used for Elastic Stack Monitoring, it sends metrics to the monitoring index instead of the default index typically used by Metricbeat. For more details about the monitoring index, see Configuring indices for monitoring.
Like other Metricbeat modules, the elasticsearch module accepts a hosts configuration setting. This setting can contain a list of entries. The related scope setting determines how each entry in the hosts list is interpreted by the module.
- If
scopeis set tonode(default), each entry in thehostslist indicates a distinct node in an Elasticsearch cluster. - If
scopeis set tocluster, each entry in thehostslist indicates a single endpoint for a distinct Elasticsearch cluster (for example, a load-balancing proxy fronting the cluster).
The Elasticsearch module supports the standard configuration options that are described in Modules. Here is an example configuration:
metricbeat.modules:
- module: elasticsearch
metricsets:
- node
- node_stats
#- index
#- index_recovery
#- index_summary
#- ingest_pipeline
#- shard
#- ml_job
period: 10s
hosts: ["http://localhost:9200"]
#username: "elastic"
#password: "changeme"
#api_key: "foo:bar"
#ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
#index_recovery.active_only: true
#ingest_pipeline.processor_sample_rate: 0.25
#xpack.enabled: false
#scope: node
This module supports TLS connections when using ssl config field, as described in SSL. It also supports the options described in Standard HTTP config options.
The following metricsets are available: