Plugin: go.d.plugin Module: zookeeper
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.
By default, it detects instances running on localhost by attempting to connect using known ZooKeeper TCP sockets:
The default configuration for this integration does not impose any limits on data collection.
The default configuration for this integration is not expected to impose a significant performance impact on the system.
mntr
commandAdd mntr
to Zookeeper’s 4lw.commands.whitelist.
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
The following options can be defined globally: update_every, autodetection_retry.
Name | Description | Default | Required |
---|---|---|---|
update_every | Data collection frequency. | 1 | False |
autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | False |
address | Server address. The format is IP:PORT. | 127.0.0.1:2181 | True |
timeout | Connection/read/write/ssl handshake timeout. | 1 | False |
use_tls | Whether to use TLS or not. | False | False |
tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | False | False |
tls_ca | Certification authority that the client uses when verifying the server’s certificates. | False | |
tls_cert | Client TLS certificate. | False | |
tls_key | Client TLS key. | False |
Local server.
jobs:
- name: local
address: 127.0.0.1:2181
Zookeeper with TLS and self-signed certificate.
jobs:
- name: local
address: 127.0.0.1:2181
use_tls: yes
tls_skip_verify: yes
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 grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
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 |
There are no alerts configured by default for this integration.
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