Elasticsearch moduleedit

There are two modules that collect metrics about Elasticsearch:

  • The Elasticsearch module contains a minimal set of metrics to enable monitoring of Elasticsearch across multiple versions. The default metricsets in this module are node and node_stats.
  • The Elasticsearch X-Pack module enables you to monitor more Elasticsearch metrics with our monitoring feature. The default metricsets in this module are ccr, cluster_stats, index, index_recovery, index_summary, ml_job, node_stats, and shard.


The Elasticsearch module is tested with Elasticsearch 6.3 and is expected to work with all 6.x versions.

Example configurationedit

The Elasticsearch module supports the standard configuration options that are described in Specify which modules to run. Here is an example configuration:

- module: elasticsearch
    - 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 Specify SSL settings. It also supports the options described in Standard HTTP config options.


The following metricsets are available: