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!

All Metrics

Metrics

Master

NameDescription
Active HandlersNumber of active RPC handlers.
Active Read HandlersNumber of active read RPC handlers.
Active Scan HandlersNumber of active scan RPC handlers.
Active Write HandlersNumber of active write RPC handlers.
Average LoadAverage 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 IDIdentifier 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 ServersNumber 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 CountThe 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.
HostnameHostname of the region server.
LIFO Mode SwitchesCount of calls from the general queue which were served from the tail of the queue.
Live Region ServersSemicolon-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 CountThe 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 FilesThe 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 ServersNumber 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 TransitionNumber of regions currently in transition.
Regions in Transition Longer Than ThresholdNumber 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 NameIdentifier for the master server within the context of its cluster, created from its hostname, port, and startcode.
Specification VersionThe 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.
VendorThe Java virtual machine specification vendor.
Zookeeper QuorumComma-separated list of the addresses of all registered Zookeeper servers.

Region

NameDescription
AppendsCount of Appends.
Average Store File Age (Milliseconds)Average age of store files in the region.
Completed CompactionsCount of compactions completed in the region.
Data Compacted (Bytes)Amount of data compacted.
DeletesCount of Deletes.
Failed CompactionsCount of failed compactions in the region.
Files CompactedCount of files compacted.
GetsCount of Gets.
IncrementsCount of Increments.
Last Major Compaction Age (Milliseconds)Age of the last major compaction.
Maximum Compaction Queue SizeMaximum size of the compaction queue.
Maximum Flush Queue SizeMaximum 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.
NameName of the region.
NamespaceNamespace of the table containing the region.
PutsCount of Puts.
Queued CompactionsNumber of queued and running compactions in the region.
Queued FlushesCount of flushes queued.
Read Requests (Requests)Count of read requests for the region.
Reference FilesNumber of reference files in the region.
Replica IDReplica ID of the region. A value of 0 indicates primary replica.
ScansCount of Scans.
Store File Size (Bytes)Size of store files in the region.
Store FilesNumber of store files in the region.
StoresCount of Stores.
TableName of the table containing the region.
Write Requests (Requests)Count of write requests for the region.

Region Server

NameDescription
Active HandlersNumber of active RPC handlers.
Active Read HandlersNumber of active read RPC handlers.
Active Scan HandlersNumber of active scan RPC handlers.
Active Write HandlersNumber 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 HitsCount of block cache hits for bloom filter blocks.
Block Cache Bloom Chunk MissesCount of block cache misses for bloom filter blocks.
Block Cache Data HitsCount of block cache hits for data blocks.
Block Cache Data MissesCount of block cache misses for data blocks.
Block Cache Delete Family Bloom Metadata HitsCount of block cache hits for Delete Family Bloom filter metadata blocks.
Block Cache Delete Family Bloom Metadata MissesCount 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 InsertionsCount of failed block cache insertions.
Block Cache File Info HitsCount of block cache hits for File Info blocks.
Block Cache File Info MissesCount 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 HitsCount of block cache hits for General Bloom Metadata blocks.
Block Cache General Bloom Metadata MissesCount of block cache misses for General Bloom Metadata blocks.
Block Cache Hit Rate (%)Ratio of block cache requests which are hits.
Block Cache HitsCount of block cache hits.
Block Cache Intermediate Index HitsCount of block cache hits for Intermediate Index blocks.
Block Cache Intermediate Index MissesCount of block cache hits for Intermediate Index blocks.
Block Cache Leaf Index HitsCount of block cache hits for Leaf Index blocks.
Block Cache Leaf Index MissesCount of block cache misses for Leaf Index blocks.
Block Cache Meta HitsCount of block cache hits for Meta blocks.
Block Cache Meta MissesCount of block cache misses for Meta blocks.
Block Cache MissesCount of block cache misses.
Block Cache Primary MissesCount 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 HitsCount of hits on the primary replica in the block cache.
Block Cache Root Index HitsCount of block cache hits for Root Index blocks.
Block Cache Root Index MissesCount of block cache misses for Root Index blocks.
Block Cache Size (Bytes)Memory in use by the block cache.
Block Cache Trailer HitsCount of block cache hits for Trailer blocks.
Block Cache Trailer MissesCount 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 FailuresCount of checksum failures for HFile checksums. These checksums are separate from HDFS checksums.
Cluster IDIdentifier for the cluster.
Compaction Queue LengthDepth 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 LengthDepth of the MemStore flush queue.
Garbage Collector Collection CountThe 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.
HostnameHostname of the region server.
L1 Cache Hit RatioRatio of L1 cache hits to L1 cache misses.
L1 Cache HitsCount of L1 cache hits.
L1 Cache Miss RatioRatio of L1 cache misses to L1 cache hits.
L1 Cache MissesCount of L1 cache misses.
L2 Cache Hit RatioRatio of L2 cache hits to L2 cache misses.
L2 Cache HitsCount of L2 cache hits.
L2 Cache Miss RatioRatio of L2 cache misses to L2 cache hits.
L2 Cache MissesCount 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 CountThe 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 WALNumber 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 FilesThe 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 FilesNumber 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.
RegionsNumber of regions hosted by the Region Server.
Requests (Requests)Count of requests handled by the Region Server.
Row Action RequestsCount 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 NameIdentifier 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 AppendsCount of Appends that took over 1000ms to complete.
Slow DeletesCount of Deletes that took over 1000ms to complete.
Slow GetsCount of Gets that took over 1000ms to complete.
Slow IncrementsCount of Increments that took over 1000ms to complete.
Slow PutsCount of Puts that took over 1000ms to complete.
Specification VersionThe 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 FilesNumber of store files managed by the Region Server.
StoresNumber 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.
VendorThe Java virtual machine specification vendor.
WAL File Size (Bytes)Size of all WAL files on the Region Server.
WAL FilesNumber of WAL files.
Write Operations (Operations)Count of HFile write operations.
Write Requests (Requests)Count of write requests handled by the Region Server.

Table

NameDescription
MemStore Size (Bytes)Size of the MemStores.
NameName of the table.
NamespaceNamespace 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.

Updated 6 months ago

All Metrics


Suggested Edits are limited on API Reference Pages

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