Monitoring Zookeeper

This article will help you get the Zookeeper plugin for sd-agent configured and returning metrics

Installing the zookeeper plugin package

Install the zookeeper plugin on Debian/Ubuntu:

sudo apt-get install sd-agent-zookeeper

Install the zookeeper plugin on RHEL/CentOS:

sudo yum install sd-agent-zookeeper

Read more about agent plugins.

Configuring the agent to monitor Apache ZooKeeper

1. Configure /etc/sd-agent/conf.d/zk.yaml

init_config:

instances:
  - host: localhost
    port: 2181
    timeout: 3

2. Restart the agent

sudo /etc/init.d/sd-agent restart

or

sudo systemctl restart sd-agent

Verifying the configuration
Execute info to verify the configuration with the following:

sudo /etc/init.d/sd-agent info 

or

/usr/share/python/sd-agent/agent.py info

If the agent has been configured correctly you'll see an output such as:

zookeeper
-----
  - instance #0 [OK]
  - Collected * metrics

You can also view the metrics returned with the following command:

sudo -u sd-agent /usr/share/python/sd-agent/agent.py check zk

Configuring graphs

Click the name of your server from the Devices list in your Server Density account then go to the Metrics tab. Click the + Graph button on the right then choose the zookeeper metrics to display the graphs. The metrics will also be available to select when building dashboard graphs.

Monitored metrics

Metric	Values
zookeeper.bytes_received	byte / second Type: float
zookeeper.bytes_sent	byte / second Type: float
zookeeper.connections	connection / second Type: float
zookeeper.latency.avg	millisecond / second Type: float
zookeeper.latency.max	millisecond / second Type: float
zookeeper.latency.min	millisecond / second Type: float
zookeeper.nodes	/ second Type: float
zookeeper.outstanding_requests	request / second Type: float
zookeeper.packets_received The number of packets received.	packet / second Type: float
zookeeper.packets_sent The number of packets sent.	packet / second Type: float
zookeeper.serverdensity_client_exception The exception rate seen by the Server Density Agent when trying to collect stats.	error / None Type: float
zookeeper.timeouts The rate of timeouts the Datadog Agent received when trying to collect stats.	occurrence / None Type: float
zookeeper.zxid.count	/ second Type: float
zookeeper.zxid.epoch	/ second Type: float

Metrics Conversion

Please refer to the metrics conversion document to map old metrics names to the new metric names.