Apache ZooKeeper

The Apache ZooKeeper integration collects traffic metrics for nodes, such as latency, active requests, and active connections. The integration also collects ZooKeeper logs and parses them into a JSON payload. The result includes fields for node ID, source, level, and message.

For more information about ZooKeeper, see the Apache ZooKeeper documentation.

Prerequisites

To collect ZooKeeper telemetry, you must install the Ops Agent:

For metrics, install version 2.10.0 or higher.
For logs, install version 2.11.0 or higher.

This integration supports ZooKeeper versions 3.5, 3.6, and 3.7.

Configure the Ops Agent for ZooKeeper

Following the guide for Configuring the Ops Agent, add the required elements to collect telemetry from ZooKeeper instances, and restart the agent.

Example configuration

The following commands create the configuration to collect and ingest telemetry for ZooKeeper and restarts the Ops Agent.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    zookeeper:
      type: zookeeper
  service:
    pipelines:
      zookeeper:
        receivers:
          - zookeeper

logging:
  receivers:
    zookeeper_general:
      type: zookeeper_general
  service:
    pipelines:
      zookeeper_general:
        receivers:
          - zookeeper_general

EOF

sudo service google-cloud-ops-agent restart
sleep 30

Configure logs collection

To ingest logs from ZooKeeper, you must create receivers for the logs that ZooKeeper produces and then create a pipeline for the new receivers.

To configure a receiver for your zookeeper_general logs, specify the following fields:

Field	Default	Description
`exclude_paths`		A list of filesystem path patterns to exclude from the set matched by `include_paths`.
`include_paths`	`[/opt/zookeeper/logs/zookeeper-*.out, /var/log/zookeeper/zookeeper.log]`	A list of filesystem paths to read by tailing each file. A wild card (``) can be used in the paths; for example, `/var/log/zookeeper/*.log.`
`record_log_file_path`	`false`	If set to `true`, then the path to the specific file from which the log record was obtained appears in the output log entry as the value of the `agent.googleapis.com/log_file_path` label. When using a wildcard, only the path of the file from which the record was obtained is recorded.
`type`		The value must be `zookeeper_general`.
`wildcard_refresh_interval`	`60s`	The interval at which wildcard file paths in include_paths are refreshed. Given as a time duration, for example `30s` or `2m`. This property might be useful under high logging throughputs where log files are rotated faster than the default interval.

What is logged

The logName is derived from the receiver IDs specified in the configuration. Detailed fields inside the LogEntry are as follows.

The zookeeper_general logs contain the following fields in the LogEntry:

Field	Type	Description
`jsonPayload.level`	string	Log entry level
`jsonPayload.line`	number	Line number from which the log was generated in source
`jsonPayload.message`	string	Log message, including detailed stacktrace where provided
`jsonPayload.myid`	number	Numeric ID of the Zookeeper instance
`jsonPayload.source`	string	Source of where the log originated
`jsonPayload.thread`	string	Thread from which the log originated
`severity`	string (`LogSeverity`)	Log entry level (translated).

Configure metrics collection

To ingest metrics from ZooKeeper, you must create receivers for the metrics that ZooKeeper produces and then create a pipeline for the new receivers.

To configure a receiver for your zookeeper metrics, specify the following fields:

Field	Default	Description
`collection_interval`	`60s`	A time duration
`endpoint`	`localhost:2181`	The URL exposed by ZooKeeper.
`type`		This value must be `zookeeper`.

What is monitored

The following table provides the list of metrics that the Ops Agent collects from the ZooKeeper instance.

Metric type
Kind, Type Monitored resources	Labels
`workload.googleapis.com/zookeeper.connection.active`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.data_tree.ephemeral_node.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.data_tree.size`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.file_descriptor.limit`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.file_descriptor.open`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.fsync.exceeded_threshold.count`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.latency.avg`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.latency.max`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.latency.min`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.packet.count`
`CUMULATIVE`, `INT64` gce_instance	`direction`
`workload.googleapis.com/zookeeper.request.active`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.watch.count`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/zookeeper.znode.count`
`GAUGE`, `INT64` gce_instance

Sample dashboard

To view your ZooKeeper metrics, you must have a chart or dashboard configured. Cloud Monitoring provides a library of sample dashboards for integrations, which contain preconfigured charts. For information about installing these dashboards, see Installing sample dashboards.

Verify the configuration

This section describes how to verify that you correctly configured the ZooKeeper receiver. It might take one or two minutes for the Ops Agent to begin collecting telemetry.

To verify that the logs are ingested, go to the Logs Explorer and run the following query to view the ZooKeeper logs:

resource.type="gce_instance"
log_id("zookeeper_general")

To verify that the metrics are ingested, go to Metrics Explorer and run the following query in the MQL tab:

fetch gce_instance
| metric 'workload.googleapis.com/zookeeper.file_descriptor.limit'
| every 1m

What's next

For a walkthrough on how to use Ansible to install the Ops Agent, configure a third-party application, and install a sample dashboard, see the Install the Ops Agent to troubleshoot third-party applications video.