Elasticsearch module

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 Elastic Stack monitoring features 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.

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
    #- shard
    #- ml_job
  period: 10s
  hosts: ["http://localhost:9200"]
  #username: "elastic"
  #password: "changeme"
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Set to false to fetch all entries
  #index_recovery.active_only: true

  # Set to true to send data collected by module to X-Pack
  # Monitoring instead of metricbeat-* indices.
  #xpack.enabled: false

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: