Elasticsearch 🔗
DESCRIPTION 🔗
This integration primarily consists of the Smart Agent monitor elasticsearch.
Below is an overview of that monitor.
Smart Agent Monitor 🔗
This monitor collects stats from Elasticsearch. It collects node, cluster and index level stats. This monitor is compatible with the current collectd plugin found [here] (https://github.com/signalfx/collectd-elasticsearch) in terms of metric naming.
This monitor collects cluster level and index level stats only from the current master
in an Elasticsearch cluster by default. It is possible to override this with the
clusterHealthStatsMasterOnly and indexStatsMasterOnly config options respectively.
A simple configuration that collects only default (non-custom) metrics looks like the following:
monitors:
- type: elasticsearch
host: localhost
port: 9200
INSTALLATION 🔗
This integration is part of the SignalFx Smart Agent
as the elasticsearch monitor. You should first deploy the Smart Agent to the
same host as the service you want to monitor, and then continue with the
configuration instructions below.
CONFIGURATION 🔗
To activate this monitor in the Smart Agent, add the following to your agent config:
monitors: # All monitor config goes under this key
- type: elasticsearch
... # Additional config
For a list of monitor options that are common to all monitors, see Common Configuration.
| Config option | Required | Type | Description |
|---|---|---|---|
host |
yes | string |
|
port |
yes | string |
|
username |
no | string |
Username used to access Elasticsearch stats API |
password |
no | string |
Password used to access Elasticsearch stats API |
useHTTPS |
no | bool |
Whether to use https or not (default: false) |
cluster |
no | string |
Cluster name to which the node belongs. This is an optional config that will override the cluster name fetched from a node and will be used to populate the plugin_instance dimension |
enableIndexStats |
no | bool |
Enable Index stats. If set to true, by default the a subset of index stats will be collected (see docs for list of default index metrics collected). (default: true) |
indexes |
no | list of strings |
Indexes to collect stats from (by default stats from all indexes are collected) |
indexStatsIntervalSeconds |
no | integer |
Interval to report IndexStats on (default: 60) |
indexSummaryOnly |
no | bool |
Collect only aggregated index stats across all indexes (default: false) |
indexStatsMasterOnly |
no | bool |
Collect index stats only from Master node (default: true) |
enableClusterHealth |
no | bool |
EnableClusterHealth enables reporting on the cluster health (default: true) |
clusterHealthStatsMasterOnly |
no | bool |
Whether or not non master nodes should report cluster health (default: true) |
enableEnhancedHTTPStats |
no | bool |
Enable enhanced HTTP stats (default: false) |
enableEnhancedJVMStats |
no | bool |
Enable enhanced JVM stats (default: false) |
enableEnhancedProcessStats |
no | bool |
Enable enhanced Process stats (default: false) |
enableEnhancedThreadPoolStats |
no | bool |
Enable enhanced ThreadPool stats (default: false) |
enableEnhancedTransportStats |
no | bool |
Enable enhanced Transport stats (default: false) |
enableEnhancedNodeIndicesStats |
no | list of strings |
Enable enhanced node level index stats groups. A list of index stats groups for which to collect enhanced stats |
threadPools |
no | list of strings |
ThreadPools to report threadpool node stats on (default: [search, index]) |
enableEnhancedClusterHealthStats |
no | bool |
Enable Cluster level stats. These stats report only from master Elasticserach nodes (default: false) |
enableEnhancedIndexStatsForIndexGroups |
no | list of strings |
Enable enhanced index level index stats groups. A list of index stats groups for which to collect enhanced stats |
enableIndexStatsPrimaries |
no | bool |
To enable index stats from only primary shards. By default the index stats collected are aggregated across all shards (default: false) |
metadataRefreshIntervalSeconds |
no | integer |
How often to refresh metadata about the node and cluster (default: 30) |
METRICS 🔗
| Metric Name | Description | Type |
|---|---|---|
| elasticsearch.cluster.active-primary-shards | Number of active primary shards | gauge |
| elasticsearch.cluster.active-shards | Number of active shards | gauge |
| elasticsearch.cluster.active-shards-percent | Percentaage of shards active | gauge |
| elasticsearch.cluster.delayed-unassigned-shards | Number of delayed unassigned shards | gauge |
| elasticsearch.cluster.in-flight-fetches | Number of fetches in-flight | gauge |
| elasticsearch.cluster.initializing-shards | Number of shards being initialized | gauge |
| elasticsearch.cluster.number-of-data_nodes | Number of data nodes | gauge |
| elasticsearch.cluster.number-of-nodes | Number of nodes | gauge |
| elasticsearch.cluster.pending-tasks | Number of pending tasks | gauge |
| elasticsearch.cluster.relocating-shards | Number of shards being relocated | gauge |
| elasticsearch.cluster.status | Cluster stats (0, 1, 2 for green, yellow and red respectively) | gauge |
| elasticsearch.cluster.task-max-wait-time | Max time a task has to wait | gauge |
| elasticsearch.cluster.unassigned-shards | Number of unassigned shards | gauge |
| elasticsearch.http.current_open | Number of currently open HTTP connections | gauge |
| elasticsearch.http.total_open | Total number of opened HTTP connections | cumulative |
| elasticsearch.indices.completion.size | Size used by suggest completion (in bytes) | gauge |
| elasticsearch.indices.docs.count | Number of docs | gauge |
| elasticsearch.indices.docs.deleted | Number of docs deleted | gauge |
| elasticsearch.indices.fielddata.evictions | Number of evictions from fielddata cache | cumulative |
| elasticsearch.indices.fielddata.memory-size | Size of fielddata cache (in bytes) | gauge |
| elasticsearch.indices.filter-cache.evictions | Number of evicttions from filter cache | cumulative |
| elasticsearch.indices.filter-cache.memory-size | Filter cache size (in bytes) | gauge |
| elasticsearch.indices.flush.periodic | How long to wait before triggering a flush regardless of translog size | gauge |
| elasticsearch.indices.flush.total | Number of index flushes to disk | cumulative |
| elasticsearch.indices.flush.total-time | Time spent flushing the index to disk | cumulative |
| elasticsearch.indices.get.current | Number of get requests running | gauge |
| elasticsearch.indices.get.exists-time | Time spent on get requests where the document existed | cumulative |
| elasticsearch.indices.get.exists-total | Number of get requests where the document existed | cumulative |
| elasticsearch.indices.get.missing-time | Time spent on get requests where the document was missing | cumulative |
| elasticsearch.indices.get.missing-total | Number of get requests where the document was missing | cumulative |
| elasticsearch.indices.get.time | Time spent on get requests | cumulative |
| elasticsearch.indices.get.total | Total number of get requests | cumulative |
| elasticsearch.indices.id-cache.memory-size | Size of id cache (in bytes) | gauge |
| elasticsearch.indices.indexing.delete-current | Number of documents currently being deleted from an index | gauge |
| elasticsearch.indices.indexing.delete-time | Time spent deleting documents from an index | cumulative |
| elasticsearch.indices.indexing.delete-total | Number of documents deleted from an index | cumulative |
| elasticsearch.indices.indexing.index-current | Number of documents currently being indexed to an index | gauge |
| elasticsearch.indices.indexing.index-failed | Number of failed indices | gauge |
| elasticsearch.indices.indexing.index-time | Time spent indexing documents to an index | cumulative |
| elasticsearch.indices.indexing.index-total | Total number of documents indexed to an index | cumulative |
| elasticsearch.indices.indexing.noop-update-total | Number of noop updates | cumulative |
| elasticsearch.indices.indexing.throttle-time | Throttle time | cumulative |
| elasticsearch.indices.merges.auto-throttle-size | Merging throttled due to auto-throttling (in bytes) | cumulative |
| elasticsearch.indices.merges.current | Number of currently active segment merges | gauge |
| elasticsearch.indices.merges.current-docs | Number of docs currently being merged | gauge |
| elasticsearch.indices.merges.current-size | Size of the segments currently being merged | gauge |
| elasticsearch.indices.merges.stopped-time | Total time merges were stopped for | cumulative |
| elasticsearch.indices.merges.throttle-time | Total time merges spent waiting due to throttling | cumulative |
| elasticsearch.indices.merges.total | Number of segment merges | cumulative |
| elasticsearch.indices.merges.total-docs | Number of merged docs across merged segments | cumulative |
| elasticsearch.indices.merges.total-size | Total size of merged segments | cumulative |
| elasticsearch.indices.merges.total-time | Total time spent on merging | cumulative |
| elasticsearch.indices.percolate.current | Number of percolator queries currently running | gauge |
| elasticsearch.indices.percolate.queries | Number of percolator queries | cumulative |
| elasticsearch.indices.percolate.time | Total time spent on percolate requests | cumulative |
| elasticsearch.indices.percolate.total | Total number of suggest requests | cumulative |
| elasticsearch.indices.query-cache.cache-count | Number of items in query cache | gauge |
| elasticsearch.indices.query-cache.cache-size | Size of query cache (in bytes) | gauge |
| elasticsearch.indices.query-cache.evictions | Number of query cache evictions | cumulative |
| elasticsearch.indices.query-cache.hit-count | Number of query cache hits | cumulative |
| elasticsearch.indices.query-cache.memory-size | Size of query cache (in bytes) | gauge |
| elasticsearch.indices.query-cache.miss-count | Number of query cache misses | cumulative |
| elasticsearch.indices.query-cache.total-count | Total number of items in the query cache | cumulative |
| elasticsearch.indices.recovery.current-as-source | Number of ongoing recoveries for which a shard serves as a source | gauge |
| elasticsearch.indices.recovery.current-as-target | Number of ongoing recoveries for which a shard serves as a target | gauge |
| elasticsearch.indices.recovery.throttle-time | Total time recoveries waited due to throttling | cumulative |
| elasticsearch.indices.refresh.listeners | Number of listeners waiting for a refresh | gauge |
| elasticsearch.indices.refresh.total | Total number of index refreshes | cumulative |
| elasticsearch.indices.refresh.total-time | Total time spent on index refreshes | cumulative |
| elasticsearch.indices.request-cache.evictions | Number of request cache evictions | cumulative |
| elasticsearch.indices.request-cache.hit-count | Number of request cache hits | cumulative |
| elasticsearch.indices.request-cache.memory-size | Memory used by request cache (in bytes) | gauge |
| elasticsearch.indices.request-cache.miss-count | Number of request cache misses | cumulative |
| elasticsearch.indices.search.fetch-current | Number of query fetches currently running | gauge |
| elasticsearch.indices.search.fetch-time | Total time spent on query fetches | cumulative |
| elasticsearch.indices.search.fetch-total | Total number of query feches | cumulative |
| elasticsearch.indices.search.open-contexts | Number of open contexts | gauge |
| elasticsearch.indices.search.query-current | Number of currently active queries | gauge |
| elasticsearch.indices.search.query-time | Total time spent querying on the primary | cumulative |
| elasticsearch.indices.search.query-total | Total number of queries | cumulative |
| elasticsearch.indices.search.scroll-current | Currently active scroll queries count | gauge |
| elasticsearch.indices.search.scroll-time | Total time spent on scroll queries | cumulative |
| elasticsearch.indices.search.scroll-total | Total number of scroll queries | cumulative |
| elasticsearch.indices.search.suggest-current | Number of suggest requests currently active | gauge |
| elasticsearch.indices.search.suggest-time | Total time spent on search suggest | cumulative |
| elasticsearch.indices.search.suggest-total | Total number of suggest requests | cumulative |
| elasticsearch.indices.segments.count | Number of segments in an index shard | gauge |
| elasticsearch.indices.segments.doc-values-memory-size | Memory used by doc values | gauge |
| elasticsearch.indices.segments.fixed-bit-set-memory-size | Memory used by fixed bit set | gauge |
| elasticsearch.indices.segments.index-writer-max-memory-size | Maximum memory used by the index writer | gauge |
| elasticsearch.indices.segments.index-writer-memory-size | Memory used by the index writer | gauge |
| elasticsearch.indices.segments.memory-size | Memory used by index segments (in bytes) | gauge |
| elasticsearch.indices.segments.norms-memory-size | Memory used by norms (in bytes) | gauge |
| elasticsearch.indices.segments.points-memory-size | Memory used by points | gauge |
| elasticsearch.indices.segments.stored-field-memory-size | Memory used by stored fields (in bytes) | gauge |
| elasticsearch.indices.segments.term-vectors-memory-size | Memory used by term vectors (in bytes) | gauge |
| elasticsearch.indices.segments.terms-memory-size | Memory used by terms (in bytes) | gauge |
| elasticsearch.indices.segments.version-map-memory-size | Memory used by segment version map (in bytes) | gauge |
| elasticsearch.indices.store.size | Total size (in bytes) | gauge |
| elasticsearch.indices.store.throttle-time | Total time requests are throttled for | cumulative |
| elasticsearch.indices.suggest.current | Number of currently active suggest requests | gauge |
| elasticsearch.indices.suggest.time | Total time spent in suggest requests | cumulative |
| elasticsearch.indices.suggest.total | Total number of suggest requests | cumulative |
| elasticsearch.indices.translog.earliest_last_modified_age | Earliest last modified age on transaction logs | gauge |
| elasticsearch.indices.translog.operations | Number of operations in the transaction log | gauge |
| elasticsearch.indices.translog.size | Size of the transaction log | gauge |
| elasticsearch.indices.translog.uncommitted_operations | Number of uncommitted operations in the transaction log | gauge |
| elasticsearch.indices.translog.uncommitted_size_in_bytes | Size of uncommitted transaction logs (in bytes) | gauge |
| elasticsearch.indices.warmer.current | Number of currently active warmers | gauge |
| elasticsearch.indices.warmer.total | Total number of warmers | cumulative |
| elasticsearch.indices.warmer.total-time | Total time spent by warmers | cumulative |
| elasticsearch.jvm.classes.current-loaded-count | Number of classes currently loaded | gauge |
| elasticsearch.jvm.classes.total-loaded-count | Number of classes loaded | cumulative |
| elasticsearch.jvm.classes.total-unloaded-count | Total number of classes unloaded | cumulative |
| elasticsearch.jvm.gc.count | Total number of garbage collections | cumulative |
| elasticsearch.jvm.gc.old-count | Total number of garbage collections on Old Gen | cumulative |
| elasticsearch.jvm.gc.old-time | Total time spent in garbage collections on Old Gen | cumulative |
| elasticsearch.jvm.gc.time | Total time spent on GC | cumulative |
| elasticsearch.jvm.mem.buffer_pools.direct.count | Number of direct buffer pools | gauge |
| elasticsearch.jvm.mem.buffer_pools.direct.total_capacity_in_bytes | Total capacity of direct buffer pools | gauge |
| elasticsearch.jvm.mem.buffer_pools.direct.used_in_bytes | Memory used by direct buffer pools (in bytes) | gauge |
| elasticsearch.jvm.mem.buffer_pools.mapped.count | Number of buffers in the mapped pool | gauge |
| elasticsearch.jvm.mem.buffer_pools.mapped.total_capacity_in_bytes | Total capacity of the buffers in the mapped pool | gauge |
| elasticsearch.jvm.mem.buffer_pools.mapped.used_in_bytes | Memory used by mapped buffer pools (in bytes) | gauge |
| elasticsearch.jvm.mem.heap-committed | Memory guaranteed to be available to JVM heap | gauge |
| elasticsearch.jvm.mem.heap-max | Max memory that can be used by JVM heap (in bytes) | gauge |
| elasticsearch.jvm.mem.heap-used | Memory current being used by JVM heap (in bytes) | gauge |
| elasticsearch.jvm.mem.heap-used-percent | Percent of heap being used | gauge |
| elasticsearch.jvm.mem.non-heap-committed | Memory guaranteed to be available to JVM non-heap | gauge |
| elasticsearch.jvm.mem.non-heap-used | Memory current being used by JVM non-heap (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.old.max_in_bytes | Memory used by Old Gen (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.old.peak_max_in_bytes | Memory pool Old Gen peak max (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.old.peak_used_in_bytes | Peak memory used by Old Gen (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.old.used_in_bytes | Memory being used by Old Gen (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.survivor.max_in_bytes | Max memory that can be used by Survivor space (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.survivor.peak_max_in_bytes | Memory used by Survivor space (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.survivor.peak_used_in_bytes | Peak memory used by Survivor space (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.survivor.used_in_bytes | Memory being used currently by Survivor space (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.young.max_in_bytes | Max memory (in bytes) that can be used by Young Gen | gauge |
| elasticsearch.jvm.mem.pools.young.peak_max_in_bytes | Memory pool Young Gen peak max (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.young.peak_used_in_bytes | Memory pool Young Gen peak used (in bytes) | gauge |
| elasticsearch.jvm.mem.pools.young.used_in_bytes | Memory used by Young Gen (in bytes) | gauge |
| elasticsearch.jvm.threads.count | Number of active threads in the JVM | gauge |
| elasticsearch.jvm.threads.peak | Peak number of threads used | gauge |
| elasticsearch.jvm.uptime | Uptime of JVM | cumulative |
| elasticsearch.process.cpu.percent | CPU usage in percent | gauge |
| elasticsearch.process.cpu.time | CPU time (in milliseconds) used by the process on which the Java virtual machine is running | cumulative |
| elasticsearch.process.max_file_descriptors | Number of opened file descriptors associated with the current process | gauge |
| elasticsearch.process.mem.total-virtual-size | Size in bytes of virtual memory that is guaranteed to be available to the running process | cumulative |
| elasticsearch.process.open_file_descriptors | Number of currently open file descriptors | gauge |
| elasticsearch.thread_pool.active | Number of active threads | gauge |
| elasticsearch.thread_pool.completed | Number of threads completed in thread pool | cumulative |
| elasticsearch.thread_pool.largest | Highest active threads in thread pool | gauge |
| elasticsearch.thread_pool.queue | Number of Tasks in thread pool | gauge |
| elasticsearch.thread_pool.rejected | Number of rejected threads in thread pool | cumulative |
| elasticsearch.thread_pool.threads | Number of Threads in thread pool | cumulative |
| elasticsearch.transport.rx.count | Total size of data received in cluster communication (in bytes) | cumulative |
| elasticsearch.transport.rx.size | Total size of data received in cluster communication | cumulative |
| elasticsearch.transport.server_open | Total number of connections opened for cluster communication | gauge |
| elasticsearch.transport.tx.count | Total number of packets sent in cluster communication | cumulative |
| elasticsearch.transport.tx.size | Total size of data sent in cluster communication | cumulative |
elasticsearch.indices.flush.periodic 🔗
gauge
How long to wait before triggering a flush regardless of translog size
elasticsearch.indices.get.exists-time 🔗
cumulative
Time spent on get requests where the document existed
elasticsearch.indices.get.exists-total 🔗
cumulative
Number of get requests where the document existed
elasticsearch.indices.get.missing-time 🔗
cumulative
Time spent on get requests where the document was missing
elasticsearch.indices.get.missing-total 🔗
cumulative
Number of get requests where the document was missing
elasticsearch.indices.indexing.delete-current 🔗
gauge
Number of documents currently being deleted from an index
elasticsearch.indices.indexing.index-current 🔗
gauge
Number of documents currently being indexed to an index
elasticsearch.indices.indexing.index-total 🔗
cumulative
Total number of documents indexed to an index
elasticsearch.indices.merges.auto-throttle-size 🔗
cumulative
Merging throttled due to auto-throttling (in bytes)
elasticsearch.indices.merges.throttle-time 🔗
cumulative
Total time merges spent waiting due to throttling
elasticsearch.indices.recovery.current-as-source 🔗
gauge
Number of ongoing recoveries for which a shard serves as a source
elasticsearch.indices.recovery.current-as-target 🔗
gauge
Number of ongoing recoveries for which a shard serves as a target
elasticsearch.indices.recovery.throttle-time 🔗
cumulative
Total time recoveries waited due to throttling
elasticsearch.indices.segments.index-writer-max-memory-size 🔗
gauge
Maximum memory used by the index writer
elasticsearch.indices.segments.stored-field-memory-size 🔗
gauge
Memory used by stored fields (in bytes)
elasticsearch.indices.segments.term-vectors-memory-size 🔗
gauge
Memory used by term vectors (in bytes)
elasticsearch.indices.segments.version-map-memory-size 🔗
gauge
Memory used by segment version map (in bytes)
elasticsearch.indices.translog.earliest_last_modified_age 🔗
gauge
Earliest last modified age on transaction logs
elasticsearch.indices.translog.uncommitted_operations 🔗
gauge
Number of uncommitted operations in the transaction log
elasticsearch.indices.translog.uncommitted_size_in_bytes 🔗
gauge
Size of uncommitted transaction logs (in bytes)
elasticsearch.jvm.mem.buffer_pools.direct.total_capacity_in_bytes 🔗
gauge
Total capacity of direct buffer pools
elasticsearch.jvm.mem.buffer_pools.direct.used_in_bytes 🔗
gauge
Memory used by direct buffer pools (in bytes)
elasticsearch.jvm.mem.buffer_pools.mapped.total_capacity_in_bytes 🔗
gauge
Total capacity of the buffers in the mapped pool
elasticsearch.jvm.mem.buffer_pools.mapped.used_in_bytes 🔗
gauge
Memory used by mapped buffer pools (in bytes)
elasticsearch.jvm.mem.pools.survivor.max_in_bytes 🔗
gauge
Max memory that can be used by Survivor space (in bytes)
elasticsearch.jvm.mem.pools.survivor.peak_max_in_bytes 🔗
gauge
Memory used by Survivor space (in bytes)
elasticsearch.jvm.mem.pools.survivor.peak_used_in_bytes 🔗
gauge
Peak memory used by Survivor space (in bytes)
elasticsearch.jvm.mem.pools.survivor.used_in_bytes 🔗
gauge
Memory being used currently by Survivor space (in bytes)
elasticsearch.jvm.mem.pools.young.max_in_bytes 🔗
gauge
Max memory (in bytes) that can be used by Young Gen
elasticsearch.jvm.mem.pools.young.peak_max_in_bytes 🔗
gauge
Memory pool Young Gen peak max (in bytes)
elasticsearch.jvm.mem.pools.young.peak_used_in_bytes 🔗
gauge
Memory pool Young Gen peak used (in bytes)
elasticsearch.process.cpu.time 🔗
cumulative
CPU time (in milliseconds) used by the process on which the Java virtual machine is running
elasticsearch.process.max_file_descriptors 🔗
gauge
Number of opened file descriptors associated with the current process
elasticsearch.process.mem.total-virtual-size 🔗
cumulative
Size in bytes of virtual memory that is guaranteed to be available to the running process
elasticsearch.transport.rx.count 🔗
cumulative
Total size of data received in cluster communication (in bytes)
elasticsearch.transport.server_open 🔗
gauge
Total number of connections opened for cluster communication
elasticsearch.transport.tx.size 🔗
cumulative
Total size of data sent in cluster communication
Metrics that are categorized as container/host (default) are in bold and italics in the list below.
These are the metrics available for this integration.
Group cluster 🔗
All of the following metrics are part of the cluster metric group. All of
the non-default metrics below can be turned on by adding cluster to the
monitor config option extraGroups:
elasticsearch.cluster.active-primary-shards(gauge)
Number of active primary shardselasticsearch.cluster.active-shards(gauge)
Number of active shardselasticsearch.cluster.active-shards-percent(gauge)
Percentaage of shards activeelasticsearch.cluster.delayed-unassigned-shards(gauge)
Number of delayed unassigned shardselasticsearch.cluster.in-flight-fetches(gauge)
Number of fetches in-flightelasticsearch.cluster.initializing-shards(gauge)
Number of shards being initializedelasticsearch.cluster.number-of-data_nodes(gauge)
Number of data nodeselasticsearch.cluster.number-of-nodes(gauge)
Number of nodeselasticsearch.cluster.pending-tasks(gauge)
Number of pending taskselasticsearch.cluster.relocating-shards(gauge)
Number of shards being relocatedelasticsearch.cluster.status(gauge)
Cluster stats (0, 1, 2 for green, yellow and red respectively)elasticsearch.cluster.task-max-wait-time(gauge)
Max time a task has to waitelasticsearch.cluster.unassigned-shards(gauge)
Number of unassigned shards
Group indices/completion 🔗
All of the following metrics are part of the indices/completion metric group. All of
the non-default metrics below can be turned on by adding indices/completion to the
monitor config option extraGroups:
elasticsearch.indices.completion.size(gauge)
Size used by suggest completion (in bytes)
Group indices/docs 🔗
All of the following metrics are part of the indices/docs metric group. All of
the non-default metrics below can be turned on by adding indices/docs to the
monitor config option extraGroups:
elasticsearch.indices.docs.count(gauge)
Number of docselasticsearch.indices.docs.deleted(gauge)
Number of docs deleted
Group indices/fielddata 🔗
All of the following metrics are part of the indices/fielddata metric group. All of
the non-default metrics below can be turned on by adding indices/fielddata to the
monitor config option extraGroups:
elasticsearch.indices.fielddata.evictions(cumulative)
Number of evictions from fielddata cacheelasticsearch.indices.fielddata.memory-size(gauge)
Size of fielddata cache (in bytes)
Group indices/filter-cache 🔗
All of the following metrics are part of the indices/filter-cache metric group. All of
the non-default metrics below can be turned on by adding indices/filter-cache to the
monitor config option extraGroups:
elasticsearch.indices.filter-cache.evictions(cumulative)
Number of evicttions from filter cacheelasticsearch.indices.filter-cache.memory-size(gauge)
Filter cache size (in bytes)
Group indices/flush 🔗
All of the following metrics are part of the indices/flush metric group. All of
the non-default metrics below can be turned on by adding indices/flush to the
monitor config option extraGroups:
elasticsearch.indices.flush.periodic(gauge)
How long to wait before triggering a flush regardless of translog sizeelasticsearch.indices.flush.total(cumulative)
Number of index flushes to diskelasticsearch.indices.flush.total-time(cumulative)
Time spent flushing the index to disk
Group indices/get 🔗
All of the following metrics are part of the indices/get metric group. All of
the non-default metrics below can be turned on by adding indices/get to the
monitor config option extraGroups:
elasticsearch.indices.get.current(gauge)
Number of get requests runningelasticsearch.indices.get.exists-time(cumulative)
Time spent on get requests where the document existedelasticsearch.indices.get.exists-total(cumulative)
Number of get requests where the document existedelasticsearch.indices.get.missing-time(cumulative)
Time spent on get requests where the document was missingelasticsearch.indices.get.missing-total(cumulative)
Number of get requests where the document was missingelasticsearch.indices.get.time(cumulative)
Time spent on get requestselasticsearch.indices.get.total(cumulative)
Total number of get requests
Group indices/id-cache 🔗
All of the following metrics are part of the indices/id-cache metric group. All of
the non-default metrics below can be turned on by adding indices/id-cache to the
monitor config option extraGroups:
elasticsearch.indices.id-cache.memory-size(gauge)
Size of id cache (in bytes)
Group indices/indexing 🔗
All of the following metrics are part of the indices/indexing metric group. All of
the non-default metrics below can be turned on by adding indices/indexing to the
monitor config option extraGroups:
elasticsearch.indices.indexing.delete-current(gauge)
Number of documents currently being deleted from an indexelasticsearch.indices.indexing.delete-time(cumulative)
Time spent deleting documents from an indexelasticsearch.indices.indexing.delete-total(cumulative)
Number of documents deleted from an indexelasticsearch.indices.indexing.index-current(gauge)
Number of documents currently being indexed to an indexelasticsearch.indices.indexing.index-failed(gauge)
Number of failed indiceselasticsearch.indices.indexing.index-time(cumulative)
Time spent indexing documents to an indexelasticsearch.indices.indexing.index-total(cumulative)
Total number of documents indexed to an indexelasticsearch.indices.indexing.noop-update-total(cumulative)
Number of noop updateselasticsearch.indices.indexing.throttle-time(cumulative)
Throttle time
Group indices/merges 🔗
All of the following metrics are part of the indices/merges metric group. All of
the non-default metrics below can be turned on by adding indices/merges to the
monitor config option extraGroups:
elasticsearch.indices.merges.auto-throttle-size(cumulative)
Merging throttled due to auto-throttling (in bytes)elasticsearch.indices.merges.current(gauge)
Number of currently active segment mergeselasticsearch.indices.merges.current-docs(gauge)
Number of docs currently being mergedelasticsearch.indices.merges.current-size(gauge)
Size of the segments currently being mergedelasticsearch.indices.merges.stopped-time(cumulative)
Total time merges were stopped forelasticsearch.indices.merges.throttle-time(cumulative)
Total time merges spent waiting due to throttlingelasticsearch.indices.merges.total(cumulative)
Number of segment mergeselasticsearch.indices.merges.total-docs(cumulative)
Number of merged docs across merged segmentselasticsearch.indices.merges.total-size(cumulative)
Total size of merged segmentselasticsearch.indices.merges.total-time(cumulative)
Total time spent on merging
Group indices/percolate 🔗
All of the following metrics are part of the indices/percolate metric group. All of
the non-default metrics below can be turned on by adding indices/percolate to the
monitor config option extraGroups:
elasticsearch.indices.percolate.current(gauge)
Number of percolator queries currently runningelasticsearch.indices.percolate.queries(cumulative)
Number of percolator querieselasticsearch.indices.percolate.time(cumulative)
Total time spent on percolate requestselasticsearch.indices.percolate.total(cumulative)
Total number of suggest requests
Group indices/query-cache 🔗
All of the following metrics are part of the indices/query-cache metric group. All of
the non-default metrics below can be turned on by adding indices/query-cache to the
monitor config option extraGroups:
elasticsearch.indices.query-cache.cache-count(gauge)
Number of items in query cacheelasticsearch.indices.query-cache.cache-size(gauge)
Size of query cache (in bytes)elasticsearch.indices.query-cache.evictions(cumulative)
Number of query cache evictionselasticsearch.indices.query-cache.hit-count(cumulative)
Number of query cache hitselasticsearch.indices.query-cache.memory-size(gauge)
Size of query cache (in bytes)elasticsearch.indices.query-cache.total-count(cumulative)
Total number of items in the query cache
Group indices/recovery 🔗
All of the following metrics are part of the indices/recovery metric group. All of
the non-default metrics below can be turned on by adding indices/recovery to the
monitor config option extraGroups:
elasticsearch.indices.recovery.current-as-source(gauge)
Number of ongoing recoveries for which a shard serves as a sourceelasticsearch.indices.recovery.current-as-target(gauge)
Number of ongoing recoveries for which a shard serves as a targetelasticsearch.indices.recovery.throttle-time(cumulative)
Total time recoveries waited due to throttling
Group indices/refresh 🔗
All of the following metrics are part of the indices/refresh metric group. All of
the non-default metrics below can be turned on by adding indices/refresh to the
monitor config option extraGroups:
elasticsearch.indices.refresh.listeners(gauge)
Number of listeners waiting for a refreshelasticsearch.indices.refresh.total(cumulative)
Total number of index refresheselasticsearch.indices.refresh.total-time(cumulative)
Total time spent on index refreshes
Group indices/request-cache 🔗
All of the following metrics are part of the indices/request-cache metric group. All of
the non-default metrics below can be turned on by adding indices/request-cache to the
monitor config option extraGroups:
elasticsearch.indices.query-cache.miss-count(cumulative)
Number of query cache misseselasticsearch.indices.request-cache.evictions(cumulative)
Number of request cache evictionselasticsearch.indices.request-cache.hit-count(cumulative)
Number of request cache hitselasticsearch.indices.request-cache.memory-size(gauge)
Memory used by request cache (in bytes)elasticsearch.indices.request-cache.miss-count(cumulative)
Number of request cache misses
Group indices/search 🔗
All of the following metrics are part of the indices/search metric group. All of
the non-default metrics below can be turned on by adding indices/search to the
monitor config option extraGroups:
elasticsearch.indices.search.fetch-current(gauge)
Number of query fetches currently runningelasticsearch.indices.search.fetch-time(cumulative)
Total time spent on query fetcheselasticsearch.indices.search.fetch-total(cumulative)
Total number of query fecheselasticsearch.indices.search.open-contexts(gauge)
Number of open contextselasticsearch.indices.search.query-current(gauge)
Number of currently active querieselasticsearch.indices.search.query-time(cumulative)
Total time spent querying on the primaryelasticsearch.indices.search.query-total(cumulative)
Total number of querieselasticsearch.indices.search.scroll-current(gauge)
Currently active scroll queries countelasticsearch.indices.search.scroll-time(cumulative)
Total time spent on scroll querieselasticsearch.indices.search.scroll-total(cumulative)
Total number of scroll querieselasticsearch.indices.search.suggest-current(gauge)
Number of suggest requests currently activeelasticsearch.indices.search.suggest-time(cumulative)
Total time spent on search suggestelasticsearch.indices.search.suggest-total(cumulative)
Total number of suggest requests
Group indices/segments 🔗
All of the following metrics are part of the indices/segments metric group. All of
the non-default metrics below can be turned on by adding indices/segments to the
monitor config option extraGroups:
elasticsearch.indices.segments.count(gauge)
Number of segments in an index shardelasticsearch.indices.segments.doc-values-memory-size(gauge)
Memory used by doc valueselasticsearch.indices.segments.fixed-bit-set-memory-size(gauge)
Memory used by fixed bit setelasticsearch.indices.segments.index-writer-max-memory-size(gauge)
Maximum memory used by the index writerelasticsearch.indices.segments.index-writer-memory-size(gauge)
Memory used by the index writerelasticsearch.indices.segments.memory-size(gauge)
Memory used by index segments (in bytes)elasticsearch.indices.segments.norms-memory-size(gauge)
Memory used by norms (in bytes)elasticsearch.indices.segments.points-memory-size(gauge)
Memory used by pointselasticsearch.indices.segments.stored-field-memory-size(gauge)
Memory used by stored fields (in bytes)elasticsearch.indices.segments.term-vectors-memory-size(gauge)
Memory used by term vectors (in bytes)elasticsearch.indices.segments.terms-memory-size(gauge)
Memory used by terms (in bytes)elasticsearch.indices.segments.version-map-memory-size(gauge)
Memory used by segment version map (in bytes)
Group indices/store 🔗
All of the following metrics are part of the indices/store metric group. All of
the non-default metrics below can be turned on by adding indices/store to the
monitor config option extraGroups:
elasticsearch.indices.store.size(gauge)
Total size (in bytes)elasticsearch.indices.store.throttle-time(cumulative)
Total time requests are throttled for
Group indices/suggest 🔗
All of the following metrics are part of the indices/suggest metric group. All of
the non-default metrics below can be turned on by adding indices/suggest to the
monitor config option extraGroups:
elasticsearch.indices.suggest.current(gauge)
Number of currently active suggest requestselasticsearch.indices.suggest.time(cumulative)
Total time spent in suggest requestselasticsearch.indices.suggest.total(cumulative)
Total number of suggest requests
Group indices/translog 🔗
All of the following metrics are part of the indices/translog metric group. All of
the non-default metrics below can be turned on by adding indices/translog to the
monitor config option extraGroups:
elasticsearch.indices.translog.earliest_last_modified_age(gauge)
Earliest last modified age on transaction logselasticsearch.indices.translog.operations(gauge)
Number of operations in the transaction logelasticsearch.indices.translog.size(gauge)
Size of the transaction logelasticsearch.indices.translog.uncommitted_operations(gauge)
Number of uncommitted operations in the transaction logelasticsearch.indices.translog.uncommitted_size_in_bytes(gauge)
Size of uncommitted transaction logs (in bytes)
Group indices/warmer 🔗
All of the following metrics are part of the indices/warmer metric group. All of
the non-default metrics below can be turned on by adding indices/warmer to the
monitor config option extraGroups:
elasticsearch.indices.warmer.current(gauge)
Number of currently active warmerselasticsearch.indices.warmer.total(cumulative)
Total number of warmerselasticsearch.indices.warmer.total-time(cumulative)
Total time spent by warmers
Group node/http 🔗
All of the following metrics are part of the node/http metric group. All of
the non-default metrics below can be turned on by adding node/http to the
monitor config option extraGroups:
elasticsearch.http.current_open(gauge)
Number of currently open HTTP connectionselasticsearch.http.total_open(cumulative)
Total number of opened HTTP connections
Group node/jvm 🔗
All of the following metrics are part of the node/jvm metric group. All of
the non-default metrics below can be turned on by adding node/jvm to the
monitor config option extraGroups:
elasticsearch.jvm.classes.current-loaded-count(gauge)
Number of classes currently loadedelasticsearch.jvm.classes.total-loaded-count(cumulative)
Number of classes loadedelasticsearch.jvm.classes.total-unloaded-count(cumulative)
Total number of classes unloadedelasticsearch.jvm.gc.count(cumulative)
Total number of garbage collectionselasticsearch.jvm.gc.old-count(cumulative)
Total number of garbage collections on Old Genelasticsearch.jvm.gc.old-time(cumulative)
Total time spent in garbage collections on Old Genelasticsearch.jvm.gc.time(cumulative)
Total time spent on GCelasticsearch.jvm.mem.buffer_pools.direct.count(gauge)
Number of direct buffer poolselasticsearch.jvm.mem.buffer_pools.direct.total_capacity_in_bytes(gauge)
Total capacity of direct buffer poolselasticsearch.jvm.mem.buffer_pools.direct.used_in_bytes(gauge)
Memory used by direct buffer pools (in bytes)elasticsearch.jvm.mem.buffer_pools.mapped.count(gauge)
Number of buffers in the mapped poolelasticsearch.jvm.mem.buffer_pools.mapped.total_capacity_in_bytes(gauge)
Total capacity of the buffers in the mapped poolelasticsearch.jvm.mem.buffer_pools.mapped.used_in_bytes(gauge)
Memory used by mapped buffer pools (in bytes)elasticsearch.jvm.mem.heap-committed(gauge)
Memory guaranteed to be available to JVM heapelasticsearch.jvm.mem.heap-max(gauge)
Max memory that can be used by JVM heap (in bytes)elasticsearch.jvm.mem.heap-used(gauge)
Memory current being used by JVM heap (in bytes)elasticsearch.jvm.mem.heap-used-percent(gauge)
Percent of heap being usedelasticsearch.jvm.mem.non-heap-committed(gauge)
Memory guaranteed to be available to JVM non-heapelasticsearch.jvm.mem.non-heap-used(gauge)
Memory current being used by JVM non-heap (in bytes)elasticsearch.jvm.mem.pools.old.max_in_bytes(gauge)
Memory used by Old Gen (in bytes)elasticsearch.jvm.mem.pools.old.peak_max_in_bytes(gauge)
Memory pool Old Gen peak max (in bytes)elasticsearch.jvm.mem.pools.old.peak_used_in_bytes(gauge)
Peak memory used by Old Gen (in bytes)elasticsearch.jvm.mem.pools.old.used_in_bytes(gauge)
Memory being used by Old Gen (in bytes)elasticsearch.jvm.mem.pools.survivor.max_in_bytes(gauge)
Max memory that can be used by Survivor space (in bytes)elasticsearch.jvm.mem.pools.survivor.peak_max_in_bytes(gauge)
Memory used by Survivor space (in bytes)elasticsearch.jvm.mem.pools.survivor.peak_used_in_bytes(gauge)
Peak memory used by Survivor space (in bytes)elasticsearch.jvm.mem.pools.survivor.used_in_bytes(gauge)
Memory being used currently by Survivor space (in bytes)elasticsearch.jvm.mem.pools.young.max_in_bytes(gauge)
Max memory (in bytes) that can be used by Young Genelasticsearch.jvm.mem.pools.young.peak_max_in_bytes(gauge)
Memory pool Young Gen peak max (in bytes)elasticsearch.jvm.mem.pools.young.peak_used_in_bytes(gauge)
Memory pool Young Gen peak used (in bytes)elasticsearch.jvm.mem.pools.young.used_in_bytes(gauge)
Memory used by Young Gen (in bytes)elasticsearch.jvm.threads.count(gauge)
Number of active threads in the JVMelasticsearch.jvm.threads.peak(gauge)
Peak number of threads usedelasticsearch.jvm.uptime(cumulative)
Uptime of JVM
Group node/process 🔗
All of the following metrics are part of the node/process metric group. All of
the non-default metrics below can be turned on by adding node/process to the
monitor config option extraGroups:
elasticsearch.process.cpu.percent(gauge)
CPU usage in percentelasticsearch.process.cpu.time(cumulative)
CPU time (in milliseconds) used by the process on which the Java virtual machine is runningelasticsearch.process.max_file_descriptors(gauge)
Number of opened file descriptors associated with the current processelasticsearch.process.mem.total-virtual-size(cumulative)
Size in bytes of virtual memory that is guaranteed to be available to the running processelasticsearch.process.open_file_descriptors(gauge)
Number of currently open file descriptors
Group node/thread-pool 🔗
All of the following metrics are part of the node/thread-pool metric group. All of
the non-default metrics below can be turned on by adding node/thread-pool to the
monitor config option extraGroups:
elasticsearch.thread_pool.active(gauge)
Number of active threadselasticsearch.thread_pool.completed(cumulative)
Number of threads completed in thread poolelasticsearch.thread_pool.largest(gauge)
Highest active threads in thread poolelasticsearch.thread_pool.queue(gauge)
Number of Tasks in thread poolelasticsearch.thread_pool.rejected(cumulative)
Number of rejected threads in thread poolelasticsearch.thread_pool.threads(cumulative)
Number of Threads in thread pool
Group node/transport 🔗
All of the following metrics are part of the node/transport metric group. All of
the non-default metrics below can be turned on by adding node/transport to the
monitor config option extraGroups:
elasticsearch.transport.rx.count(cumulative)
Total size of data received in cluster communication (in bytes)elasticsearch.transport.rx.size(cumulative)
Total size of data received in cluster communicationelasticsearch.transport.server_open(gauge)
Total number of connections opened for cluster communicationelasticsearch.transport.tx.count(cumulative)
Total number of packets sent in cluster communicationelasticsearch.transport.tx.size(cumulative)
Total size of data sent in cluster communication
Non-default metrics (version 4.7.0+) 🔗
The following information applies to the agent version 4.7.0+ that has
enableBuiltInFiltering: true set on the top level of the agent config.
To emit metrics that are not default, you can add those metrics in the
generic monitor-level extraMetrics config option. Metrics that are derived
from specific configuration options that do not appear in the above list of
metrics do not need to be added to extraMetrics.
To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.
Legacy non-default metrics (version < 4.7.0) 🔗
The following information only applies to agent version older than 4.7.0. If
you have a newer agent and have set enableBuiltInFiltering: true at the top
level of your agent config, see the section above. See upgrade instructions in
Old-style whitelist filtering.
If you have a reference to the whitelist.json in your agent’s top-level
metricsToExclude config option, and you want to emit metrics that are not in
that whitelist, then you need to add an item to the top-level
metricsToInclude config option to override that whitelist (see Inclusion
filtering. Or you can just
copy the whitelist.json, modify it, and reference that in metricsToExclude.