Enterprise Search moduleedit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

This module periodically fetches metrics and health information from Elastic Enterprise Search instances using HTTP APIs.


The module has been tested with Enterprise Search versions 7.16.0 and higher. Versions below 7.16.0 are not expected to work due to a number of API-level incompatibilities.


The Enterprise Search module requires a set of credentials (a username and a password) for an Elasticserch user for a user that has a monitor cluster privilege.

Usage for Elastic Stack Monitoringedit

The Enterprise Search module can be used to collect metrics shown in our Stack Monitoring UI in Kibana. To enable this usage, set xpack.enabled: true in configuration.

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.

Example configuration

The Enterprise Search module supports the standard configuration options that are described in Modules. Here is an example configuration:

- module: enterprisesearch
  metricsets: ["health", "stats"]
  enabled: true
  period: 10s
  hosts: ["http://localhost:3002"]
  #username: "user"
  #password: "secret"

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: