Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Apache Zookeeper

A tool for coordinating Distributed Systems

Data Collection Setup

Metrics are collected from the JMX interface from the ZooKeeper server(s).

Network Requirements

JMX Port (TCP):

By default, ZooKeeper does NOT enable remote JMX monitoring, only local JMX monitoring. Enabling remote JMX requires specifying a port for remote connections and there is NO default value for this. For more information, see Enabling Remote JMX

Enabling Remote JMX

To enable remote JMX for each ZooKeeper server, go through the following steps for each server.

  1. Navigate to the directory where ZooKeeper is installed
    {PATH TO ZK INSTALL}/apache-zookeeper-{VERSION NUMBER}-bin/
  2. Navigate to the conf directory
  3. In this directory, create a file called zookeeper-env.sh
  4. Paste the following contents into zookeeper-env.sh
    JMXLOCALONLY=false
    JMXDISABLE=false
    JMXPORT={DESIRED PORT NUMBER excluding the braces}
    JMXAUTH=false
    JMXSSL=false
    
  5. Restart each ZooKeeper server and, to test if remote JMX is enabled (Without Authentication), try remotely monitoring the ZooKeeper servers with JConsole

Least Privileged User

By default, JMX doesn't use authentication. If authentication is enabled, a JMX user and password is required.

Refer to Enabling remote JMX with password authentication and SSL to learn more about setting up authentication.

Supported Versions

ZooKeeper: 3.4.0 - 3.5.5

Connection Parameters

Name
Required?
Description

Host

Required

The Host of Apache ZooKeeper.

Port

The port for communication to the JMX agent on the Apache ZooKeeper host.

Username

Required only if monitoring ZooKeeper through a JMX agent that requires password authentication.

Password

Required only if monitoring ZooKeeper through a JMX agent that requires password authentication.

Connection Timeout

The timeout in seconds for the JMX agent connection.

Metrics

JVM

Name
Description

Compilation Time (Milliseconds)

The approximate accumulated elapsed time spent in compilation.

CPU Time (Nanoseconds)

The CPU time used by the process on which the Java virtual machine is running.

Daemon Threads (Threads)

The current number of live daemon threads.

Garbage Collector Collection Count

The total number of collections that have occurred.

Garbage Collector Collection Time (Milliseconds)

The accumulated collection elapsed time.

Heap Memory Committed (Bytes)

The amount of heap memory that is committed for the Java virtual machine to use.

Heap Memory Initialized (Bytes)

The amount of heap memory that the Java virtual machine initially requests from the operating system for memory management.

Heap Memory Used (Bytes)

The amount of used heap memory.

Live Threads (Threads)

The current number of live threads including both daemon and non-daemon threads.

Loaded Classes Count

The number of classes that are currently loaded in the Java virtual machine.

Maximum Heap Memory (Bytes)

The maximum amount of heap memory that can be used for memory management.

Maximum Non-heap Memory (Bytes)

The maximum amount of non-heap memory that can be used for memory management.

Name

The name representing the running Java virtual machine.

Non-heap Memory Committed (Bytes)

The amount of non-heap memory that is committed for the Java virtual machine to use.

Non-heap Memory Initialized (Bytes)

The amount of non-heap memory that the Java virtual machine initially requests from the operating system for memory management.

Non-heap Memory Used (Bytes)

The amount of used non-heap memory.

Open Files

The number of open file descriptors.

Peak Threads (Threads)

The peak live thread count since the Java virtual machine started or peak was reset.

Specification Version

The Java virtual machine specification version.

Started Threads (Threads)

The total number of threads created and also started since the Java virtual machine started.

Uptime (Milliseconds)

The uptime of the Java virtual machine.

Vendor

The Java virtual machine specification vendor.

Server

Name
Description

Average Request Latency (Milliseconds)

The amount of time it takes for the server to respond to a client request.

Client Port

The client port number.

Data Size (Bytes)

The approximate amount of data on this ZooKeeper server.

Ephemerals

Number of ephemeral nodes.

Followers

Number of followers.

Host

The host of the ZooKeeper server.

Maximum Connections

Maximum number of client connections per host.

Maximum Request Latency (Milliseconds)

The maximum amount of time it takes for the server to respond to a client request.

Minimum Request Latency (Milliseconds)

The minimum amount of time it takes for the server to respond to a client request.

Nodes

The number of znodes in the ZooKeeper namespace.

Open Connections (Connections)

The total number of open client connections.

Outstanding Requests (Requests)

The number of queued requests when the server is under load and is receiving more sustained requests than it can process.

Packets Received (Packets)

The number of packets received on this ZooKeeper server.

Packets Sent (Packets)

The number of packets sent on this ZooKeeper server.

Pending Revalidations

Count of pending session revalidations.

Synced Followers

Number of synchronized followers.

Watch Count

Number of watches on ZooKeeper nodes.

ZooKeeper Version

The version of ZooKeeper currently running on the server.

Apache Zookeeper


A tool for coordinating Distributed Systems

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.