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

Cluster

NameDescription
Active Primary ShardsThe number of active primary shards in the cluster.
Active ShardsThe number of active shards in the cluster.
Data NodesThe number of data nodes in the cluster.
Failed NodesThe number of nodes that failed to be created in the cluster.
Initializing ShardsThe number of shards that are currently initializing.
NodesThe number of nodes in the cluster
Relocating ShardsThe number of shards that are relocating from one node to another.
Successful NodesThe number of nodes successfully created in the cluster.
Unassigned ShardsThe number of shards that are unassigned to a node.

Index

NameDescription
ShardsThe number of shards in the index

Node

NameDescription
Active MergesThe number of currently active segment merges.
Active SearchesThe number of search fetches
Active ThreadsThe number of active threads in the JVM
Cache EvictionsThe number of cache evictions
Cache HitsThe number of cache hits
Cache MissesThe number of cache misses
Circuit Breaker Estimated SizeThe estimated size of the circuit breaker.
Circuit Breaker TrippedThe number of times the circuit breaker has tripped.
CPU UtilizationThe node's CPU utilization
Current Requests RunningThe number of get requests currently running on the index or aggregation.
Delete OperationsThe number of documents delete operations from an index.
Deleting TimeThe time spent deleting documents from an index.
Disk Size AvailableThe amount of data available to this Java virtual machine on this file store.
Disk Size FreeThe amount of unallocated data in the file store.
Disk I/O OperationsThe number of operations on the file store.
Disk I/O SizeThe amount of data read/written from/to the file store.
Disk SizeThe size of the file store.
Document Segment MergesThe number of documents across all merged segments.
Document Segments MergingThe number of documents across segments currently being merged.
DocumentsThe number of documents in the index or aggregation.
Documents Currently DeletingThe number of documents currently being deleted from an index.
Documents Currently IndexingThe number of documents currently being indexed to an index.
Documents DeletedThe number of deleted documents in the index or aggregation.
Documents IndexedThe number of documents indexed to an index.
Failed Index OperationsThe number of failed indexing operations.
Garbage Collection CountThe count of garbage collections in the JVM.
Garbage Collection TimeThe time spent in garbage collections in the JVM.
GET RequestsThe number of get requests.
Indexing Throttle TimeThe time indexing waited due to throttling.
Indexing TimeThe time spent indexing documents to an index.
Cache Memory SizeThe memory used by the cache.
Heap Memory CommittedThe amount of memory guaranteed to be available to the JVM heap.
Heap Memory UsedThe amount of memory currently used by the JVM heap.
Heap Memory UtilizationThe amount of memory utilization by the JVM heap.
Non-heap Memory CommittedThe amount of memory guaranteed to be available to JVM non-heap.
Non-heap Memory UsedThe amount of memory currently used by the JVM non-heap.
Memory UsedThe amount of memory used on the node.
Memory UtilizationThe node's memory utilization.
Merge TimeThe time spent on segment merging.
Cluster Open ConnectionsThe number of connections opened for cluster communication.
Data I/OThe amount of data transmitted in cluster communication.
Open HTTP ConnectionsThe number of current open HTTP connections.
Opened HTTP ConnectionsThe number of opened HTTP connections.
PacketsThe number of packets in cluster communication.
Open File DescriptorsNumber of opened file descriptors associated with the current process
Peak ThreadsThe peak number of threads used by the JVM.
QueriesThe number of queries.
Refresh TimeThe time spent on index refreshes.
RefreshesThe number of index refreshes.
Search FetchesThe number of search fetches.
Search Fetches RunningThe number of currently active queries.
Segment MergesThe number of segment merges.
Segments Merged SizeThe size of all merged segments.
Segments Merging SizeThe size of the segments currently being merged.
Store SizeThe store size of the index or aggregation.
Transaction Log OperationsThe number of operations in the transaction log.
Transaction Log Operations SizeThe size of the transaction log.

Primary Shards

NameDescription
Cache EvictionsThe number of cache evictions.
Cache HitsThe number of cache hits.
Cache MissesThe number of cache misses.
Current Document MergesThe number of documents across segments currently being merged.
Current Merge OperationsThe number of currently active segment merges.
Current Merge Operations SizeThe size of the segments currently being merged.
Current OperationsNumber of current operations.
DocumentsThe number of documents in the index or aggregation.
Documents DeletedThe number of deleted documents in the index or aggregation.
Failed Index OperationsThe number of failed indexing operations.
Flush TimeThe time spent in flush.
FlushesThe number of flushes.
Indexing Throttle TimeThe time indexing waited due to throttling.
Cache Memory SizeThe memory used by the cache.
Segments MemoryMemory used by segments.
Total Segments Memory SizeMemory used by segments.
OperationsNumber of operations completed.
Operations TimeTime spent during operations.
RefreshesThe number of index refreshes.
Refresh TimeThe time spent on index refreshes.
SegmentsThe number of segments.
Store SizeThe store size of the index or aggregation.
Total Document MergesThe total number of documents across all merged segments.
Total Merge OperationsThe total number of segment merges.
Total Merge Operations SizeThe total size of all merged segments.
Total Merge Operations TimeThe total time spent on segment merging.
Transaction Log OperationsThe number of operations in the transaction log.
Transaction Log Operations SizeThe size of the transaction log.
Transaction Log Uncommitted OperationsThe number of operations not committed to the transaction log.
Transaction Log Uncommitted Operations SizeThe size of the operations not committed transaction log.

Thread Pool

NameDescription
ActiveHow many threads are actively processing some work.
CompletedThe number of tasks completed.
QueueThe number of tasks in the queue.
RejectedThe number of tasks rejected by the thread pool executor.

Total Shards

NameDescription
Cache EvictionsThe number of cache evictions.
Cache HitsThe number of cache hits.
Cache MissesThe number of cache misses.
Current Document MergesThe number of documents across segments currently being merged.
Current Merge OperationsThe number of currently active segment merges.
Current Merge Operations Size The size of the segments currently being merged.
Current OperationsNumber of current operations.
DocumentsThe number of documents in the index or aggregation.
Documents DeletedThe number of deleted documents in the index or aggregation.
Failed Index OperationsThe number of failed indexing operations.
Flush TimeThe time spent in flush.
FlushesThe number of flushes.
Indexing Throttle TimeThe time indexing waited due to throttling.
Cache Memory SizeThe memory used by the cache.
Segments MemoryMemory used by segments.
Total Segments Memory SizeMemory used by segments.
OperationsNumber of operations completed.
Operations TimeTime spent during operations.
RefreshesThe number of index refreshes.
Refresh TimeThe time spent on index refreshes.
SegmentsThe number of segments.
Store SizeThe store size of the index or aggregation.
Total Document MergesThe total number of documents across all merged segments.
Total Merge OperationsThe total number of segment merges.
Total Merge Operations SizeThe total size of all merged segments.
Total Merge Operations TimeThe total time spent on segment merging.
Transaction Log OperationsThe number of operations in the transaction log.
Transaction Log Operations SizeThe size of the transaction log.
Transaction Log Uncommitted OperationsThe number of operations not committed to the transaction log.
Transaction Log Uncommitted Operations SizeThe size of the operations not committed transaction log.

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.