IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Windows service metricset ZooKeeper connection metricset »
Elastic Docs ›Metricbeat Reference [8.10] ›Modules

ZooKeeper module

edit

ZooKeeper module

edit

Prefer to use Elastic Agent for this use case?

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 ZooKeeper module fetches statistics from the ZooKeeper service. The default metricsets are mntr and server.

Compatibility

edit

The ZooKeeper metricsets were tested with ZooKeeper 3.4.8, 3.6.0 and 3.7.0. They are expected to work with all versions >= 3.4.0. Versions prior to 3.4 do not support the mntr command.

Note that from ZooKeeper 3.6.0, mntr, stat, ruok, conf, isro, cons command must be explicitly enabled at ZooKeeper side using the 4lw.commands.whitelist configuration parameter.

Dashboard

edit

The Zookeeper module comes with a predefined dashboard:

metricbeat zookeeper

Example configuration

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

metricbeat.modules:
- module: zookeeper
  enabled: true
  metricsets: ["mntr", "server"]
  period: 10s
  hosts: ["localhost:2181"]

Metricsets

The following metricsets are available:

« Windows service metricset ZooKeeper connection metricset »