Apache Zookeeper 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the Apache Zookeeper monitor using the Smart Agent Receiver.

This monitor keeps track of an Apache Zookeeper instance using the Zookeeper plugin. This plugin is installed with the Smart Agent so no additional installation is required to use this monitor. The plugin supports Zookeeper 3.4.0 and higher.

Note

This monitor is not available on Windows as collectd plugins are only supported in Linux and Kubernetes.

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this Smart Agent monitor with the Collector, include the smartagent receiver and service pipeline in your configuration file. The Smart Agent receiver is fully supported only on x86_64/amd64 platforms.

Read more in Use Smart Agent monitors with the Collector.
Learn about config options in Collector default configuration.

See the examples below for more details.

Configuration example 🔗

receivers:
smartagent/zookeeper:
type: collectd/zookeeper
... # Additional config

To complete the integration, include the monitor in a metrics pipeline. Add the monitor item to the service/pipelines/metrics/receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/zookeeper]

Configuration settings 🔗

The following table shows the configuration options for the Apache Zookeeper monitor:

Option	Required	Type	Description
`pythonBinary`	no	`string`	This string contains a path to a python binary that you want to use to execute the Python code. If you don’t set it, the system uses a built-in runtime will be used. The string can include arguments to the binary.
`host`	yes	`string`	This string specifies the host or IP address of the Apache Zookeeper node.
`port`	yes	`integer`	This value specifies the main port of the Zookeeper node.
`name`	no	`string`	If you provide this string, the system inserts it as the value of the `plugin_instance` dimension for emitted

Metrics 🔗

The following metrics are available for this integration:

Group leader metrics 🔗

All of the following metrics are part of the leader metric group. To activate them, add leader to the extraGroups setting:

gauge.zk_followers
gauge.zk_pending_syncs
gauge.zk_synced_followers

Get help 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics