ZooKeeper
ZooKeeper
Plugin: go.d.plugin Module: zookeeper
Overview
It connects to the Zookeeper instance via a TCP and executes the following commands:
- mntr.
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
Prerequisites
Whitelist mntr command
Add mntr to Zookeeper’s 4lw.commands.whitelist.
Configuration
File
The configuration file name for this integration is go.d/zookeeper.conf.
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
Options
The following options can be defined globally: update_every, autodetection_retry.
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | no |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
| address | Server address. The format is IP:PORT. | 127.0.0.1:2181 | yes |
| timeout | Connection/read/write/ssl handshake timeout. | 1 | no |
| use_tls | Whether to use TLS or not. | no | no |
| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
| tls_ca | Certification authority that the client uses when verifying the server’s certificates. | no | |
| tls_cert | Client TLS certificate. | no | |
| tls_key | Client TLS key. | no |
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 instance
These metrics refer to the entire monitored application.
This scope has no labels.
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| zookeeper.requests | outstanding | requests |
| zookeeper.requests_latency | min, avg, max | ms |
| zookeeper.connections | alive | connections |
| 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.server_state | state | state |
Alerts
There are no alerts configured by default for this integration.
Troubleshooting
Debug Mode
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.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m zookeeper
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