Apache ZooKeeper OpenTelemetry Assets

Apache ZooKeeper is a centralized coordination service for distributed systems, providing primitives for configuration management, distributed synchronization, leader election, and group membership.

These assets include a dashboard, alert rules, and an SLO template built on data from the OpenTelemetry ZooKeeper receiver. They cover ensemble health, request latency, client connections, resource saturation, and replication status.

The Apache ZooKeeper OpenTelemetry assets have been tested with OpenTelemetry ZooKeeper receiver v0.121.0.

You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.

ZooKeeper must be configured to accept four-letter word commands so the receiver can query metrics via the mntr command. In zoo.cfg, ensure the following setting includes mntr:

4lw.commands.whitelist=mntr,ruok
		

You can verify the setting by running:

echo mntr | nc <ZOOKEEPER_HOST> <ZOOKEEPER_CLIENT_PORT>
		

A successful response returns a list of key-value metric pairs.

Configure the OpenTelemetry Collector (or EDOT Collector) to scrape your ZooKeeper ensemble and export to Elasticsearch.

• <ZOOKEEPER_ENDPOINT> — The host:port of a ZooKeeper node accepting four-letter word commands (e.g. localhost:2181).
• <ES_ENDPOINT> — Your Elasticsearch endpoint (e.g. https://my-deployment.es.us-east-1.aws.elastic.co:443).
• ${env:ES_API_KEY} — An Elasticsearch API key with write permissions, provided via the ES_API_KEY environment variable.

receivers:
  zookeeper:
    endpoint: <ZOOKEEPER_ENDPOINT>
    collection_interval: 30s

exporters:
  elasticsearch/otel:
    endpoints:
      - <ES_ENDPOINT>
    api_key: ${env:ES_API_KEY}
    mapping:
      mode: otel

service:
  pipelines:
    metrics:
      receivers:
        - zookeeper
      exporters:
        - elasticsearch/otel
		

Refer to the metadata.yaml of the OpenTelemetry ZooKeeper receiver for details on available metrics.

This integration includes one or more Kibana dashboards that visualizes the data collected by the integration. The screenshots below illustrate how the ingested data is displayed.

×