IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
Elastic Docs ›Metricbeat Reference [8.0] ›Modules
« Elasticsearch shard metricset Enterprise Search health metricset »

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.

Compatibilityedit

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.

Usageedit

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.

Example configurationedit

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

metricbeat.modules:
- module: enterprisesearch
  metricsets: ["health", "stats"]
  enabled: true
  period: 10s
  hosts: ["http://localhost:3002"]
  username: elastic
  password: changeme

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.

Metricsetsedit

The following metricsets are available:

« Elasticsearch shard metricset Enterprise Search health metricset »