zookeeper

README

Apache ZooKeeper monitoring with Netdata

ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services.

This module monitors one or more ZooKeeper servers, depending on your configuration. It fetches metrics from ZooKeeper by using the mntr command.

Requirements

• Zookeeper with accessible client port
• whitelisted mntr command

Metrics

All metrics have "zookeeper." prefix.

Metric	Scope	Dimensions	Units
requests	global	outstanding	requests
requests_latency	global	min, avg, max	ms
connections	global	alive	connections
packets	global	received, sent	pps
file_descriptor	global	open	file descriptors
nodes	global	znode, ephemerals	nodes
watches	global	watches	watches
approximate_data_size	global	size	KiB
server_state	global	state	state

Configuration

Edit the go.d/zookeeper.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/zookeeper.conf

Needs only address to server's client port. Here is an example for 2 servers:

jobs:
  - name: local
    address: 127.0.0.1:2181

  - name: remote
    address: 203.0.113.10:2182

For all available options, please see the module configuration file.

Troubleshooting

To troubleshoot issues with the zookeeper collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/
  

• Switch to the netdata user.

  sudo -u netdata -s
  

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m zookeeper
  

Documentation

Index

• type Charts
• type Config
• type Dims
• type Vars
• type Zookeeper
  • func New() *Zookeeper
  • func (Zookeeper) Charts() *Charts
  • func (z *Zookeeper) Check() bool
  • func (Zookeeper) Cleanup()
  • func (z *Zookeeper) Collect() map[string]int64
  • func (z *Zookeeper) Init() bool

Types

type Charts

type Charts = module.Charts

type Config

type Config struct {
	Address          string
	Timeout          web.Duration `yaml:"timeout"`
	UseTLS           bool         `yaml:"use_tls"`
	tlscfg.TLSConfig `yaml:",inline"`
}

Config is the Zookeeper module configuration.

type Dims

type Dims = module.Dims

type Vars

type Vars = module.Vars

type Zookeeper

type Zookeeper struct {
	module.Base

	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

Zookeeper Zookeeper module.

func New

func New() *Zookeeper

New creates Zookeeper with default values.

func (Zookeeper) Charts

func (Zookeeper) Charts() *Charts

Charts creates Charts.

func (*Zookeeper) Check

func (z *Zookeeper) Check() bool

Check makes check.

func (Zookeeper) Cleanup

func (Zookeeper) Cleanup()

Cleanup makes cleanup.

func (*Zookeeper) Collect

func (z *Zookeeper) Collect() map[string]int64

Collect collects metrics.

func (*Zookeeper) Init

func (z *Zookeeper) Init() bool

Init makes initialization.