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!

Stackdriver Agent Migration

Several 3rd-party plugins were deprecated and BindPlane will now be the tool used to collect metrics from these technologies.

The metrics listed below are only those that were taken over from the deprecation. For a full list of metrics that BindPlane will send to Stackdriver, please click here.

Key
Metric Type
Display Name
Kind, Type, Unit Description
Labels
Additions

🚧

Metric prefixes

If the BindPlane collector is installed on the Elasticsearch host system, all the following metrics listed below will be prefixed with agent.googleapis.com/elasticsearch. Otherwise, these metrics will be prefixed with external.googleapis.com/bluemedora/generic_node/elasticsearch.

Stackdriver Metrics
/cache_memory_usage
Cache size
GAUGE, DOUBLE, BySize in bytes of the caches.
cache_name: Type of cache (field, query, request).
server_name: The elasticsearch server name.
Additionscache_name: In addition to 'field' and 'filter', BindPlane integration collects and reports 'query' and 'request' caches.
BindPlane integration collects and reports the node's instance name for server_name.
/field_eviction_count
Field evictions
CUMULATIVE, INT64, n/aEvictions from field cache.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/filter_cache_eviction_count
Filter evictions
CUMULATIVE, INT64, n/aEvictions from filter cache.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/gc_collection_count
GC count
CUMULATIVE, INT64, n/aGarbage collection count.
type: Type of garbage collection (young, old).
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/memory_usage
Memory usage
GAUGE, DOUBLE, BySize in bytes of memory.
memory_type: The memory type.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/network
Network traffic
CUMULATIVE, INT64, ByNumber of bytes transmitted and received on the network.
direction: Direction of traffic (rx, tx).
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/num_current_documents
Documents
GAUGE, DOUBLE, n/aNumber of documents in the indexes on this node.
server_name: The elasticsearch server name.
document_type: Document count type.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/num_data_nodes
Data nodes
GAUGE, DOUBLE, n/aNumber of data nodes in the cluster.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/num_http_connections
Open connections
GAUGE, DOUBLE, ConnectionsNumber of open HTTP connections to this node.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/num_nodes
Nodes
GAUGE, DOUBLE, n/aNumber of nodes in the cluster.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/num_open_files
Open files
GAUGE, DOUBLE, n/aNumber of open file descriptors held by the server process.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/num_server_connections
Open connections
GAUGE, DOUBLE, ConnectionsNumber of open network connections to the server.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/num_shards
Shards
GAUGE, DOUBLE, n/aNumber of shards.
shard_type: Type of shard (active, active_primary, initializing, relocating, unassigned).
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
BindPlane integration collects and reports the node's instance name for server_name.
/operation_count
Completed operations
CUMULATIVE, INT64, OperationsNumber of operations completed.
operation: Type of operation
server_name: The elasticsearch server name.
Additionsoperation: in addition to 'delete', 'exists', 'fetch', 'get', 'index', 'missing', and 'query', the BindPlane integration collects and reports 'scroll' and 'suggest' operations.
BindPlane integration collects and reports the node's instance name for server_name.
/operation_time
Operation time
CUMULATIVE, INT64, msTime in ms spent on operations.
operation: Type of operation
server_name: The elasticsearch server name.
Additionsoperation: in addition to 'delete', 'exists', 'fetch', 'get', 'index', 'missing', and 'query', the BindPlane integration collects and reports 'scroll' and 'suggest' operations.
BindPlane integration collects and reports the node's instance name for server_name.
/peak_threads
Max threads
GAUGE, DOUBLE, n/aMaximum number of open threads that have been open concurrently in the server JVM process.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/storage_size
Storage size
GAUGE, DOUBLE, BySize in bytes of the document storage on this node.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.
/threads
Threads
GAUGE, DOUBLE, n/aNumber of open threads in the server JVM process.
server_name: The elasticsearch server name.
AdditionsBindPlane integration collects and reports the node's instance name for server_name.

Updated 5 months ago

Stackdriver Agent Migration


Suggested Edits are limited on API Reference Pages

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