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.

Username

The username for authenticating to the Elasticsearch Node.

Password

The password for the given user.

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.

Nodes

The number of nodes in the cluster

Relocating Shards

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

Successful Nodes

The number of nodes successfully created in the cluster.

Unassigned Shards

The number of shards that are unassigned to a node.

Index

Name
Description

Shards

The number of shards in the index

Node

Name
Description

Active Merges

The number of currently active segment merges.

Active Searches

The number of search fetches

Active Threads

The number of active threads in the JVM

Cache Evictions

The number of cache evictions

Cache Hits

The number of cache hits

Cache Misses

The number of cache misses

Circuit Breaker Estimated Size

The estimated size of the circuit breaker.

Circuit Breaker Tripped

The number of times the circuit breaker has tripped.

CPU Utilization

The node's CPU utilization

Current Requests Running

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

Delete Operations

The number of documents delete operations from an index.

Deleting Time

The time spent deleting documents from an index.

Disk Size Available

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

Disk Size Free

The amount of unallocated data in the file store.

Disk I/O Operations

The number of operations on the file store.

Disk I/O Size

The amount of data read/written from/to the file store.

Disk Size

The size of the file store.

Document Segment Merges

The number of documents across all merged segments.

Document Segments Merging

The number of documents across segments currently being merged.

Documents

The number of documents in the index or aggregation.

Documents Currently Deleting

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 number of documents indexed to an index.

Failed Index Operations

The number of failed indexing operations.

Garbage Collection Count

The count of garbage collections in the JVM.

Garbage Collection Time

The time spent in garbage collections in the JVM.

GET Requests

The number of get requests.

Indexing Throttle Time

The time indexing waited due to throttling.

Indexing Time

The time spent indexing documents to an index.

Cache Memory Size

The memory used by the cache.

Heap Memory Committed

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

Heap Memory Used

The amount of memory currently used by the JVM heap.

Heap Memory Utilization

The amount of memory utilization by the JVM heap.

Non-heap Memory Committed

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

Non-heap Memory Used

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

Memory Used

The amount of memory used on the node.

Memory Utilization

The node's memory utilization.

Merge Time

The time spent on segment merging.

Cluster Open Connections

The number of connections opened for cluster communication.

Data I/O

The amount of data transmitted in cluster communication.

Open HTTP Connections

The number of current open HTTP connections.

Opened HTTP Connections

The number of opened HTTP connections.

Packets

The number of packets in cluster communication.

Open File Descriptors

Number of opened file descriptors associated with the current process

Peak Threads

The peak number of threads used by the JVM.

Queries

The number of queries.

Refresh Time

The time spent on index refreshes.

Refreshes

The number of index refreshes.

Search Fetches

The number of search fetches.

Search Fetches Running

The number of currently active queries.

Segment Merges

The number of segment merges.

Segments Merged Size

The size of all merged segments.

Segments Merging Size

The size of the segments currently being merged.

Store Size

The store size of the index or aggregation.

Transaction Log Operations

The number of operations in the transaction log.

Transaction Log Operations Size

The size of the transaction log.

Primary Shards

Name
Description

Cache Evictions

The number of cache evictions.

Cache Hits

The number of cache hits.

Cache Misses

The number of cache misses.

Current Document Merges

The number of documents across segments currently being merged.

Current Merge Operations

The number of currently active segment merges.

Current Merge Operations Size

The size of the segments currently being merged.

Current Operations

Number of current operations.

Documents

The number of documents in the index or aggregation.

Documents Deleted

The number of deleted documents in the index or aggregation.

Failed Index Operations

The number of failed indexing operations.

Flush Time

The time spent in flush.

Flushes

The number of flushes.

Indexing Throttle Time

The time indexing waited due to throttling.

Cache Memory Size

The memory used by the cache.

Segments Memory

Memory used by segments.

Total Segments Memory Size

Memory used by segments.

Operations

Number of operations completed.

Operations Time

Time spent during operations.

Refreshes

The number of index refreshes.

Refresh Time

The time spent on index refreshes.

Segments

The number of segments.

Store Size

The store size of the index or aggregation.

Total Document Merges

The total number of documents across all merged segments.

Total Merge Operations

The total number of segment merges.

Total Merge Operations Size

The total size of all merged segments.

Total Merge Operations Time

The total time spent on segment merging.

Transaction Log Operations

The number of operations in the transaction log.

Transaction Log Operations Size

The size of the transaction log.

Transaction Log Uncommitted Operations

The number of operations not committed to the transaction log.

Transaction Log Uncommitted Operations Size

The size of the operations not committed transaction log.

Thread Pool

Name
Description

Active

How many threads are actively processing some work.

Completed

The number of tasks completed.

Queue

The number of tasks in the queue.

Rejected

The number of tasks rejected by the thread pool executor.

Total Shards

Name
Description

Cache Evictions

The number of cache evictions.

Cache Hits

The number of cache hits.

Cache Misses

The number of cache misses.

Current Document Merges

The number of documents across segments currently being merged.

Current Merge Operations

The number of currently active segment merges.

Current Merge Operations Size

The size of the segments currently being merged.

Current Operations

Number of current operations.

Documents

The number of documents in the index or aggregation.

Documents Deleted

The number of deleted documents in the index or aggregation.

Failed Index Operations

The number of failed indexing operations.

Flush Time

The time spent in flush.

Flushes

The number of flushes.

Indexing Throttle Time

The time indexing waited due to throttling.

Cache Memory Size

The memory used by the cache.

Segments Memory

Memory used by segments.

Total Segments Memory Size

Memory used by segments.

Operations

Number of operations completed.

Operations Time

Time spent during operations.

Refreshes

The number of index refreshes.

Refresh Time

The time spent on index refreshes.

Segments

The number of segments.

Store Size

The store size of the index or aggregation.

Total Document Merges

The total number of documents across all merged segments.

Total Merge Operations

The total number of segment merges.

Total Merge Operations Size

The total size of all merged segments.

Total Merge Operations Time

The total time spent on segment merging.

Transaction Log Operations

The number of operations in the transaction log.

Transaction Log Operations Size

The size of the transaction log.

Transaction Log Uncommitted Operations

The number of operations not committed to the transaction log.

Transaction Log Uncommitted Operations Size

The size of the operations not committed 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.