Skip to content

Latest commit

 

History

History
89 lines (79 loc) · 8.28 KB

documentation.md

File metadata and controls

89 lines (79 loc) · 8.28 KB
Raw

elasticsearchreceiver

Metrics

These are the metrics available for this scraper.

Name Description Unit Type Attributes
elasticsearch.breaker.memory.estimated Estimated memory used for the operation. By Gauge(Int)
  • circuit_breaker_name
elasticsearch.breaker.memory.limit Memory limit for the circuit breaker. By Sum(Int)
  • circuit_breaker_name
elasticsearch.breaker.tripped Total number of times the circuit breaker has been triggered and prevented an out of memory error. 1 Sum(Int)
  • circuit_breaker_name
elasticsearch.cluster.data_nodes The number of data nodes in the cluster. {nodes} Sum(Int)
elasticsearch.cluster.health The health status of the cluster. Health status is based on the state of its primary and replica shards. Green indicates all shards are assigned. Yellow indicates that one or more replica shards are unassigned. Red indicates that one or more primary shards are unassigned, making some data unavailable. {status} Sum(Int)
  • health_status
elasticsearch.cluster.nodes The total number of nodes in the cluster. {nodes} Sum(Int)
elasticsearch.cluster.shards The number of shards in the cluster. {shards} Sum(Int)
  • shard_state
elasticsearch.node.cache.evictions The number of evictions from the cache. {evictions} Sum(Int)
  • cache_name
elasticsearch.node.cache.memory.usage The size in bytes of the cache. By Sum(Int)
  • cache_name
elasticsearch.node.cluster.connections The number of open tcp connections for internal cluster communication. {connections} Sum(Int)
elasticsearch.node.cluster.io The number of bytes sent and received on the network for internal cluster communication. By Sum(Int)
  • direction
elasticsearch.node.disk.io.read The total number of kilobytes read across all file stores for this node. By Sum(Int)
elasticsearch.node.disk.io.write The total number of kilobytes written across all file stores for this node. By Sum(Int)
elasticsearch.node.documents The number of documents on the node. {documents} Sum(Int)
  • document_state
elasticsearch.node.fs.disk.available The amount of disk space available across all file stores for this node. By Sum(Int)
elasticsearch.node.http.connections The number of HTTP connections to the node. {connections} Sum(Int)
elasticsearch.node.open_files The number of open file descriptors held by the node. {files} Sum(Int)
elasticsearch.node.operations.completed The number of operations completed. {operations} Sum(Int)
  • operation
elasticsearch.node.operations.time Time spent on operations. ms Sum(Int)
  • operation
elasticsearch.node.shards.data_set.size Total data set size of all shards assigned to the node. This includes the size of shards not stored fully on the node, such as the cache for partially mounted indices. By Sum(Int)
elasticsearch.node.shards.reserved.size A prediction of how much larger the shard stores on this node will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. A value of -1 indicates that this is not available. By Sum(Int)
elasticsearch.node.shards.size The size of the shards assigned to this node. By Sum(Int)
elasticsearch.node.thread_pool.tasks.finished The number of tasks finished by the thread pool. {tasks} Sum(Int)
  • thread_pool_name
  • task_state
elasticsearch.node.thread_pool.tasks.queued The number of queued tasks in the thread pool. {tasks} Sum(Int)
  • thread_pool_name
elasticsearch.node.thread_pool.threads The number of threads in the thread pool. {threads} Sum(Int)
  • thread_pool_name
  • thread_state
elasticsearch.node.translog.operations Number of transaction log operations. {operations} Sum(Int)
elasticsearch.node.translog.size Size of the transaction log. By Sum(Int)
elasticsearch.node.translog.uncommitted.size Size of uncommitted transaction log operations. By Sum(Int)
elasticsearch.os.cpu.load_avg.15m Fifteen-minute load average on the system (field is not present if fifteen-minute load average is not available). 1 Gauge(Double)
elasticsearch.os.cpu.load_avg.1m One-minute load average on the system (field is not present if one-minute load average is not available). 1 Gauge(Double)
elasticsearch.os.cpu.load_avg.5m Five-minute load average on the system (field is not present if five-minute load average is not available). 1 Gauge(Double)
elasticsearch.os.cpu.usage Recent CPU usage for the whole system, or -1 if not supported. % Gauge(Int)
elasticsearch.os.memory Amount of physical memory. By Sum(Int)
  • memory_state
jvm.classes.loaded The number of loaded classes 1 Gauge(Int)
jvm.gc.collections.count The total number of garbage collections that have occurred 1 Sum(Int)
  • collector_name
jvm.gc.collections.elapsed The approximate accumulated collection elapsed time ms Sum(Int)
  • collector_name
jvm.memory.heap.committed The amount of memory that is guaranteed to be available for the heap By Gauge(Int)
jvm.memory.heap.max The maximum amount of memory can be used for the heap By Gauge(Int)
jvm.memory.heap.used The current heap memory usage By Gauge(Int)
jvm.memory.nonheap.committed The amount of memory that is guaranteed to be available for non-heap purposes By Gauge(Int)
jvm.memory.nonheap.used The current non-heap memory usage By Gauge(Int)
jvm.memory.pool.max The maximum amount of memory can be used for the memory pool By Gauge(Int)
  • memory_pool_name
jvm.memory.pool.used The current memory pool memory usage By Gauge(Int)
  • memory_pool_name
jvm.threads.count The current number of threads 1 Gauge(Int)

Highlighted metrics are emitted by default. Other metrics are optional and not emitted by default. Any metric can be enabled or disabled with the following scraper configuration:

metrics:
  <metric_name>:
    enabled: <true|false>

Resource attributes

Name Description Type
elasticsearch.cluster.name The name of the elasticsearch cluster. String
elasticsearch.node.name The name of the elasticsearch node. String

Metric attributes

Name Description Values
cache_name The name of cache. fielddata, query
circuit_breaker_name (name) The name of circuit breaker.
collector_name (name) The name of the garbage collector.
direction The direction of network data. received, sent
document_state (state) The state of the document. active, deleted
fs_direction (direction) The direction of filesystem IO. read, write
health_status (status) The health status of the cluster. green, yellow, red
memory_pool_name (name) The name of the JVM memory pool.
memory_state (state) State of the memory free, used
operation (operation) The type of operation. index, delete, get, query, fetch, scroll, suggest, merge, refresh, flush, warmer
shard_state (state) The state of the shard. active, relocating, initializing, unassigned
task_state (state) The state of the task. rejected, completed
thread_pool_name The name of the thread pool.
thread_state (state) The state of the thread. active, idle