This documentation has an index for AI agents at /llms.txt. A Markdown version of this page is available at https://explorer.opentelemetry.io/collector/components/contrib/elasticsearchreceiver.md.

Elasticsearch Receiver

OpenTelemetry Collector receiver · contrib distribution

This receiver queries the Elasticsearch node stats, cluster health and index stats endpoints in order to scrape metrics from a running Elasticsearch cluster.

  • Component ID: contrib-elasticsearchreceiver
  • Name: elasticsearchreceiver
  • Type: receiver
  • Distribution: contrib
  • Repository: opentelemetry-collector-contrib

Stability

LevelSignals
betametrics

Metrics

MetricTypeValue typeUnitStabilityEnabledAttributesDescription
elasticsearch.breaker.memory.estimatedgaugeintBydevelopmentyescircuit_breaker_name (string)Estimated memory used for the operation.
elasticsearch.breaker.memory.limitsumintBydevelopmentyescircuit_breaker_name (string)Memory limit for the circuit breaker.
elasticsearch.breaker.trippedsum (monotonic)int1developmentyescircuit_breaker_name (string)Total number of times the circuit breaker has been triggered and prevented an out of memory error.
elasticsearch.cluster.data_nodessumint{nodes}developmentyesThe number of data nodes in the cluster.
elasticsearch.cluster.healthsumint{status}developmentyeshealth_status (string)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.
elasticsearch.cluster.in_flight_fetchsumint{fetches}developmentyesThe number of unfinished fetches.
elasticsearch.cluster.indices.cache.evictionssum (monotonic)int{evictions}developmentnocache_name (string)The number of evictions from the cache for indices in cluster.
elasticsearch.cluster.nodessumint{nodes}developmentyesThe total number of nodes in the cluster.
elasticsearch.cluster.pending_taskssumint{tasks}developmentyesThe number of cluster-level changes that have not yet been executed.
elasticsearch.cluster.published_states.differencessumint1developmentyescluster_published_difference_state (string)Number of differences between published cluster states.
elasticsearch.cluster.published_states.fullsumint1developmentyesNumber of published cluster states.
elasticsearch.cluster.shardssumint{shards}developmentyesshard_state (string)The number of shards in the cluster.
elasticsearch.cluster.state_queuesumint1developmentyescluster_state_queue_state (string)Number of cluster states in queue.
elasticsearch.cluster.state_update.countsum (monotonic)int1developmentyescluster_state_update_state (string)The number of cluster state update attempts that changed the cluster state since the node started.
elasticsearch.cluster.state_update.timesum (monotonic)intmsdevelopmentyescluster_state_update_state (string), cluster_state_update_type (string)The cumulative amount of time updating the cluster state since the node started.
elasticsearch.index.cache.evictionssum (monotonic)int{evictions}developmentnocache_name (string), index_aggregation_type (string)The number of evictions from the cache for an index.
elasticsearch.index.cache.memory.usagesumintBydevelopmentnocache_name (string), index_aggregation_type (string)The size in bytes of the cache for an index.
elasticsearch.index.cache.sizesumint1developmentnoindex_aggregation_type (string)The number of elements of the query cache for an index.
elasticsearch.index.documentssumint{documents}developmentyesdocument_state (string), index_aggregation_type (string)The number of documents for an index.
elasticsearch.index.operations.completedsum (monotonic)int{operations}developmentyesindex_aggregation_type (string), operation (string)The number of operations completed for an index.
elasticsearch.index.operations.merge.currentgaugeint{merges}developmentyesindex_aggregation_type (string)The number of currently active segment merges
elasticsearch.index.operations.merge.docs_countsum (monotonic)int{documents}developmentnoindex_aggregation_type (string)The total number of documents in merge operations for an index.
elasticsearch.index.operations.merge.sizesum (monotonic)intBydevelopmentnoindex_aggregation_type (string)The total size of merged segments for an index.
elasticsearch.index.operations.timesum (monotonic)intmsdevelopmentyesindex_aggregation_type (string), operation (string)Time spent on operations for an index.
elasticsearch.index.segments.countsumint{segments}developmentyesindex_aggregation_type (string)Number of segments of an index.
elasticsearch.index.segments.memorysumintBydevelopmentnoindex_aggregation_type (string), segments_memory_object_type (string)Size of memory for segment object of an index.
elasticsearch.index.segments.sizesumintBydevelopmentnoindex_aggregation_type (string)Size of segments of an index.
elasticsearch.index.shards.sizesumintBydevelopmentyesindex_aggregation_type (string)The size of the shards assigned to this index.
elasticsearch.index.translog.operationssum (monotonic)int{operations}developmentnoindex_aggregation_type (string)Number of transaction log operations for an index.
elasticsearch.index.translog.sizesumintBydevelopmentnoindex_aggregation_type (string)Size of the transaction log for an index.
elasticsearch.indexing_pressure.memory.limitgaugeintBydevelopmentyesConfigured memory limit, in bytes, for the indexing requests.
elasticsearch.indexing_pressure.memory.total.primary_rejectionssum (monotonic)int1developmentyesCumulative number of indexing requests rejected in the primary stage.
elasticsearch.indexing_pressure.memory.total.replica_rejectionssum (monotonic)int1developmentyesNumber of indexing requests rejected in the replica stage.
elasticsearch.memory.indexing_pressuresumintBydevelopmentyesindexing_pressure_stage (string)Memory consumed, in bytes, by indexing requests in the specified stage.
elasticsearch.node.cache.countsumint{count}developmentyesquery_cache_count_type (string)Total count of query cache misses across all shards assigned to selected nodes.
elasticsearch.node.cache.evictionssum (monotonic)int{evictions}developmentyescache_name (string)The number of evictions from the cache on a node.
elasticsearch.node.cache.memory.usagesumintBydevelopmentyescache_name (string)The size in bytes of the cache on a node.
elasticsearch.node.cache.sizesumintBydevelopmentnoTotal amount of memory used for the query cache across all shards assigned to the node.
elasticsearch.node.cluster.connectionssumint{connections}developmentyesThe number of open tcp connections for internal cluster communication.
elasticsearch.node.cluster.iosum (monotonic)intBydevelopmentyesdirection (string)The number of bytes sent and received on the network for internal cluster communication.
elasticsearch.node.disk.io.readsumintKiBydevelopmentyesThe total number of kilobytes read across all file stores for this node. This metric is available only on Linux systems.
elasticsearch.node.disk.io.writesumintKiBydevelopmentyesThe total number of kilobytes written across all file stores for this node. This metric is available only on Linux systems.
elasticsearch.node.documentssumint{documents}developmentyesdocument_state (string)The number of documents on the node.
elasticsearch.node.fs.disk.availablesumintBydevelopmentyesThe amount of disk space available to the JVM across all file stores for this node. Depending on OS or process level restrictions, this might appear less than free. This is the actual amount of free disk space the Elasticsearch node can utilise.
elasticsearch.node.fs.disk.freesumintBydevelopmentyesThe amount of unallocated disk space across all file stores for this node.
elasticsearch.node.fs.disk.totalsumintBydevelopmentyesThe amount of disk space across all file stores for this node.
elasticsearch.node.http.connectionssumint{connections}developmentyesThe number of HTTP connections to the node.
elasticsearch.node.ingest.documentssum (monotonic)int{documents}developmentyesTotal number of documents ingested during the lifetime of this node.
elasticsearch.node.ingest.documents.currentsumint{documents}developmentyesTotal number of documents currently being ingested.
elasticsearch.node.ingest.operations.failedsum (monotonic)int{operation}developmentyesTotal number of failed ingest operations during the lifetime of this node.
elasticsearch.node.open_filessumint{files}developmentyesThe number of open file descriptors held by the node.
elasticsearch.node.operations.completedsum (monotonic)int{operations}developmentyesoperation (string)The number of operations completed by a node.
elasticsearch.node.operations.currentgaugeint{operations}developmentnooperation (string)Number of query operations currently running.
elasticsearch.node.operations.get.completedsum (monotonic)int{operations}developmentnoget_result (string)The number of hits and misses resulting from GET operations.
elasticsearch.node.operations.get.timesum (monotonic)intmsdevelopmentnoget_result (string)The time spent on hits and misses resulting from GET operations.
elasticsearch.node.operations.timesum (monotonic)intmsdevelopmentyesoperation (string)Time spent on operations by a node.
elasticsearch.node.pipeline.ingest.documents.currentsumint{documents}developmentyesingest_pipeline_name (string)Total number of documents currently being ingested by a pipeline.
elasticsearch.node.pipeline.ingest.documents.preprocessedsumint{documents}developmentyesingest_pipeline_name (string)Number of documents preprocessed by the ingest pipeline.
elasticsearch.node.pipeline.ingest.operations.failedsum (monotonic)int{operation}developmentyesingest_pipeline_name (string)Total number of failed operations for the ingest pipeline.
elasticsearch.node.script.cache_evictionssum (monotonic)int1developmentyesTotal number of times the script cache has evicted old data.
elasticsearch.node.script.compilation_limit_triggeredsum (monotonic)int1developmentyesTotal number of times the script compilation circuit breaker has limited inline script compilations.
elasticsearch.node.script.compilationssumint{compilations}developmentyesTotal number of inline script compilations performed by the node.
elasticsearch.node.segments.memorysumintBydevelopmentnosegments_memory_object_type (string)Size of memory for segment object of a node.
elasticsearch.node.shards.data_set.sizesumintBydevelopmentyesTotal 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.
elasticsearch.node.shards.reserved.sizesumintBydevelopmentyesA 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.
elasticsearch.node.shards.sizesumintBydevelopmentyesThe size of the shards assigned to this node.
elasticsearch.node.thread_pool.tasks.finishedsum (monotonic)int{tasks}developmentyestask_state (string), thread_pool_name (string)The number of tasks finished by the thread pool.
elasticsearch.node.thread_pool.tasks.queuedsumint{tasks}developmentyesthread_pool_name (string)The number of queued tasks in the thread pool.
elasticsearch.node.thread_pool.threadssumint{threads}developmentyesthread_pool_name (string), thread_state (string)The number of threads in the thread pool.
elasticsearch.node.translog.operationssum (monotonic)int{operations}developmentyesNumber of transaction log operations.
elasticsearch.node.translog.sizesumintBydevelopmentyesSize of the transaction log.
elasticsearch.node.translog.uncommitted.sizesumintBydevelopmentyesSize of uncommitted transaction log operations.
elasticsearch.os.cpu.load_avg.15mgaugedouble1developmentyesFifteen-minute load average on the system (field is not present if fifteen-minute load average is not available).
elasticsearch.os.cpu.load_avg.1mgaugedouble1developmentyesOne-minute load average on the system (field is not present if one-minute load average is not available).
elasticsearch.os.cpu.load_avg.5mgaugedouble1developmentyesFive-minute load average on the system (field is not present if five-minute load average is not available).
elasticsearch.os.cpu.usagegaugeint%developmentyesRecent CPU usage for the whole system, or -1 if not supported.
elasticsearch.os.memorygaugeintBydevelopmentyesmemory_state (string)Amount of physical memory.
elasticsearch.process.cpu.timesum (monotonic)intmsdevelopmentnoCPU time used by the process on which the Java virtual machine is running.
elasticsearch.process.cpu.usagegaugedouble1developmentnoCPU usage in percent.
elasticsearch.process.memory.virtualsumintBydevelopmentnoSize of virtual memory that is guaranteed to be available to the running process.
jvm.classes.loadedgaugeint1developmentyesThe number of loaded classes
jvm.gc.collections.countsum (monotonic)int1developmentyescollector_name (string)The total number of garbage collections that have occurred
jvm.gc.collections.elapsedsum (monotonic)intmsdevelopmentyescollector_name (string)The approximate accumulated collection elapsed time
jvm.memory.heap.committedgaugeintBydevelopmentyesThe amount of memory that is guaranteed to be available for the heap
jvm.memory.heap.maxgaugeintBydevelopmentyesThe maximum amount of memory can be used for the heap
jvm.memory.heap.usedgaugeintBydevelopmentyesThe current heap memory usage
jvm.memory.heap.utilizationgaugedouble1developmentnoFraction of heap memory usage
jvm.memory.nonheap.committedgaugeintBydevelopmentyesThe amount of memory that is guaranteed to be available for non-heap purposes
jvm.memory.nonheap.usedgaugeintBydevelopmentyesThe current non-heap memory usage
jvm.memory.pool.maxgaugeintBydevelopmentyesmemory_pool_name (string)The maximum amount of memory can be used for the memory pool
jvm.memory.pool.usedgaugeintBydevelopmentyesmemory_pool_name (string)The current memory pool memory usage
jvm.threads.countgaugeint1developmentyesThe current number of threads

Attributes

AttributeTypeDescription
cache_namestringThe name of cache.
circuit_breaker_namestringThe name of circuit breaker.
cluster_published_difference_statestringState of the published differences
cluster_state_queue_statestringState of the published differences
cluster_state_update_statestringState of cluster state update
cluster_state_update_typestringType of cluster state update
collector_namestringThe name of the garbage collector.
directionstringThe direction of network data.
document_statestringThe state of the document.
get_resultstringResult of get operation
health_statusstringThe health status of the cluster.
index_aggregation_typestringType of shard aggregation for index statistics
indexing_pressure_stagestringStage of the indexing pressure
ingest_pipeline_namestringName of the ingest pipeline.
memory_pool_namestringThe name of the JVM memory pool.
memory_statestringState of the memory
operationstringThe type of operation.
query_cache_count_typestringType of query cache count
segments_memory_object_typestringType of object in segment
shard_statestringThe state of the shard.
task_statestringThe state of the task.
thread_pool_namestringThe name of the thread pool.
thread_statestringThe state of the thread.

Data

  • JSON (latest): /data/collector/components/contrib-elasticsearchreceiver/latest.json
  • JSON (pinned): /data/collector/components/contrib-elasticsearchreceiver/contrib-elasticsearchreceiver-60c037ad5e77.json
  • Explore: /collector/components/contrib/elasticsearchreceiver