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!

Elasticsearch

Monitor the RESTFul Search Engine and Analytics Engine

Data Collection Setup

External Network Access needs to be setup for the RESTful API Port. Depending on your deployment, this API maybe set for local access only. For Further information see:
https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-network.html

Enabling External Network Access

In the /etc/elasticsearch/elasticsearch.yml set the network.host: to _site_

network.host: _site_

Network Requirements

Port: 9200 (TCP) Default Port
This is configurable for 9200-9300

Least Privilege User

By default Elasticsearch does not have Authentication supported. When using X-Pack use the elastic user security principle.

Supported Versions

Elasticsearch Versions: 5.x, 6.x, 7.x

Connection Parameters

Name
Required?
Description

Host

Required

The Elasticsearch Node to connect to.

Port

The port for communication to Elasticsearch. Default is: 9200

Username

The username for authenticating to the Elasticsearch Node.

Do not fill in, unless Authentication is enabled

Password

The password for the given user.

Do not fill in, unless Authentication is enabled

SSL Configuration

The SSL mode to use when connecting to the target. Can be configured to not use SSL (No SSL), use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).

Connection Timeout

The timeout in seconds for an API call.

Metrics

Cluster

Name
Description

Active Primary Shards

The number of active primary shards in the cluster.

Active Shards

The number of active shards in the cluster.

Data Nodes

The number of data nodes in the cluster.

Failed Nodes

The number of nodes that failed to be created in the cluster.

Initializing Shards

The number of shards that are currently initializing.

Name

The name of the cluster.

Relocating Shards

The number of shards that are relocating from one node to another.

Status

The Elasticsearch cluster health as a number: red = 0, yellow = 1, green = 2.

Successful Nodes

The number of nodes successfully created in the cluster.

Total Nodes

The total number of nodes in the cluster.

Unassigned Shards

The number of shards that are unassigned to a node.

UUID

The UUID given to the cluster.

Version

The version of Elasticsearch installed on the cluster.

Index

Name
Description

Health

The status of the index.

Name

The name of the index.

Primary Shards

The number of primary shards in the index.

Replica Shards

The number of replica shards in the index.

Status

Whether the index is open or closed.

UUID

The UUID given to the index.

Node

Name
Description

Active Merges

The number of currently active segment merges.

Active Searches

The total number of search fetches.

Active Threads

The number of active threads in the JVM.

API Port

The node's API port.

Cluster Open Connections (Connections)

The number of connections opened for cluster communication.

CPU Utilization (%)

The node's CPU utilization.

Current Requests Running

The number of get requests currently running on the index or aggregation.

Data Received (Bytes)

The total size of data received in cluster communication.

Data Sent (Bytes)

The total size of data sent in cluster communication.

Deleting Time (Milliseconds)

The total time spent deleting documents from an index.

Document Segments Merging

The number of documents across segments currently being merged.

Documents

The number of documents in the index or aggregation.

Documents Currently Deleted

The number of documents currently being deleted from an index.

Documents Currently Indexing

The number of documents currently being indexed to an index.

Documents Deleted

The number of deleted documents in the index or aggregation.

Documents Indexed

The total number of documents indexed to an index.

Failed Index Operations

The number of failed indexing operations.

Field Data Circuit Breaker Estimated Size (Bytes)

The estimated size of the field data circuit breaker.

Field Data Circuit Breaker Overhead

The constant multiplier for byte estimations of the field data circuit breaker.

Field Data Circuit Breaker Tripped

The number of times the field data circuit breaker has tripped.

Heap Memory Committed (Bytes)

The amount of memory guaranteed to be available to the JVM heap.

Heap Memory Used (Bytes)

The amount of memory currently used by the JVM heap.

Heap Memory Utilization (%)

The amount of memory utilization by the JVM heap.

Host

The host of the node.

In-flight Requests Circuit Breaker Estimated Size (Bytes)

The estimated size of the in-flight requests circuit breaker.

In-flight Requests Circuit Breaker Overhead

The constant multiplier for byte estimations of the in-flight requests circuit breaker.

In-flight Requests Circuit Breaker Tripped

The number of times the in-flight requests circuit breaker has tripped.

Indexing Throttle Time (Milliseconds)

The total time indexing waited due to throttling.

Indexing Time (Milliseconds)

The total time spent indexing documents to an index.

IP Address

The node's IP address.

Maximum Heap Memory (Bytes)

The maximum amount of heap memory configured for the JVM on the node.

Memory Used (Bytes)

The amount of memory used on the node.

Memory Utilization (%)

The node's memory utilization.

Name

The name given to the node.

Non-heap Memory Committed (Bytes)

The amount of memory guaranteed to be available to JVM non-heap.

Non-heap Memory Used (Bytes)

The amount of memory currently used by the JVM non-heap.

Old Garbage Collection Count

The total count of major GCs in the JVM that collect old generation objects.

Old Garbage Collection Time (Milliseconds)

The total time spent in major GCs in the JVM that collect old generation objects.

Open File Descriptors

Number of opened file descriptors associated with the current process, or -1 if not supported.

Open HTTP Connections (Connections)

The number of current open HTTP connections.

Packets Received (Packets)

The total number of packets received in cluster communication.

Packets Sent (Packets)

The total number of packets sent in cluster communication.

Parent Circuit Breaker Estimated Size (Bytes)

The estimated size of the parent circuit breaker.

Parent Circuit Breaker Overhead

The constant multiplier for byte estimations of the parent circuit breaker.

Parent Circuit Breaker Tripped

The number of times the parent circuit breaker has tripped.

Peak Threads

The peak number of threads used by the JVM.

Query Cache Evictions

The number of query cache evictions.

Query Cache Hits

The number of query cache hits.

Query Cache Memory Size (Bytes)

The memory used by the query cache.

Query Cache Misses

The number of query cache misses.

Request Cache Evictions

The number of request cache evictions.

Request Cache Hits

The number of request cache hits.

Request Cache Memory Size (Bytes)

The memory used by the request cache.

Request Cache Misses

The number of request cache misses.

Request Circuit Breaker Estimated Size (Bytes)

The estimated size of the request circuit breaker.

Request Circuit Breaker Overhead

The constant multiplier for byte estimations of the request circuit breaker.

Request Circuit Breaker Tripped

The number of times the request circuit breaker has tripped.

Search Fetches Running

The number of currently active queries.

Segments Merging Size (Bytes)

The size of the segments currently being merged.

Store Size (Bytes)

The store size of the index or aggregation.

Total Disk I/O Operations

The total I/O operations on the file store.

Total Disk I/O Read Size (Kilobytes)

The total amount of data read from the file store.

Total Disk I/O Reads

The total number of reads from the file store.

Total Disk I/O Write Size (Kilobytes)

The total number of writes to the file store.

Total Disk I/O Writes

The total amount of data written to the file store.

Total Disk Size (Bytes)

The total size of the file store.

Total Disk Size Available (Bytes)

The total amount of data available to this Java virtual machine on this file store.

Total Disk Size Free (Bytes)

The total amount of unallocated data in the file store.

Total Document Segment Merges

The total number of documents across all merged segments.

Total Documents Deleted

The total number of documents deleted from an index.

Total GET Requests

The total number of get requests.

Total Memory (Bytes)

The total amount of memory on the node.

Total Merge Time (Milliseconds)

The total time spent on segment merging.

Total Opened HTTP Connections (Connections)

The total number of opened HTTP connections.

Total Queries

The total number of queries.

Total Refresh Time (Milliseconds)

The total time spent on index refreshes.

Total Refreshes

The total number of index refreshes.

Total Search Fetches

The total number of search fetches.

Total Segment Merges

The total number of segment merges.

Total Segments Merged Size (Bytes)

The total size of all merged segments.

Transaction Log Operations

The number of operations in the transaction log.

Transaction Log Operations Size (Bytes)

The size of the transaction log.

UUID

UUID assigned to the node.

Young Garbage Collection Count

The total count of minor GCs in the JVM that collects young generation objects.

Young Garbage Collection Time (Milliseconds)

The total time spent in minor GCs in the JVM that collects young generation objects.

Primary Shards

Name
Description

Active Merges

The number of currently active segment merges.

Active Searches

The total number of search fetches.

Current Requests Running

The number of get requests currently running on the index or aggregation.

Deleting Time (Milliseconds)

The total time spent deleting documents from an index.

Document Segments Merging

The number of documents across segments currently being merged.

Documents

The number of documents in the index or aggregation.

Documents Currently Deleted

The number of documents currently being deleted from an index.

Documents Currently Indexing

The number of documents currently being indexed to an index.

Documents Deleted

The number of deleted documents in the index or aggregation.

Documents Indexed

The total number of documents indexed to an index.

Failed Index Operations

The number of failed indexing operations.

Indexing Throttle Time (Milliseconds)

The total time indexing waited due to throttling.

Indexing Time (Milliseconds)

The total time spent indexing documents to an index.

Parent UUID

The UUID of the parent resource.

Query Cache Evictions

The number of query cache evictions.

Query Cache Hits

The number of query cache hits.

Query Cache Memory Size (Bytes)

The memory used by the query cache.

Query Cache Misses

The number of query cache misses.

Request Cache Evictions

The number of request cache evictions.

Request Cache Hits

The number of request cache hits.

Request Cache Memory Size (Bytes)

The memory used by the request cache.

Request Cache Misses

The number of request cache misses.

Search Fetches Running

The number of currently active queries.

Segments Merging Size (Bytes)

The size of the segments currently being merged.

Store Size (Bytes)

The store size of the index or aggregation.

Total Document Segment Merges

The total number of documents across all merged segments.

Total Documents Deleted

The total number of documents deleted from an index.

Total GET Requests

The total number of get requests.

Total Merge Time (Milliseconds)

The total time spent on segment merging.

Total Queries

The total number of queries.

Total Refresh Time (Milliseconds)

The total time spent on index refreshes.

Total Refreshes

The total number of index refreshes.

Total Search Fetches

The total number of search fetches.

Total Segment Merges

The total number of segment merges.

Total Segments Merged Size (Bytes)

The total size of all merged segments.

Transaction Log Operations

The number of operations in the transaction log.

Transaction Log Operations Size (Bytes)

The size of the transaction log.

Thread Pool

Name
Description

Active (Threads)

How many threads are actively processing some work.

Completed

The number of tasks completed.

Node Name

The name of the node.

Parent UUID

The UUID of the node.

Queue

The number of tasks in the queue.

Rejected

The number of tasks rejected by the thread pool executor.

Total (Threads)

The number of threads that are configured.

Type

The type of thread pool.

Total Shards

Name
Description

Active Merges

The number of currently active segment merges.

Active Searches

The total number of search fetches.

Current Requests Running

The number of get requests currently running on the index or aggregation.

Deleting Time (Milliseconds)

The total time spent deleting documents from an index.

Document Segments Merging

The number of documents across segments currently being merged.

Documents

The number of documents in the index or aggregation.

Documents Currently Deleted

The number of documents currently being deleted from an index.

Documents Currently Indexing

The number of documents currently being indexed to an index.

Documents Deleted

The number of deleted documents in the index or aggregation.

Documents Indexed

The total number of documents indexed to an index.

Failed Index Operations

The number of failed indexing operations.

Indexing Throttle Time (Milliseconds)

The total time indexing waited due to throttling.

Indexing Time (Milliseconds)

The total time spent indexing documents to an index.

Parent UUID

The UUID of the parent resource.

Query Cache Evictions

The number of query cache evictions.

Query Cache Hits

The number of query cache hits.

Query Cache Memory Size (Bytes)

The memory used by the query cache.

Query Cache Misses

The number of query cache misses.

Request Cache Evictions

The number of request cache evictions.

Request Cache Hits

The number of request cache hits.

Request Cache Memory Size (Bytes)

The memory used by the request cache.

Request Cache Misses

The number of request cache misses.

Search Fetches Running

The number of currently active queries.

Segments Merging Size (Bytes)

The size of the segments currently being merged.

Store Size (Bytes)

The store size of the index or aggregation.

Total Document Segment Merges

The total number of documents across all merged segments.

Total Documents Deleted

The total number of documents deleted from an index.

Total GET Requests

The total number of get requests.

Total Merge Time (Milliseconds)

The total time spent on segment merging.

Total Queries

The total number of queries.

Total Refresh Time (Milliseconds)

The total time spent on index refreshes.

Total Refreshes

The total number of index refreshes.

Total Search Fetches

The total number of search fetches.

Total Segment Merges

The total number of segment merges.

Total Segments Merged Size (Bytes)

The total size of all merged segments.

Transaction Log Operations

The number of operations in the transaction log.

Transaction Log Operations Size (Bytes)

The size of the transaction log.

Elasticsearch


Monitor the RESTFul Search Engine and Analytics Engine

Suggested Edits are limited on API Reference Pages

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