Get node statistics
- GET /_nodes/{node_id}/stats/{metric}/{index_metric}
- GET /_nodes/stats/{metric}/{index_metric}
- GET /_nodes/{node_id}/stats/{metric}
- GET /_nodes/{node_id}/stats
- GET /_nodes/stats/{metric}
- GET /_nodes/stats
Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.
Required privileges
- Cluster privileges monitor manage
Path parameters
-
node_idunion string | string[]optional -
Comma-separated list of node IDs or names used to limit returned information.
Leave it out to use
/_nodes/stats. -
metricunion enum | enum[]optional -
Limits the information returned to the specific metrics.
Supported values include:
_all,_none,indices,os,process,jvm,thread_pool,fs,transport,http,breaker,script,discovery,ingest,adaptive_selection,script_cache,indexing_pressure,repositories,allocationsLeave it out to use
/_nodes/stats. -
Values:
_all_noneindicesosprocessjvmthread_poolfstransporthttpbreakerscriptdiscoveryingestadaptive_selectionscript_cacheindexing_pressurerepositoriesallocations -
index_metricunion enum | enum[]optional -
Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.
Supported values include:
_all: Return all statistics.store: Size of the index in byte units.indexing: Indexing statistics.get: Get statistics, including missing stats.search: Search statistics including suggest statistics. You can include statistics for custom groups by adding an extragroupsparameter (search operations can be associated with one or more groups). Thegroupsparameter accepts a comma-separated list of group names. Use_allto return statistics for all groups.merge: Merge statistics.flush: Flush statistics.refresh: Refresh statistics.query_cache: Query cache statistics.fielddata: Fielddata statistics.docs: Number of documents and deleted docs not yet merged out. Index refreshes can affect this statistic.warmer: Index warming statistics.completion: Completion suggester statistics.segments: Memory use of all open segments. If theinclude_segment_file_sizesparameter istrue, this metric includes the aggregated disk usage of each Lucene index file.translog: Translog statistics.request_cache: Shard request cache statistics.recovery: Recovery statistics.bulk: Bulk operations statistics.shard_stats: Shard statistics, including the total number of shards.mappings: Mapping statistics, including the total count and estimated overhead.dense_vector: Total number of dense vectors indexed. Index refreshes can affect this statistic.sparse_vector: Total number of sparse vectors indexed. Index refreshes can affect this statistic.
Leave it out to use
/_nodes/stats. -
Values:
_allstoreindexinggetsearchmergeflushrefreshquery_cachefielddatadocswarmercompletionsegmentstranslogrequest_cacherecoverybulkshard_statsmappingsdense_vectorsparse_vector
Query parameters
-
completion_fieldsunion string | string[] -
Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
-
fielddata_fieldsunion string | string[] -
Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
-
fieldsunion string | string[] -
Comma-separated list or wildcard expressions of fields to include in the statistics.
-
include_segment_file_sizesboolean · default: false -
If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
-
levelenum · default: node -
Indicates whether statistics are aggregated at the node, indices, or shards level.
-
Values:
nodeindicesshards
Response
-
nodesmap string to objectrequired -
<string>object -
adaptive_selectionmap string to object -
Statistics about adaptive replica selection.
-
<string>object -
avg_queue_sizenumber -
The exponentially weighted moving average queue size of search requests on the keyed node.
-
avg_response_timeunion oneOf -
The exponentially weighted moving average response time of search requests on the keyed node.
-
Values:
-10 -
avg_response_time_nsnumber -
The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.
-
avg_service_timeunion oneOf -
The exponentially weighted moving average service time of search requests on the keyed node.
-
Values:
-10 -
avg_service_time_nsnumber -
The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.
-
fsobject -
File system information, data path, free disk space, read/write stats.
-
dataobject[] -
List of all file stores.
-
availablestring -
Total amount of disk space available to this Java virtual machine on this file store.
-
available_in_bytesnumber -
Total number of bytes available to this Java virtual machine on this file store.
-
low_watermark_free_spacestring -
The amount of free disk space that, once reached, triggers the low disk watermark.
-
low_watermark_free_space_in_bytesnumber -
The amount of free disk space, in bytes, that, once reached, triggers the low disk watermark.
-
high_watermark_free_spacestring -
The amount of free disk space that, once reached, triggers the high disk watermark.
-
high_watermark_free_space_in_bytesnumber -
The amount of free disk space, in bytes, that, once reached, triggers the high disk watermark.
-
flood_stage_free_spacestring -
The amount of free disk space that, once reached, triggers the flood stage disk watermark.
-
flood_stage_free_space_in_bytesnumber -
The amount of free disk space, in bytes, that, once reached, triggers the flood stage disk watermark.
-
frozen_flood_stage_free_spacestring -
The amount of free disk space that, once reached, triggers the frozen flood stage disk watermark.
-
timestampnumber -
Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch.
-
totalobject -
Contains statistics for all file stores of the node.
-
io_statsobject -
Contains I/O statistics for the node.
-
devicesobject[] -
Array of disk metrics for each device that is backing an Elasticsearch data path. These disk metrics are probed periodically and averages between the last probe and the current probe are computed.
-
operationsnumber -
The total number of read and write operations for the device completed since starting Elasticsearch.
-
read_kilobytesnumber -
The total number of kilobytes read for the device since starting Elasticsearch.
-
read_operationsnumber -
The total number of read operations for the device completed since starting Elasticsearch.
-
totalobject -
The sum of the disk metrics for all devices that back an Elasticsearch data path.
-
operationsnumber -
The total number of read and write operations for the device completed since starting Elasticsearch.
-
read_kilobytesnumber -
The total number of kilobytes read for the device since starting Elasticsearch.
-
read_operationsnumber -
The total number of read operations for the device completed since starting Elasticsearch.
-
httpobject -
HTTP connection information.
-
ingestobject -
Statistics about ingest preprocessing.
-
pipelinesmap string to object -
Contains statistics about ingest pipelines for the node.
-
<string>object -
timeunion oneOf -
Total time spent preprocessing ingest documents during the lifetime of this node.
-
Values:
-10 -
time_in_millisnumberrequired -
Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.
-
ingested_as_first_pipelinenumber | string -
Total size of all documents ingested by the pipeline. The value counts documents for which this pipeline was the first to process them; for pipelines that are not the first to process a document (for example, a final pipeline after a default pipeline, a pipeline run after a reroute processor, or a pipeline invoked by a pipeline processor), the value is
0. -
ingested_as_first_pipeline_in_bytesnumberrequired -
Total number of bytes of all documents ingested by the pipeline. The value counts documents for which this pipeline was the first to process them; for pipelines that are not the first to process a document, the value is
0. -
produced_as_first_pipelinenumber | string -
Total size of all documents produced by the pipeline. The value counts documents for which this pipeline was the first to process them; for pipelines that are not the first to process a document, the value is
0. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run. -
produced_as_first_pipeline_in_bytesnumberrequired -
Total number of bytes of all documents produced by the pipeline. The value counts documents for which this pipeline was the first to process them; for pipelines that are not the first to process a document, the value is
0. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run. -
jvmobject -
JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.
-
osobject -
Operating system stats, load average, mem, swap.
-
memobject -
swapobject -
cgroupobject -
cpuobject -
Contains statistics about
cpucontrol group for the node. -
cfs_period_microsnumber -
The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated.
-
cfs_quota_microsnumber -
The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period
cfs_period_micros. -
memoryobject -
Contains statistics about the memory control group for the node.
-
limit_in_bytesstring -
The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process. This value can be too big to store in a
long, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. Any value that is too large to parse into alongalmost certainly means no limit has been set for the cgroup. -
rolesenum[] -
Roles assigned to the node.
-
Values:
masterdatadata_colddata_contentdata_frozendata_hotdata_warmclientingestmlvoting_onlytransformremote_cluster_clientcoordinating_only -
thread_poolmap string to object -
Statistics about each thread pool, including current size, queue and rejected tasks.
-
<string>object -
transportobject -
Transport statistics about sent and received bytes in cluster communication.
-
inbound_handling_time_histogramobject[] -
The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.
-
countnumber -
The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.
-
ltunion oneOf -
The exclusive upper bound of the bucket. May be omitted on the last bucket if this bucket has no upper bound.
-
Values:
-10 -
lt_millisnumber -
The exclusive upper bound of the bucket in milliseconds. May be omitted on the last bucket if this bucket has no upper bound.
-
outbound_handling_time_histogramobject[] -
The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.
-
countnumber -
The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.
-
ltunion oneOf -
The exclusive upper bound of the bucket. May be omitted on the last bucket if this bucket has no upper bound.
-
Values:
-10 -
lt_millisnumber -
The exclusive upper bound of the bucket in milliseconds. May be omitted on the last bucket if this bucket has no upper bound.
-
rx_countnumber -
Total number of RX (receive) packets received by the node during internal cluster communication.
-
rx_size_in_bytesnumber -
Size, in bytes, of RX packets received by the node during internal cluster communication.
-
server_opennumber -
Current number of inbound TCP connections used for internal communication between nodes.
-
tx_countnumber -
Total number of TX (transmit) packets sent by the node during internal cluster communication.
-
tx_size_in_bytesnumber -
Size, in bytes, of TX packets sent by the node during internal cluster communication.
-
total_outbound_connectionsnumber -
The cumulative number of outbound transport connections that this node has opened since it started. Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. Transport connections are typically long-lived so this statistic should remain constant in a stable cluster.
-
actionsmap string to object -
Statistics about the transport messages sent and received by the node, broken down by action name.
-
<string>object -
requestsobjectrequired -
Statistics about the requests received for this action.
-
countnumberrequired -
The number of messages of this kind that the node has handled for this action.
-
total_sizenumber | string -
The cumulative size of the messages of this kind that the node has handled for this action.
-
total_size_in_bytesnumberrequired -
The cumulative size, in bytes, of the messages of this kind that the node has handled for this action.
-
histogramobject[]required -
The distribution of the sizes of the messages of this kind that the node has handled for this action, represented as a histogram.
-
countnumberrequired -
The number of messages with a size that falls within the bounds of this bucket.
-
genumber | string -
The inclusive lower bound of the bucket. May be omitted on the first bucket if this bucket has no lower bound.
-
ge_bytesnumber -
The inclusive lower bound of the bucket in bytes. May be omitted on the first bucket if this bucket has no lower bound.
-
responsesobjectrequired -
Statistics about the responses sent for this action.
-
countnumberrequired -
The number of messages of this kind that the node has handled for this action.
-
total_sizenumber | string -
The cumulative size of the messages of this kind that the node has handled for this action.
-
total_size_in_bytesnumberrequired -
The cumulative size, in bytes, of the messages of this kind that the node has handled for this action.
-
histogramobject[]required -
The distribution of the sizes of the messages of this kind that the node has handled for this action, represented as a histogram.
-
countnumberrequired -
The number of messages with a size that falls within the bounds of this bucket.
-
genumber | string -
The inclusive lower bound of the bucket. May be omitted on the first bucket if this bucket has no lower bound.
-
ge_bytesnumber -
The inclusive lower bound of the bucket in bytes. May be omitted on the first bucket if this bucket has no lower bound.
-
transport_addressstring -
Host and port for the transport layer, used for internal communication between nodes in a cluster.
-
discoveryobject -
Contains node discovery statistics for the node.
-
cluster_state_updatemap string to object -
Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. Omitted if the node is not master-eligible. Every field whose name ends in
_timewithin this object is also represented as a raw number of milliseconds in a field whose name ends in_time_millis. The human-readable fields with a_timesuffix are only returned if requested with the?human=truequery parameter. -
<string>object -
countnumberrequired -
The number of cluster state update attempts that did not change the cluster state since the node started.
-
computation_timeunion oneOf -
The cumulative amount of time spent computing no-op cluster state updates since the node started.
-
Values:
-10 -
computation_time_millisnumber -
The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started.
-
publication_timeunion oneOf -
The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. This includes the time measured by
context_construction_time,commit_time,completion_timeandmaster_apply_time. -
Values:
-10 -
publication_time_millisnumber -
The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. This includes the time measured by
context_construction_time,commit_time,completion_timeandmaster_apply_time. -
context_construction_timeunion oneOf -
The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded. This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.
-
Values:
-10 -
context_construction_time_millisnumber -
The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded. This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.
-
commit_timeunion oneOf -
The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.
-
Values:
-10 -
commit_time_millisnumber -
The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.
-
completion_timeunion oneOf -
The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.
-
Values:
-10 -
completion_time_millisnumber -
The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.
-
master_apply_timeunion oneOf -
The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started.
-
Values:
-10 -
master_apply_time_millisnumber -
The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started.
-
indexing_pressureobject -
Contains indexing pressure statistics for the node.
-
memoryobject -
Contains statistics for memory consumption from indexing load.
-
limitnumber | string -
Configured memory limit for the indexing requests. Replica requests have an automatic limit that is 1.5x this value.
-
limit_in_bytesnumber -
Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value.
-
currentobject -
Contains statistics for current indexing load.
-
allnumber | string -
Memory consumed by indexing requests in the coordinating, primary, or replica stage.
-
all_in_bytesnumber -
Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.
-
combined_coordinating_and_primarynumber | string -
Memory consumed by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.
-
combined_coordinating_and_primary_in_bytesnumber -
Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.
-
totalobject -
Contains statistics for the cumulative indexing load since the node started.
-
Same fields as
currentinmemory -
indicesobject -
Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.
-
docsobject -
countnumberrequired -
Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
-
deletednumber -
Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
-
segmentsobject -
doc_values_memorynumber | string -
Total amount of memory used for doc values across all shards assigned to selected nodes.
-
doc_values_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
-
file_sizesmap string to objectrequired -
This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
-
fixed_bit_setnumber | string -
Total amount of memory used by fixed bit sets across all shards assigned to selected nodes. Fixed bit sets are used for nested object field types and type filters for join fields.
-
fixed_bit_set_memory_in_bytesnumberrequired -
Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
-
index_writer_memorynumber | string -
Total amount of memory used by all index writers across all shards assigned to selected nodes.
-
index_writer_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
-
max_unsafe_auto_id_timestampnumberrequired -
Unix timestamp, in milliseconds, of the most recently retried indexing request.
-
memorynumber | string -
Total amount of memory used for segments across all shards assigned to selected nodes.
-
memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
-
norms_memorynumber | string -
Total amount of memory used for normalization factors across all shards assigned to selected nodes.
-
norms_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
-
points_memorynumber | string -
Total amount of memory used for points across all shards assigned to selected nodes.
-
points_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
-
stored_fields_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
-
stored_fields_memorynumber | string -
Total amount of memory used for stored fields across all shards assigned to selected nodes.
-
terms_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
-
terms_memorynumber | string -
Total amount of memory used for terms across all shards assigned to selected nodes.
-
term_vectors_memorynumber | string -
Total amount of memory used for term vectors across all shards assigned to selected nodes.
-
term_vectors_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
-
storeobject -
reservednumber | string -
A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
-
reserved_in_bytesnumberrequired -
A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
-
repositoriesmap string to object -
Statistics about snapshot activity for the node's registered repositories, keyed by repository name.
-
<string>object -
total_read_throttled_timeunion oneOf -
The cumulative time spent throttling read operations for this repository.
-
Values:
-10 -
total_write_throttled_timeunion oneOf -
The cumulative time spent throttling write operations for this repository.
-
Values:
-10 -
total_read_throttled_time_nanosnumberrequired -
The cumulative time, in nanoseconds, spent throttling read operations for this repository.
-
total_write_throttled_time_nanosnumberrequired -
The cumulative time, in nanoseconds, spent throttling write operations for this repository.
-
shard_snapshots_completednumberrequired -
The number of shard snapshots completed for this repository.
-
shard_snapshots_in_progressnumberrequired -
The number of shard snapshots currently in progress for this repository.
-
uploaded_size_in_bytesnumberrequired -
The cumulative size, in bytes, of the blobs uploaded to this repository.
-
total_upload_timeunion oneOf -
The cumulative time spent uploading blobs to this repository.
-
Values:
-10 -
total_upload_time_in_millisnumberrequired -
The cumulative time, in milliseconds, spent uploading blobs to this repository.