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 HBase

Monitor Apache's Distributed, Non-relational Database

Data Collection Setup

HBase emit Hadoop metrics via Java Management Extensions (JMX) that are specific to HBase deployments.

HBase can be configured for either Standalone or in a Distributed configuration. Set this to the correct setting during the Source configuration.

JMX Service URL or Host & Port are the two collection configurations.

JMX needs to be enabled on the master and region servers.

Enabling JMX Metrics

JMX needs to be enabled on the master and region servers. Or only Master in the case of a standalone installation.

These are required to enable metric collection. Follow the instructions for enabling metric collection:
https://hbase.apache.org/metrics.html

For Distributed Environments, JMX monitoring has to be enabled on the Master and Region servers.

Example Service URL

service:jmx:rmi:///jndi/rmi://c7-hbase-1.bluemedora.localnet:10101/jmxrmi

Least Privilege User

JMX Read-only user with monitor permissions.
See https://hbase.apache.org/metrics.html for more information.

Network Requirements

Ports for Distributed: 10102
Ports for Standalone: 10101

Supported Versions

HBase:
Minimum: 0.98, 1.x, 2.1.4

Connection Parameters

Name
Required?
Description

JMX Connection Type

Provide the JMX Service URL or provide the Host and Port for the master server's JMX service.

Host

Required

Hostname of the master server.

Master JMX Service URL

Required

JMX Service URL for connecting to the master server through JMX. Example:
service:jmx:rmi:///jndi/rmi://c7-hbase-1.bluemedora.localnet:10101/jmxrmi

Master JMX Port

Port on which the master server is accepting JMX connections.

HBase Mode

Run mode of the HBase instance.

Region Server JMX Port

Port on which the region servers are accepting JMX connections.

Username

Required

Password

Required

Collection Concurrency

Maximum number of Region Servers to request data from at once.

Metrics

Master

Name
Description

Active Handlers

Number of active RPC handlers.

Active Read Handlers

Number of active read RPC handlers.

Active Scan Handlers

Number of active scan RPC handlers.

Active Write Handlers

Number of active write RPC handlers.

Average Load

Average number of regions per region server.

CallQueueTooBig Exceptions (Errors)

Count of 'CallQueueTooBig' exceptions caused by requests. This exception is thrown when too many items are queued.

Calls in General Call Queue (Calls)

Number of calls in the general call queue.

Calls in Read Queue (Calls)

Number of calls in the read queue which are waiting to be executed.

Calls in Scan Queue (Calls)

Number of calls in the scan queue which are waiting to be executed.

Calls in Write Queue (Calls)

Number of calls in the write queue which are waiting to be executed.

Cluster ID

Identifier for the cluster.

Cluster Requests (Requests)

Count of requests made from all region servers to the cluster.

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.

Dead Region Servers

Number of dead region servers.

Exceptions (Errors)

Count of exceptions caused by requests.

FailedSanityCheck Exceptions (Errors)

Count of 'FailedSanityCheck' exceptions caused by requests. This exception is thrown when a mutation fails sanity checks.

Garbage Collector Collection Count

The total number of collections that have occurred.

Garbage Collector Collection Time (Milliseconds)

The accumulated collection elapsed time.

General Calls Dropped (Calls)

Count of calls from the general queue which were dropped by the Controlled Delay RPC executor.

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.

Hostname

Hostname of the region server.

LIFO Mode Switches

Count of calls from the general queue which were served from the tail of the queue.

Live Region Servers

Semicolon-separated list of the server names of all live region servers.

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.

MultiResponseTooLarge Exceptions (Errors)

Count of responses to multi requests that were too large. As a result, the remaining requests will need to be retried.

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.

NotServingRegion Exceptions (Errors)

Count of 'NotServingRegion' exceptions caused by requests. This exception is thrown when a mutation fails sanity checks.

Oldest Region in Transition (Milliseconds)

Age of the longest region in transition. Will be 0 if there are no regions in transition.

Open Connections (Connections)

Number of open connections.

Open Files

The number of open file descriptors.

OutOfOrderScannerNext Exceptions (Errors)

Count of 'OutOfOrderScannerNext' exceptions caused by requests. This exception is thrown when the 'nextCallSeq' calculated by both the client and server don't match.

Peak Threads (Threads)

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

Queue Size (Bytes)

Sum of size of calls currently queued.

Received Traffic (Bytes)

Count of traffic received.

RegionMoved Exceptions (Errors)

Count of 'RegionMoved' exceptions caused by requests. This exception is thrown when the the server knows that the region has moved to a different server.

Region Servers

Number of live region servers.

RegionTooBusy Exceptions (Errors)

Count of 'RegionTooBusy' exceptions caused by requests. This exception is thrown when a region server would have blocked and waited to serve a request.

Regions in Transition

Number of regions currently in transition.

Regions in Transition Longer Than Threshold

Number of regions currently in transition for longer than the threshold time.

ScannerReset Exceptions (Errors)

Count of 'ScannerReset' exceptions caused by requests. This exception is thrown when the server receives an exception and asks the client to reset the scanner state.

Sent Traffic (Bytes)

Count of traffic sent.

Server Name

Identifier for the master server within the context of its cluster, created from its hostname, port, and startcode.

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.

UnknownScanner Exceptions (Errors)

Count of 'UnknownScanner' exceptions caused by requests. This exception is thrown when the server receives an unknown scanner ID.

Uptime (Milliseconds)

The uptime of the Java virtual machine.

Vendor

The Java virtual machine specification vendor.

Zookeeper Quorum

Comma-separated list of the addresses of all registered Zookeeper servers.

Region

Name
Description

Appends

Count of Appends.

Average Store File Age (Milliseconds)

Average age of store files in the region.

Completed Compactions

Count of compactions completed in the region.

Data Compacted (Bytes)

Amount of data compacted.

Deletes

Count of Deletes.

Failed Compactions

Count of failed compactions in the region.

Files Compacted

Count of files compacted.

Gets

Count of Gets.

Increments

Count of Increments.

Last Major Compaction Age (Milliseconds)

Age of the last major compaction.

Maximum Compaction Queue Size

Maximum size of the compaction queue.

Maximum Flush Queue Size

Maximum size of the flush queue.

Maximum Store File Age (Milliseconds)

Age of the oldest store file in the region.

MemStore Size (Bytes)

Size of the MemStore.

Minimum Store File Age (Milliseconds)

Age of the newest store file in the region.

Name

Name of the region.

Namespace

Namespace of the table containing the region.

Puts

Count of Puts.

Queued Compactions

Number of queued and running compactions in the region.

Queued Flushes

Count of flushes queued.

Read Requests (Requests)

Count of read requests for the region.

Reference Files

Number of reference files in the region.

Replica ID

Replica ID of the region. A value of 0 indicates primary replica.

Scans

Count of Scans.

Store File Size (Bytes)

Size of store files in the region.

Store Files

Number of store files in the region.

Stores

Count of Stores.

Table

Name of the table containing the region.

Write Requests (Requests)

Count of write requests for the region.

Region Server

Name
Description

Active Handlers

Number of active RPC handlers.

Active Read Handlers

Number of active read RPC handlers.

Active Scan Handlers

Number of active scan RPC handlers.

Active Write Handlers

Number of active write RPC handlers.

Average Read Latency (Milliseconds)

Average latency of HFile reads on the server.

Average Region Size (Bytes)

Average size of regions on the Region Server, including MemStore and store files sizes.

Average Store File Age (Milliseconds)

Average age of store files on the Region Server.

Average Write Latency (Milliseconds)

Average latency of HFile writes on the server.

Block Cache Blocks (Blocks)

Number of blocks in the block cache.

Block Cache Bloom Chunk Hits

Count of block cache hits for bloom filter blocks.

Block Cache Bloom Chunk Misses

Count of block cache misses for bloom filter blocks.

Block Cache Data Hits

Count of block cache hits for data blocks.

Block Cache Data Misses

Count of block cache misses for data blocks.

Block Cache Delete Family Bloom Metadata Hits

Count of block cache hits for Delete Family Bloom filter metadata blocks.

Block Cache Delete Family Bloom Metadata Misses

Count of block cache misses for Delete Family Bloom filter metadata blocks.

Block Cache Evictions (Blocks)

Count of blocks evicted from the block cache.

Block Cache Express Hit Rate (%)

Ratio of requests with caching turned on that hit the cache.

Block Cache Failed Insertions

Count of failed block cache insertions.

Block Cache File Info Hits

Count of block cache hits for File Info blocks.

Block Cache File Info Misses

Count of block cache misses for File Info blocks.

Block Cache Free Space (Bytes)

Amount of data free in the block cache.

Block Cache General Bloom Metadata Hits

Count of block cache hits for General Bloom Metadata blocks.

Block Cache General Bloom Metadata Misses

Count of block cache misses for General Bloom Metadata blocks.

Block Cache Hit Rate (%)

Ratio of block cache requests which are hits.

Block Cache Hits

Count of block cache hits.

Block Cache Intermediate Index Hits

Count of block cache hits for Intermediate Index blocks.

Block Cache Intermediate Index Misses

Count of block cache hits for Intermediate Index blocks.

Block Cache Leaf Index Hits

Count of block cache hits for Leaf Index blocks.

Block Cache Leaf Index Misses

Count of block cache misses for Leaf Index blocks.

Block Cache Meta Hits

Count of block cache hits for Meta blocks.

Block Cache Meta Misses

Count of block cache misses for Meta blocks.

Block Cache Misses

Count of block cache misses.

Block Cache Primary Misses

Count of misses on the primary replica in the block cache.

Block Cache Primary Replica Evictions (Blocks)

Count of blocks evicted from the primary replica of the block cache.

Block Cache Primary Replica Hits

Count of hits on the primary replica in the block cache.

Block Cache Root Index Hits

Count of block cache hits for Root Index blocks.

Block Cache Root Index Misses

Count of block cache misses for Root Index blocks.

Block Cache Size (Bytes)

Memory in use by the block cache.

Block Cache Trailer Hits

Count of block cache hits for Trailer blocks.

Block Cache Trailer Misses

Count of block cache misses for Trailer blocks.

Blocked Requests (Requests)

Count of requests blocked due to MemStore size being larger than 'blockingMemStoreSize'.

CallQueueTooBig Exceptions (Errors)

Count of 'CallQueueTooBig' exceptions caused by requests. This exception is thrown when too many items are queued.

Calls in Read Queue (Calls)

Number of calls in the read queue which are waiting to be executed.

Calls in Scan Queue (Calls)

Number of calls in the scan queue which are waiting to be executed.

Calls in Write Queue (Calls)

Number of calls in the write queue which are waiting to be executed.

Checksum Failures

Count of checksum failures for HFile checksums. These checksums are separate from HDFS checksums.

Cluster ID

Identifier for the cluster.

Compaction Queue Length

Depth of the compaction queue.

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.

Enqueued User Requests (Calls)

Number of calls in the general call queue.

Exceptions (Errors)

Count of exceptions caused by requests.

Failed Check and Mutate Calls (Calls)

Count of failed Check and Mutate calls.

FailedSanityCheck Exceptions (Errors)

Count of 'FailedSanityCheck' exceptions caused by requests. This exception is thrown when a mutation fails sanity checks.

Flush Queue Length

Depth of the MemStore flush queue.

Garbage Collector Collection Count

The total number of collections that have occurred.

Garbage Collector Collection Time (Milliseconds)

The accumulated collection elapsed time.

General Calls Dropped (Calls)

Count of calls from the general queue which were dropped by the Controlled Delay RPC executor.

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.

Hostname

Hostname of the region server.

L1 Cache Hit Ratio

Ratio of L1 cache hits to L1 cache misses.

L1 Cache Hits

Count of L1 cache hits.

L1 Cache Miss Ratio

Ratio of L1 cache misses to L1 cache hits.

L1 Cache Misses

Count of L1 cache misses.

L2 Cache Hit Ratio

Ratio of L2 cache hits to L2 cache misses.

L2 Cache Hits

Count of L2 cache hits.

L2 Cache Miss Ratio

Ratio of L2 cache misses to L2 cache hits.

L2 Cache Misses

Count of L2 cache misses.

LIFO Mode Switches (Calls)

Count of calls from the general queue which were served from the tail of the queue.

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.

Local Files (%)

Ratio of store file data stored on the local DataNode.

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.

Maximum Read Latency (Milliseconds)

Maximum latency of HFile reads on the server.

Maximum Store File Age (Milliseconds)

Age of the oldest store file on the Region Server.

Maximum Write Latency (Milliseconds)

Maximum latency of HFile writes on the server.

Median Read Latency (Milliseconds)

Median latency of HFile reads on the server.

Median Write Latency (Milliseconds)

Median latency of HFile writes on the server.

MemStore Size (Bytes)

Size of the Region Server's MemStore.

Minimum Read Latency (Milliseconds)

Minimum latency of HFile reads on the server.

Minimum Store File Age (Milliseconds)

Age of the newest store file on the Region Server.

Minimum Write Latency (Milliseconds)

Minimum latency of HFile writes on the server.

MultiResponseTooLarge Exceptions (Errors)

Count of responses to multi requests that were too large. As a result, the remaining requests will need to be retried.

Mutations Without WAL

Number of mutations received from clients with WAL disabled.

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.

NotServingRegion Exceptions (Errors)

Count of 'NotServingRegion' exceptions caused by requests. This exception is thrown when a mutation fails sanity checks.

Open Connections (Connections)

Number of open connections.

Open Files

The number of open file descriptors.

OutOfOrderScannerNext Exceptions (Errors)

Count of 'OutOfOrderScannerNext' exceptions caused by requests. This exception is thrown when the 'nextCallSeq' calculated by both the client and server don't match.

Passed Check and Mutate Calls (Calls)

Count Check and Mutate calls which passed the checks.

Peak Threads (Threads)

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

Queue Size (Bytes)

Sum of size of calls currently queued.

Read Operations (Operations)

Count of HFile write operations.

Read Requests (Requests)

Count of read requests handled by the Region Server.

Received Traffic (Bytes)

Amount of data received.

Reference Files

Number of reference files on the Region Server.

RegionMoved Exceptions (Errors)

Count of 'RegionMoved' exceptions caused by requests. This exception is thrown when the the server knows that the region has moved to a different server.

RegionTooBusy Exceptions (Errors)

Count of 'RegionTooBusy' exceptions caused by requests. This exception is thrown when a region server would have blocked and waited to serve a request.

Regions

Number of regions hosted by the Region Server.

Requests (Requests)

Count of requests handled by the Region Server.

Row Action Requests

Count of row actions across requests handled by the Region Server.

RPC Get Requests (Requests)

Count of RPC get requests handled by the Region Server.

RPC Multi Requests (Requests)

Count of RPC multi requests handled by the Region Server.

RPC Mutate Requests (Requests)

Count of RPC mutation requests handled by the Region Server.

RPC Scan Requests (Requests)

Count of RPC scan requests handled by the Region Server.

ScannerReset Exceptions (Errors)

Count of 'ScannerReset' exceptions caused by requests. This exception is thrown when the server receives an exception and asks the client to reset the scanner state.

Sent Traffic (Bytes)

Amount of data sent.

Server Name

Identifier for the Region Server within the context of its cluster, created from its hostname, port, and startcode.

Size of Mutations Without WAL (Bytes)

Aggregate size of mutations received from clients with WAL disabled.

Slow Appends

Count of Appends that took over 1000ms to complete.

Slow Deletes

Count of Deletes that took over 1000ms to complete.

Slow Gets

Count of Gets that took over 1000ms to complete.

Slow Increments

Count of Increments that took over 1000ms to complete.

Slow Puts

Count of Puts that took over 1000ms to complete.

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.

Store File Size (Bytes)

Size of all store files on the Region Server's disk.

Store Files

Number of store files managed by the Region Server.

Stores

Number of stores hosted by the Region Server.

UnknownScanner Exceptions (Errors)

Count of 'OutOfOrderScannerNext' exceptions caused by requests. This exception is thrown when the server receives an unknown scanner ID.

Update Blocking Duration (Milliseconds)

Count of how long updates have been blocked so that the MemStore can be flushed.

Uptime (Milliseconds)

The uptime of the Java virtual machine.

Vendor

The Java virtual machine specification vendor.

WAL File Size (Bytes)

Size of all WAL files on the Region Server.

WAL Files

Number of WAL files.

Write Operations (Operations)

Count of HFile write operations.

Write Requests (Requests)

Count of write requests handled by the Region Server.

Table

Name
Description

MemStore Size (Bytes)

Size of the MemStores.

Name

Name of the table.

Namespace

Namespace containing the table.

Read Requests (Requests)

Read requests for the table.

Requests (Requests)

Requests for the table.

Size (Bytes)

Size of the table in the Region Server.

Store Files Size (Bytes)

Size of the store files.

Write Requests (Requests)

Write requests for the table.

Apache HBase


Monitor Apache's Distributed, Non-relational Database

Suggested Edits are limited on API Reference Pages

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