Datadog-Zookeeper Integration

Zendesk Dashboard

Overview

The Zookeeper check tracks client connections and latencies, monitors the number of unprocessed requests, and more.

Setup

Installation

The Zookeeper check is packaged with the Agent, so simply install the Agent on your Zookeeper servers. If you need the newest version of the check, install the dd-check-zk package.

Configuration

Create a file zk.yaml in the Agent’s conf.d directory. See the sample zk.yaml for all available configuration options:

init_config:

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

Restart the Agent to start sending Zookeeper metrics to Datadog.

Validation

Run the Agent’s info subcommand and look for zk under the Checks section:

  Checks
  ======
    [...]

    zk
    -------
      - instance #0 [OK]
      - Collected 14 metrics, 0 events & 1 service check

    [...]

Compatibility

The Zookeeper check is compatible with all major platforms.

Data Collected

Metrics

zookeeper.bytes_received
(gauge)

shown as
zookeeper.bytes_sent
(gauge)

shown as
zookeeper.packets_received
(gauge)
The number of packets received.
shown as packet
zookeeper.packets_sent
(gauge)
The number of packets sent.
shown as packet
zookeeper.connections
(gauge)
The total count of client connections.
shown as connection
zookeeper.datadog_client_exception
(rate)
The exception rate seen by the Datadog Agent when trying to collect stats.
shown as error
zookeeper.latency.avg
(gauge)
The amount of time it takes for the server to respond to a client request.
shown as millisecond
zookeeper.latency.max
(gauge)
The amount of time it takes for the server to respond to a client request.
shown as millisecond
zookeeper.latency.min
(gauge)
The amount of time it takes for the server to respond to a client request.
shown as millisecond
zookeeper.nodes
(gauge)
The number of znodes in the ZooKeeper namespace (the data).
shown as node
zookeeper.outstanding_requests
(gauge)
The number of queued requests when the server is under load and is receiving more sustained requests than it can process.
shown as request
zookeeper.timeouts
(rate)
The rate of timeouts the Datadog Agent received when trying to collect stats.
shown as occurrence
zookeeper.zxid.count
(gauge)

shown as
zookeeper.zxid.epoch
(gauge)

shown as

Events

The Zookeeper check does not include any event at this time.

Service Checks

zookeeper.ruok:

Returns CRITICAL if Zookeeper does not respond to the Agent’s ‘ruok’ request, otherwise OK.

zookeeper.mode:

The Agent submits this service check if expected_mode is configured in zk.yaml. The check returns OK when Zookeeper’s actual mode matches expected_mode, otherwise CRITICAL.

Troubleshooting

Need help? Contact Datadog Support.

Further Reading

Learn more about infrastructure monitoring and all our integrations on our blog