ZooKeeper icon

ZooKeeper

ZooKeeper

Plugin: go.d.plugin Module: zookeeper

Overview

It connects to the Zookeeper instance via a TCP and executes the following commands:

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

By default, it detects instances running on localhost by attempting to connect using known ZooKeeper TCP sockets:

  • 127.0.0.1:2181
  • 127.0.0.1:2182

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the zookeeper collector in two ways:

Method Best for How to
UI Fast setup without editing files Go to Nodes → Configure this node → Collectors → Jobs, search for zookeeper, then click + to add a job.
File If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) Edit go.d/zookeeper.conf and add a job.

:::important

UI configuration requires paid Netdata Cloud plan.

:::

Prerequisites

Whitelist mntr command

Add mntr to Zookeeper’s 4lw.commands.whitelist.

Configuration

Options

The following options can be defined globally: update_every, autodetection_retry.

Group Option Description Default Required
Collection update_every Data collection interval (seconds). 1 no
autodetection_retry Autodetection retry interval (seconds). Set 0 to disable. 0 no
Target address Zookeeper server address (IP:PORT). 127.0.0.1:2181 yes
timeout Connection, read, write, and TLS handshake timeout (seconds). 1 no
TLS use_tls Enable TLS for the connection. no no
tls_skip_verify Skip TLS certificate and hostname verification (insecure). no no
tls_ca Path to CA bundle used to validate the server certificate. no
tls_cert Path to client TLS certificate (for mTLS). no
tls_key Path to client TLS private key (for mTLS). no
Virtual Node vnode Associates this data collection job with a Virtual Node. no

via UI

Configure the zookeeper collector from the Netdata web interface:

  1. Go to Nodes.
  2. Select the node where you want the zookeeper data-collection job to run and click the :gear: (Configure this node). That node will run the data collection.
  3. The Collectors → Jobs view opens by default.
  4. In the Search box, type zookeeper (or scroll the list) to locate the zookeeper collector.
  5. Click the + next to the zookeeper collector to add a new job.
  6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
    • Test runs the job with the provided settings and shows whether data can be collected.
    • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/zookeeper.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/zookeeper.conf
Examples
Basic

Local server.

jobs:
  - name: local
    address: 127.0.0.1:2181
TLS with self-signed certificate

Zookeeper with TLS and self-signed certificate.

jobs:
  - name: local
    address: 127.0.0.1:2181
    use_tls: yes
    tls_skip_verify: yes
Multi-instance

Note: When you define multiple jobs, their names must be unique.

Collecting metrics from local and remote instances.

jobs:
  - name: local
    address: 127.0.0.1:2181

  - name: remote
    address: 192.0.2.1:2181

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per ZooKeeper server

These metrics refer to ZooKeeper servers.

This scope has no labels.

Metrics:

Metric Dimensions Unit
zookeeper.requests outstanding requests
zookeeper.requests_latency min, avg, max ms
zookeeper.stale_requests stale requests/s
zookeeper.stale_requests_dropped dropped requests/s
zookeeper.connections alive connections
zookeeper.connections_dropped dropped connections/s
zookeeper.connections_rejected rejected connections/s
zookeeper.auth_fails auth fails/s
zookeeper.global_sessions global sessions
zookeeper.server_state leader, follower, observer, standalone state
zookeeper.throttled_ops throttled ops/s
zookeeper.packets received, sent pps
zookeeper.file_descriptor open file descriptors
zookeeper.nodes znode, ephemerals nodes
zookeeper.watches watches watches
zookeeper.approximate_data_size size KiB
zookeeper.uptime uptime seconds

Alerts

There are no alerts configured by default for this integration.

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

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

    To debug a specific job:

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

Getting Logs

If you’re encountering problems with the zookeeper collector, follow these steps to retrieve logs and identify potential issues:

  • Run the command specific to your system (systemd, non-systemd, or Docker container).
  • Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep zookeeper

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:

grep zookeeper /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:

docker logs netdata 2>&1 | grep zookeeper

The observability platform companies need to succeed

Sign up for free

Want a personalised demo of Netdata for your use case?

Book a Demo