Skip to main content

Apache ZooKeeper monitoring with Netdata

ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services.

This module monitors one or more ZooKeeper servers, depending on your configuration. It fetches metrics from ZooKeeper by using the mntr command.

Requirements

  • Zookeeper with accessible client port
  • whitelisted mntr command

Metrics

All metrics have "zookeeper." prefix.

MetricScopeDimensionsUnits
requestsglobaloutstandingrequests
requests_latencyglobalmin, avg, maxms
connectionsglobalaliveconnections
packetsglobalreceived, sentpps
file_descriptorglobalopenfile descriptors
nodesglobalznode, ephemeralsnodes
watchesglobalwatcheswatches
approximate_data_sizeglobalsizeKiB
server_stateglobalstatestate

Configuration

Edit the go.d/zookeeper.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/zookeeper.conf

Needs only address to server's client port. Here is an example for 2 servers:

jobs:
- name: local
address: 127.0.0.1:2181

- name: remote
address: 203.0.113.10:2182

For all available options, please see the module configuration file.

Troubleshooting

To troubleshoot issues with the zookeeper collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m zookeeper

Was this page helpful?

Contribute