IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Nodes reload secure settings API Pending cluster tasks API »

› › ›

Nodes stats API

edit

Nodes stats API

edit

Returns cluster nodes statistics.

Request

edit

GET /_nodes/stats

GET /_nodes/<node_id>/stats

GET /_nodes/stats/<metric>

GET /_nodes/<node_id>/stats/<metric>

GET /_nodes/stats/<metric>/<index_metric>

GET /_nodes/<node_id>/stats/<metric>/<index_metric>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Description

edit

You can use the cluster nodes stats API to retrieve statistics for nodes in a cluster.

All the nodes selective options are explained here.

By default, all stats are returned. You can limit the returned information by using metrics.

Path parameters

edit

<metric>

(Optional, string) Limits the information returned to the specific metrics. A comma-separated list of the following options:

adaptive_selection: Statistics about adaptive replica selection.
breaker: Statistics about the field data circuit breaker.
discovery: Statistics about the discovery.
fs: File system information, data path, free disk space, read/write stats.
http: HTTP connection information.
indexing_pressure: Statistics about the node’s indexing load and related rejections.
indices: Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.
ingest: Statistics about ingest preprocessing.
jvm: JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.
os: Operating system stats, load average, mem, swap.
process: Process statistics, memory consumption, cpu usage, open file descriptors.
thread_pool: Statistics about each thread pool, including current size, queue and rejected tasks.
transport: Transport statistics about sent and received bytes in cluster communication.

<index_metric>

(Optional, string) 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 metrics are:

bulk
completion
docs
fielddata
flush
get
indexing
mappings
merge
query_cache
recovery
refresh
request_cache
search
segments
shard_stats
store
translog
warmer

<node_id>

(Optional, string) Comma-separated list of node IDs or names used to limit returned information.

Query parameters

edit

completion_fields

(Optional, string) Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

fielddata_fields

(Optional, string) Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

fields

(Optional, string) Comma-separated list or wildcard expressions of fields to include in the statistics.

Used as the default list unless a specific field list is provided in the completion_fields or fielddata_fields parameters.

groups

(Optional, string) Comma-separated list of search groups to include in the search statistics.

level

(Optional, string) Indicates whether statistics are aggregated at the cluster, index, or shard level.

Valid values are:

cluster
indices
shards

types

(Optional, string) A comma-separated list of document types for the indexing index metric.

master_timeout

(Optional, time units) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

timeout

(Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

include_segment_file_sizes

(Optional, Boolean) If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). Defaults to false.

include_unloaded_segments

(Optional, Boolean) If true, the response includes information from segments that are not loaded into memory. Defaults to false.

Response body

edit

_nodes

(object) Contains statistics about the number of nodes selected by the request.

Properties of _nodes

total: (integer) Total number of nodes selected by the request.
successful: (integer) Number of nodes that responded successfully to the request.
failed: (integer) Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.

cluster_name

(string) Name of the cluster. Based on the Cluster name setting setting.

nodes

(object) Contains statistics for the nodes selected by the request.

Properties of nodes

<node_id>

(object) Contains statistics for the node.

Properties of <node_id>

timestamp: (integer) Time the node stats were collected for this response. Recorded in milliseconds since the Unix Epoch.
name: (string) Human-readable identifier for the node. Based on the Node name setting setting.
transport_address: (string) Host and port for the transport layer, used for internal communication between nodes in a cluster.
host: (string) Network host for the node, based on the Network host setting setting.
ip: (string) IP address and port for the node.
roles: (array of strings) Roles assigned to the node. See Node.
attributes: (object) Contains a list of attributes for the node.

indices

(object) Contains statistics about indices with shards assigned to the node.

Properties of indices

docs

(object) Contains statistics about documents across all primary shards assigned to the node.

Properties of docs

count: (integer) The number of documents as reported by Lucene. This excludes deleted documents and counts any nested documents separately from their parents. It also excludes documents which were indexed recently and do not yet belong to a segment.
deleted: (integer) The number of deleted documents as reported by Lucene, which may be higher or lower than the number of delete operations you have performed. This number excludes deletes that were performed recently and do not yet belong to a segment. Deleted documents are cleaned up by the automatic merge process if it makes sense to do so. Also, Elasticsearch creates extra deleted documents to internally track the recent history of operations on a shard.

store

(object) Contains statistics about the size of shards assigned to the node.

Properties of store

size: (byte value) Total size of all shards assigned to the node.
size_in_bytes: (integer) Total size, in bytes, of all shards assigned to the node.
total_data_set_size: (byte value) 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.
total_data_set_size_in_bytes: (integer) Total data set size, in bytes, 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.
reserved: (byte value) 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 -1b indicates that this is not available.
reserved_in_bytes: (integer) A prediction, in bytes, 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.

indexing

(object) Contains statistics about indexing operations for the node.

Properties of indexing

index_total: (integer) Total number of indexing operations.
index_time: (time value) Total time spent performing indexing operations.
index_time_in_millis: (integer) Total time in milliseconds spent performing indexing operations.
index_current: (integer) Number of indexing operations currently running.
index_failed: (integer) Number of failed indexing operations.
delete_total: (integer) Total number of deletion operations.
delete_time: (time value) Time spent performing deletion operations.
delete_time_in_millis: (integer) Time in milliseconds spent performing deletion operations.
delete_current: (integer) Number of deletion operations currently running.
noop_update_total: (integer) Total number of noop operations.
is_throttled: (Boolean) Number of times operations were throttled.
throttle_time: (time value) Total time spent throttling operations.
throttle_time_in_millis: (integer) Total time in milliseconds spent throttling operations.

get

(object) Contains statistics about get operations for the node.

Properties of get

total: (integer) Total number of get operations.
getTime: (time value) Time spent performing get operations.
time_in_millis: (integer) Time in milliseconds spent performing get operations.
exists_total: (integer) Total number of successful get operations.
exists_time: (time value) Time spent performing successful get operations.
exists_time_in_millis: (integer) Time in milliseconds spent performing successful get operations.
missing_total: (integer) Total number of failed get operations.
missing_time: (time value) Time spent performing failed get operations.
missing_time_in_millis: (integer) Time in milliseconds spent performing failed get operations.
current: (integer) Number of get operations currently running.

search

(object) Contains statistics about search operations for the node.

Properties of search

open_contexts: (integer) Number of open search contexts.
query_total: (integer) Total number of query operations.
query_time: (time value) Time spent performing query operations.
query_time_in_millis: (integer) Time in milliseconds spent performing query operations.
query_current: (integer) Number of query operations currently running.
fetch_total: (integer) Total number of fetch operations.
fetch_time: (time value) Time spent performing fetch operations.
fetch_time_in_millis: (integer) Time in milliseconds spent performing fetch operations.
fetch_current: (integer) Number of fetch operations currently running.
scroll_total: (integer) Total number of scroll operations.
scroll_time: (time value) Time spent performing scroll operations.
scroll_time_in_millis: (integer) Time in milliseconds spent performing scroll operations.
scroll_current: (integer) Number of scroll operations currently running.
suggest_total: (integer) Total number of suggest operations.
suggest_time: (time value) Time spent performing suggest operations.
suggest_time_in_millis: (integer) Time in milliseconds spent performing suggest operations.
suggest_current: (integer) Number of suggest operations currently running.

merges

(object) Contains statistics about merge operations for the node.

Properties of merges

current: (integer) Number of merge operations currently running.
current_docs: (integer) Number of document merges currently running.
current_size: (byte value) Memory used performing current document merges.
current_size_in_bytes: (integer) Memory, in bytes, used performing current document merges.
total: (integer) Total number of merge operations.
total_time: (time value) Total time spent performing merge operations.
total_time_in_millis: (integer) Total time in milliseconds spent performing merge operations.
total_docs: (integer) Total number of merged documents.
total_size: (byte value) Total size of document merges.
total_size_in_bytes: (integer) Total size of document merges in bytes.
total_stopped_time: (time value) Total time spent stopping merge operations.
total_stopped_time_in_millis: (integer) Total time in milliseconds spent stopping merge operations.
total_throttled_time: (time value) Total time spent throttling merge operations.
total_throttled_time_in_millis: (integer) Total time in milliseconds spent throttling merge operations.
total_auto_throttle: (byte value) Size of automatically throttled merge operations.
total_auto_throttle_in_bytes: (integer) Size, in bytes, of automatically throttled merge operations.

refresh

(object) Contains statistics about refresh operations for the node.

Properties of refresh

total: (integer) Total number of refresh operations.
total_time: (time value) Total time spent performing refresh operations.
total_time_in_millis: (integer) Total time in milliseconds spent performing refresh operations.
external_total: (integer) Total number of external refresh operations.
external_total_time: (time value) Total time spent performing external operations.
external_total_time_in_millis: (integer) Total time in milliseconds spent performing external operations.
listeners: (integer) Number of refresh listeners.

flush

(object) Contains statistics about flush operations for the node.

Properties of flush

total: (integer) Number of flush operations.
periodic: (integer) Number of flush periodic operations.
total_time: (time value) Total time spent performing flush operations.
total_time_in_millis: (integer) Total time in milliseconds spent performing flush operations.

warmer

(object) Contains statistics about index warming operations for the node.

Properties of warmer

current: (integer) Number of active index warmers.
total: (integer) Total number of index warmers.
total_time: (time value) Total time spent performing index warming operations.
total_time_in_millis: (integer) Total time in milliseconds spent performing index warming operations.

query_cache

(object) Contains statistics about the query cache across all shards assigned to the node.

Properties of query_cache

memory_size: (byte value) Total amount of memory used for the query cache across all shards assigned to the node.
memory_size_in_bytes: (integer) Total amount of memory, in bytes, used for the query cache across all shards assigned to the node.
total_count: (integer) Total count of hits, misses, and cached queries in the query cache.
hit_count: (integer) Number of query cache hits.
miss_count: (integer) Number of query cache misses.
cache_size: (integer) Size, in bytes, of the query cache.
cache_count: (integer) Count of queries in the query cache.
evictions: (integer) Number of query cache evictions.

fielddata

(object) Contains statistics about the field data cache across all shards assigned to the node.

Properties of fielddata

memory_size: (byte value) Total amount of memory used for the field data cache across all shards assigned to the node.
memory_size_in_bytes: (integer) Total amount of memory, in bytes, used for the field data cache across all shards assigned to the node.
evictions: (integer) Number of fielddata evictions.

completion

(object) Contains statistics about completions across all shards assigned to the node.

Properties of completion

size: (byte value) Total amount of memory used for completion across all shards assigned to the node.
size_in_bytes: (integer) Total amount of memory, in bytes, used for completion across all shards assigned to the node.

segments

(object) Contains statistics about segments across all shards assigned to the node.

Properties of segments

count

(integer) Number of segments.

memory

(byte value) Total amount of memory used for segments across all shards assigned to the node.

memory_in_bytes

(integer) Total amount of memory, in bytes, used for segments across all shards assigned to the node.

terms_memory

(byte value) Total amount of memory used for terms across all shards assigned to the node.

terms_memory_in_bytes

(integer) Total amount of memory, in bytes, used for terms across all shards assigned to the node.

stored_fields_memory

(byte value) Total amount of memory used for stored fields across all shards assigned to the node.

stored_fields_memory_in_bytes

(integer) Total amount of memory, in bytes, used for stored fields across all shards assigned to the node.

term_vectors_memory

(byte value) Total amount of memory used for term vectors across all shards assigned to the node.

term_vectors_memory_in_bytes

(integer) Total amount of memory, in bytes, used for term vectors across all shards assigned to the node.

norms_memory

(byte value) Total amount of memory used for normalization factors across all shards assigned to the node.

norms_memory_in_bytes

(integer) Total amount of memory, in bytes, used for normalization factors across all shards assigned to the node.

points_memory

(byte value) Total amount of memory used for points across all shards assigned to the node.

points_memory_in_bytes

(integer) Total amount of memory, in bytes, used for points across all shards assigned to the node.

doc_values_memory

(byte value) Total amount of memory used for doc values across all shards assigned to the node.

doc_values_memory_in_bytes

(integer) Total amount of memory, in bytes, used for doc values across all shards assigned to the node.

index_writer_memory

(byte value) Total amount of memory used by all index writers across all shards assigned to the node.

index_writer_memory_in_bytes

(integer) Total amount of memory, in bytes, used by all index writers across all shards assigned to the node.

version_map_memory

(byte value) Total amount of memory used by all version maps across all shards assigned to the node.

version_map_memory_in_bytes

(integer) Total amount of memory, in bytes, used by all version maps across all shards assigned to the node.

fixed_bit_set

(byte value) Total amount of memory used by fixed bit sets across all shards assigned to the node.

Fixed bit sets are used for nested object field types and type filters for join fields.

fixed_bit_set_memory_in_bytes

(integer) Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to the node.

Fixed bit sets are used for nested object field types and type filters for join fields.

max_unsafe_auto_id_timestamp

(integer) Time of the most recently retried indexing request. Recorded in milliseconds since the Unix Epoch.

file_sizes

(object) Contains statistics about the size of the segment file.

Properties of file_sizes

size: (byte value) Size of the segment file.
size_in_bytes: (integer) Size, in bytes, of the segment file.
description: (string) Description of the segment file.

translog

(object) Contains statistics about transaction log operations for the node.

Properties of translog

operations: (integer) Number of transaction log operations.
size: (byte value) Size of the transaction log.
size_in_bytes: (integer) Size, in bytes, of the transaction log.
uncommitted_operations: (integer) Number of uncommitted transaction log operations.
uncommitted_size: (byte value) Size of uncommitted transaction log operations.
uncommitted_size_in_bytes: (integer) Size, in bytes, of uncommitted transaction log operations.
earliest_last_modified_age: (integer) Earliest last modified age for the transaction log.

request_cache

(object) Contains statistics about the request cache across all shards assigned to the node.

Properties of request_cache

memory_size: (byte value) Memory used by the request cache.
memory_size_in_bytes: (integer) Memory, in bytes, used by the request cache.
evictions: (integer) Number of request cache operations.
hit_count: (integer) Number of request cache hits.
miss_count: (integer) Number of request cache misses.

recovery

(object) Contains statistics about recovery operations for the node.

Properties of recovery

current_as_source: (integer) Number of recoveries that used an index shard as a source.
current_as_target: (integer) Number of recoveries that used an index shard as a target.
throttle_time: (time value) Time by which recovery operations were delayed due to throttling.
throttle_time_in_millis: (integer) Time in milliseconds recovery operations were delayed due to throttling.

shard_stats

(object) Contains statistics about all shards assigned to the node.

Properties of shard_stats

total_count: (integer) The total number of shards assigned to the node.

mappings

(object) Contains statistics about the mappings for the node. This is not shown for the shards level, since mappings may be shared across the shards of an index on a node.

Properties of mappings

total_count: (integer) Number of mappings, including runtime and object fields.
total_estimated_overhead: (byte value) Estimated heap overhead of mappings on this node, which allows for 1kiB of heap for every mapped field.
total_estimated_overhead_in_bytes: (integer) Estimated heap overhead, in bytes, of mappings on this node, which allows for 1kiB of heap for every mapped field.

os

(object) Contains statistics about the operating system for the node.

Properties of os

timestamp

(integer) Last time the operating system statistics were refreshed. Recorded in milliseconds since the Unix Epoch.

cpu

(object) Contains statistics about CPU usage for the node.

Properties of cpu

percent

(integer) Recent CPU usage for the whole system, or -1 if not supported.

load_average

(object) Contains statistics about load averages on the system.

Properties of load_average

1m: (float) One-minute load average on the system (field is not present if one-minute load average is not available).
5m: (float) Five-minute load average on the system (field is not present if five-minute load average is not available).
15m: (float) Fifteen-minute load average on the system (field is not present if fifteen-minute load average is not available).

mem

(object) Contains statistics about memory usage for the node.

Properties of mem

total: (byte value) Total amount of physical memory.
total_in_bytes: (integer) Total amount of physical memory in bytes.
adjusted_total: (byte value) If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value. Otherwise it reports the same value as total.
adjusted_total_in_bytes: (integer) If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. Otherwise it reports the same value as total_in_bytes.
free: (byte value) Amount of free physical memory.
free_in_bytes: (integer) Amount of free physical memory in bytes.
used: (byte value) Amount of used physical memory.
used_in_bytes: (integer) Amount of used physical memory in bytes.
free_percent: (integer) Percentage of free memory.
used_percent: (integer) Percentage of used memory.

swap

(object) Contains statistics about swap space for the node.

Properties of swap

total: (byte value) Total amount of swap space.
total_in_bytes: (integer) Total amount of swap space in bytes.
free: (byte value) Amount of free swap space.
free_in_bytes: (integer) Amount of free swap space in bytes.
used: (byte value) Amount of used swap space.
used_in_bytes: (integer) Amount of used swap space in bytes.

cgroup (Linux only)

(object) Contains cgroup statistics for the node.

For the cgroup stats to be visible, cgroups must be compiled into the kernel, the cpu and cpuacct cgroup subsystems must be configured and stats must be readable from /sys/fs/cgroup/cpu and /sys/fs/cgroup/cpuacct.

Properties of cgroup

cpuacct (Linux only)

(object) Contains statistics about cpuacct control group for the node.

Properties of cpuacct

control_group (Linux only): (string) The cpuacct control group to which the Elasticsearch process belongs.
usage_nanos (Linux only): (integer) The total CPU time (in nanoseconds) consumed by all tasks in the same cgroup as the Elasticsearch process.

cpu (Linux only)

(object) Contains statistics about cpu control group for the node.

Properties of cpu

control_group (Linux only)

(string) The cpu control group to which the Elasticsearch process belongs.

cfs_period_micros (Linux only)

(integer) 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_micros (Linux only)

(integer) 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.

stat (Linux only)

(object) Contains CPU statistics for the node.

Properties of stat

number_of_elapsed_periods (Linux only): (integer) The number of reporting periods (as specified by cfs_period_micros) that have elapsed.
number_of_times_throttled (Linux only): (integer) The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled.
time_throttled_nanos (Linux only): (integer) The total amount of time (in nanoseconds) for which all tasks in the same cgroup as the Elasticsearch process have been throttled.

memory (Linux only)

(object) Contains statistics about the memory control group for the node.

Properties of memory

control_group (Linux only): (string) The memory control group to which the Elasticsearch process belongs.
limit_in_bytes (Linux only): (string) 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 a long almost certainly means no limit has been set for the cgroup.
usage_in_bytes (Linux only): (string) The total current memory usage by processes in the cgroup (in bytes) by all tasks in the same cgroup as the Elasticsearch process. This value is stored as a string for consistency with limit_in_bytes.

process

(object) Contains process statistics for the node.

Properties of process

timestamp

(integer) Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch.

open_file_descriptors

(integer) Number of opened file descriptors associated with the current or -1 if not supported.

max_file_descriptors

(integer) Maximum number of file descriptors allowed on the system, or -1 if not supported.

cpu

(object) Contains CPU statistics for the node.

Properties of cpu

percent: (integer) CPU usage in percent, or -1 if not known at the time the stats are computed.
total: (time value) CPU time used by the process on which the Java virtual machine is running.
total_in_millis: (integer) CPU time (in milliseconds) used by the process on which the Java virtual machine is running, or -1 if not supported.

mem

(object) Contains virtual memory statistics for the node.

Properties of mem

total_virtual: (byte value) Size of virtual memory that is guaranteed to be available to the running process.
total_virtual_in_bytes: (integer) Size in bytes of virtual memory that is guaranteed to be available to the running process.

jvm

(object) Contains Java Virtual Machine (JVM) statistics for the node.

Properties of jvm

timestamp

(integer) Last time JVM statistics were refreshed.

uptime

(time value) Human-readable JVM uptime. Only returned if the human query parameter is true.

uptime_in_millis

(integer) JVM uptime in milliseconds.

mem

(object) Contains JVM memory usage statistics for the node.

Properties of mem

heap_used

(byte value) Memory currently in use by the heap.

heap_used_in_bytes

(integer) Memory, in bytes, currently in use by the heap.

heap_used_percent

(integer) Percentage of memory currently in use by the heap.

heap_committed

(byte value) Amount of memory available for use by the heap.

heap_committed_in_bytes

(integer) Amount of memory, in bytes, available for use by the heap.

heap_max

(byte value) Maximum amount of memory available for use by the heap.

heap_max_in_bytes

(integer) Maximum amount of memory, in bytes, available for use by the heap.

non_heap_used

(byte value) Non-heap memory used.

non_heap_used_in_bytes

(integer) Non-heap memory used, in bytes.

non_heap_committed

(byte value) Amount of non-heap memory available.

non_heap_committed_in_bytes

(integer) Amount of non-heap memory available, in bytes.

pools

(object) Contains statistics about heap memory usage for the node.

Properties of pools

young

(object) Contains statistics about memory usage by the young generation heap for the node.

Properties of young

used: (byte value) Memory used by the young generation heap.
used_in_bytes: (integer) Memory, in bytes, used by the young generation heap.
max: (byte value) Maximum amount of memory available for use by the young generation heap.
max_in_bytes: (integer) Maximum amount of memory, in bytes, available for use by the young generation heap.
peak_used: (byte value) Largest amount of memory historically used by the young generation heap.
peak_used_in_bytes: (integer) Largest amount of memory, in bytes, historically used by the young generation heap.
peak_max: (byte value) Largest amount of memory historically used by the young generation heap.
peak_max_in_bytes: (integer) Largest amount of memory, in bytes, historically used by the young generation heap.

survivor

(object) Contains statistics about memory usage by the survivor space for the node.

Properties of survivor

used: (byte value) Memory used by the survivor space.
used_in_bytes: (integer) Memory, in bytes, used by the survivor space.
max: (byte value) Maximum amount of memory available for use by the survivor space.
max_in_bytes: (integer) Maximum amount of memory, in bytes, available for use by the survivor space.
peak_used: (byte value) Largest amount of memory historically used by the survivor space.
peak_used_in_bytes: (integer) Largest amount of memory, in bytes, historically used by the survivor space.
peak_max: (byte value) Largest amount of memory historically used by the survivor space.
peak_max_in_bytes: (integer) Largest amount of memory, in bytes, historically used by the survivor space.

old

(object) Contains statistics about memory usage by the old generation heap for the node.

Properties of old

used: (byte value) Memory used by the old generation heap.
used_in_bytes: (integer) Memory, in bytes, used by the old generation heap.
max: (byte value) Maximum amount of memory available for use by the old generation heap.
max_in_bytes: (integer) Maximum amount of memory, in bytes, available for use by the old generation heap.
peak_used: (byte value) Largest amount of memory historically used by the old generation heap.
peak_used_in_bytes: (integer) Largest amount of memory, in bytes, historically used by the old generation heap.
peak_max: (byte value) Highest memory limit historically available for use by the old generation heap.
peak_max_in_bytes: (integer) Highest memory limit, in bytes, historically available for use by the old generation heap.

threads

(object) Contains statistics about JVM thread usage for the node.

Properties of threads

count: (integer) Number of active threads in use by JVM.
peak_count: (integer) Highest number of threads used by JVM.

gc

(object) Contains statistics about JVM garbage collectors for the node.

Properties of gc

collectors

(object) Contains statistics about JVM garbage collectors for the node.

Properties of collectors

young

(object) Contains statistics about JVM garbage collectors that collect young generation objects for the node.

Properties of young

collection_count: (integer) Number of JVM garbage collectors that collect young generation objects.
collection_time: (time value) Total time spent by JVM collecting young generation objects.
collection_time_in_millis: (integer) Total time in milliseconds spent by JVM collecting young generation objects.

old

(object) Contains statistics about JVM garbage collectors that collect old generation objects for the node.

Properties of old

collection_count: (integer) Number of JVM garbage collectors that collect old generation objects.
collection_time: (time value) Total time spent by JVM collecting old generation objects.
collection_time_in_millis: (integer) Total time in milliseconds spent by JVM collecting old generation objects.

buffer_pools

(object) Contains statistics about JVM buffer pools for the node.

Properties of buffer_pools

mapped

(object) Contains statistics about mapped JVM buffer pools for the node.

Properties of mapped

count: (integer) Number of mapped buffer pools.
used: (byte value) Size of mapped buffer pools.
used_in_bytes: (integer) Size, in bytes, of mapped buffer pools.
total_capacity: (byte value) Total capacity of mapped buffer pools.
total_capacity_in_bytes: (integer) Total capacity, in bytes, of mapped buffer pools.

direct

(object) Contains statistics about direct JVM buffer pools for the node.

Properties of direct

count: (integer) Number of direct buffer pools.
used: (byte value) Size of direct buffer pools.
used_in_bytes: (integer) Size, in bytes, of direct buffer pools.
total_capacity: (byte value) Total capacity of direct buffer pools.
total_capacity_in_bytes: (integer) Total capacity, in bytes, of direct buffer pools.

classes

(object) Contains statistics about classes loaded by JVM for the node.

Properties of classes

current_loaded_count: (integer) Number of classes currently loaded by JVM.
total_loaded_count: (integer) Total number of classes loaded since the JVM started.
total_unloaded_count: (integer) Total number of classes unloaded since the JVM started.

thread_pool

(object) Contains thread pool statistics for the node

Properties of thread_pool

<thread_pool_name>

(object) Contains statistics about the thread pool for the node.

Properties of <thread_pool_name>

threads: (integer) Number of threads in the thread pool.
queue: (integer) Number of tasks in queue for the thread pool.
active: (integer) Number of active threads in the thread pool.
rejected: (integer) Number of tasks rejected by the thread pool executor.
largest: (integer) Highest number of active threads in the thread pool.
completed: (integer) Number of tasks completed by the thread pool executor.

fs

(object) Contains file store statistics for the node.

Properties of fs

timestamp

(integer) Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch.

total

(object) Contains statistics for all file stores of the node.

Properties of total

total: (byte value) Total size of all file stores.
total_in_bytes: (integer) Total size (in bytes) of all file stores.
free: (byte value) Total unallocated disk space in all file stores.
free_in_bytes: (integer) Total number of unallocated bytes in all file stores.
available: (byte value) Total disk space available to this Java virtual machine on all file stores. 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.
available_in_bytes: (integer) Total number of bytes available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than free_in_bytes. This is the actual amount of free disk space the Elasticsearch node can utilise.

data

(array of objects) List of all file stores.

Properties of data

path: (string) Path to the file store.
mount: (string) Mount point of the file store (ex: /dev/sda2).
type: (string) Type of the file store (ex: ext4).
total: (byte value) Total size of the file store.
total_in_bytes: (integer) Total size (in bytes) of the file store.
free: (byte value) Total amount of unallocated disk space in the file store.
free_in_bytes: (integer) Total number of unallocated bytes in the file store.
available: (byte value) Total amount of disk space available to this Java virtual machine on this file store.
available_in_bytes: (integer) Total number of bytes available to this Java virtual machine on this file store.

io_stats (Linux only)

(objects) Contains I/O statistics for the node.

Properties of io_stats

devices (Linux only)

(array) 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.

Properties of devices

device_name (Linux only): (string) The Linux device name.
operations (Linux only): (integer) The total number of read and write operations for the device completed since starting Elasticsearch.
read_operations (Linux only): (integer) The total number of read operations for the device completed since starting Elasticsearch.
write_operations (Linux only): (integer) The total number of write operations for the device completed since starting Elasticsearch.
read_kilobytes (Linux only): (integer) The total number of kilobytes read for the device since starting Elasticsearch.
write_kilobytes (Linux only): (integer) The total number of kilobytes written for the device since starting Elasticsearch.
io_time_in_millis (Linux only): (integer) The total time in milliseconds spent performing I/O operations for the device since starting Elasticsearch.

operations (Linux only)

(integer) The total number of read and write operations across all devices used by Elasticsearch completed since starting Elasticsearch.

read_operations (Linux only)

(integer) The total number of read operations for across all devices used by Elasticsearch completed since starting Elasticsearch.

write_operations (Linux only)

(integer) The total number of write operations across all devices used by Elasticsearch completed since starting Elasticsearch.

read_kilobytes (Linux only)

(integer) The total number of kilobytes read across all devices used by Elasticsearch since starting Elasticsearch.

write_kilobytes (Linux only)

(integer) The total number of kilobytes written across all devices used by Elasticsearch since starting Elasticsearch.

io_time_in_millis (Linux only)

(integer) The total time in milliseconds spent performing I/O operations across all devices used by Elasticsearch since starting Elasticsearch.

transport

(object) Contains transport statistics for the node.

Properties of transport

server_open

(integer) Current number of inbound TCP connections used for internal communication between nodes.

total_outbound_connections

(integer) 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.

rx_count

(integer) Total number of RX (receive) packets received by the node during internal cluster communication.

rx_size

(byte value) Size of RX packets received by the node during internal cluster communication.

rx_size_in_bytes

(integer) Size, in bytes, of RX packets received by the node during internal cluster communication.

tx_count

(integer) Total number of TX (transmit) packets sent by the node during internal cluster communication.

tx_size

(byte value) Size of TX packets sent by the node during internal cluster communication.

tx_size_in_bytes

(integer) Size, in bytes, of TX packets sent by the node during internal cluster communication.

inbound_handling_time_histogram

(array) The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.

Properties of inbound_handling_time_histogram

ge_millis: (integer) The inclusive lower bound of the bucket in milliseconds. Omitted on the first bucket since this bucket has no lower bound.
lt_millis: (integer) The exclusive upper bound of the bucket in milliseconds. Omitted on the last bucket since this bucket has no upper bound.
count: (integer) The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.

outbound_handling_time_histogram

(array) The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.

Properties of outbound_handling_time_histogram

ge_millis: (integer) The inclusive lower bound of the bucket in milliseconds. Omitted on the first bucket since this bucket has no lower bound.
lt_millis: (integer) The exclusive upper bound of the bucket in milliseconds. Omitted on the last bucket since this bucket has no upper bound.
count: (integer) The number of times a transport thread took a period of time within the bounds of this bucket to send a transport message.

http

(object) Contains http statistics for the node.

Properties of http

current_open

(integer) Current number of open HTTP connections for the node.

total_opened

(integer) Total number of HTTP connections opened for the node.

clients

(array of objects) Information on current and recently-closed HTTP client connections. Clients that have been closed longer than the http.client_stats.closed_channels.max_age setting will not be represented here.

Properties of clients

id: (integer) Unique ID for the HTTP client.
agent: (string) Reported agent for the HTTP client. If unavailable, this property is not included in the response.
local_address: (string) Local address for the HTTP client.
remote_address: (string) Remote address for the HTTP client.
last_uri: (string) The URI of the client’s most recent request.
x_forwarded_for: (string) Value from the client’s x-forwarded-for HTTP header. If unavailable, this property is not included in the response.
x_opaque_id: (string) Value from the client’s x-opaque-id HTTP header. If unavailable, this property is not included in the response.
opened_time_millis: (integer) Time at which the client opened the connection.
closed_time_millis: (integer) Time at which the client closed the connection if the connection is closed.
last_request_time_millis: (integer) Time of the most recent request from this client.
request_count: (integer) Number of requests from this client.
request_size_bytes: (integer) Cumulative size in bytes of all requests from this client.

breakers

(object) Contains circuit breaker statistics for the node.

Properties of breakers

<circuit_breaker_name>

(object) Contains statistics for the circuit breaker.

Properties of <circuit_breaker_name>

limit_size_in_bytes: (integer) Memory limit, in bytes, for the circuit breaker.
limit_size: (byte value) Memory limit for the circuit breaker.
estimated_size_in_bytes: (integer) Estimated memory used, in bytes, for the operation.
estimated_size: (byte value) Estimated memory used for the operation.
overhead: (float) A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.
tripped: (integer) Total number of times the circuit breaker has been triggered and prevented an out of memory error.

script

(object) Contains script statistics for the node.

Properties of script

compilations: (integer) Total number of inline script compilations performed by the node.
compilations_history: (object) Contains this recent history of script compilations

Properties of compilations_history

5m: (long) The number of script compilations in the last five minutes.
15m: (long) The number of script compilations in the last fifteen minutes.
24h: (long) The number of script compilations in the last twenty-four hours.

cache_evictions: (integer) Total number of times the script cache has evicted old data.
cache_evictions_history: (object) Contains this recent history of script cache evictions

Properties of cache_evictions

5m: (long) The number of script cache evictions in the last five minutes.
15m: (long) The number of script cache evictions in the last fifteen minutes.
24h: (long) The number of script cache evictions in the last twenty-four hours.

compilation_limit_triggered: (integer) Total number of times the script compilation circuit breaker has limited inline script compilations.

discovery

(object) Contains node discovery statistics for the node.

Properties of discovery

cluster_state_queue

(object) Contains statistics for the cluster state queue of the node.

Properties of cluster_state_queue

total: (integer) Total number of cluster states in queue.
pending: (integer) Number of pending cluster states in queue.
committed: (integer) Number of committed cluster states in queue.

published_cluster_states

(object) Contains statistics for the published cluster states of the node.

Properties of published_cluster_states

full_states: (integer) Number of published cluster states.
incompatible_diffs: (integer) Number of incompatible differences between published cluster states.
compatible_diffs: (integer) Number of compatible differences between published cluster states.

cluster_state_update

(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 _time within 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 _time suffix are only returned if requested with the ?human=true query parameter.

Properties of cluster_state_update

unchanged

(object) Contains statistics about cluster state update attempts that did not change the cluster state.

Properties of unchanged

count: (long) The number of cluster state update attempts that did not change the cluster state since the node started.
computation_time: (time value) The cumulative amount of time spent computing no-op cluster state updates since the node started.
notification_time: (time value) The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started.

success

(object) Contains statistics about cluster state update attempts that successfully changed the cluster state.

Properties of success

count: (long) The number of cluster state update attempts that successfully changed the cluster state since the node started.
computation_time: (time value) The cumulative amount of time spent computing cluster state updates that were ultimately successful since the node started.
publication_time: (time value) The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (i.e. 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_time and master_apply_time.
context_construction_time: (time value) 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.
commit_time: (time value) 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.
completion_time: (time value) 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.
master_apply_time: (time value) The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started.
notification_time: (time value) The cumulative amount of time spent notifying listeners of a successful cluster state update since the node started.

failure

(object) Contains statistics about cluster state update attempts that did not successfully change the cluster state, typically because a new master node was elected before completion.

Properties of failure

count: (long) The number of cluster state update attempts that failed to change the cluster state since the node started.
computation_time: (time value) The cumulative amount of time spent computing cluster state updates that were ultimately unsuccessful since the node started.
publication_time: (time value) The cumulative amount of time spent publishing cluster state updates which ultimately failed, which includes everything from the start of the publication (i.e. 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_time and master_apply_time.
context_construction_time: (time value) The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately failed. This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.
commit_time: (time value) The cumulative amount of time spent waiting for an unsuccessful 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_time: (time value) The cumulative amount of time spent waiting for an unsuccessful 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_time: (time value) The cumulative amount of time spent unsuccessfully applying cluster state updates on the elected master since the node started.
notification_time: (time value) The cumulative amount of time spent notifying listeners of a failed cluster state update since the node started.

ingest

(object) Contains ingest statistics for the node.

Properties of ingest

total

(object) Contains statistics about ingest operations for the node.

Properties of total

count: (integer) Total number of documents ingested during the lifetime of this node.
time: (time value) Total time spent preprocessing ingest documents during the lifetime of this node.
time_in_millis: (integer) Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.
current: (integer) Total number of documents currently being ingested.
failed: (integer) Total number of failed ingest operations during the lifetime of this node.

pipelines

(object) Contains statistics about ingest pipelines for the node.

Properties of pipelines

<pipeline_id>

(object) Contains statistics about the ingest pipeline.

Properties of <pipeline_id>

count

(integer) Number of documents preprocessed by the ingest pipeline.

time

(time value) Total time spent preprocessing documents in the ingest pipeline.

time_in_millis

(integer) Total time, in milliseconds, spent preprocessing documents in the ingest pipeline.

failed

(integer) Total number of failed operations for the ingest pipeline.

processors

(array of objects) Contains statistics for the ingest processors for the ingest pipeline.

Properties of processors

<processor>

(object) Contains statistics for the ingest processor.

Properties of <processor>

count: (integer) Number of documents transformed by the processor.
time: (time value) Time spent by the processor transforming documents.
time_in_millis: (integer) Time, in milliseconds, spent by the processor transforming documents.
current: (integer) Number of documents currently being transformed by the processor.
failed: (integer) Number of failed operations for the processor.

indexing_pressure

(object) Contains indexing pressure statistics for the node.

Properties of indexing_pressure

memory

(object) Contains statistics for memory consumption from indexing load.

Properties of <memory>

current

(object) Contains statistics for current indexing load.

Properties of <current>

combined_coordinating_and_primary: (byte value) 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_bytes: (integer) 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.
coordinating: (byte value) Memory consumed by indexing requests in the coordinating stage.
coordinating_in_bytes: (integer) Memory consumed, in bytes, by indexing requests in the coordinating stage.
primary: (byte value) Memory consumed by indexing requests in the primary stage.
primary_in_bytes: (integer) Memory consumed, in bytes, by indexing requests in the primary stage.
replica: (byte value) Memory consumed by indexing requests in the replica stage.
replica_in_bytes: (integer) Memory consumed, in bytes, by indexing requests in the replica stage.
all: (byte value) Memory consumed by indexing requests in the coordinating, primary, or replica stage.
all_in_bytes: (integer) Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.

total

(object) Contains statistics for the cumulative indexing load since the node started.

Properties of <total>

combined_coordinating_and_primary: (byte value) 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_bytes: (integer) 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.
coordinating: (byte value) Memory consumed by indexing requests in the coordinating stage.
coordinating_in_bytes: (integer) Memory consumed, in bytes, by indexing requests in the coordinating stage.
primary: (byte value) Memory consumed by indexing requests in the primary stage.
primary_in_bytes: (integer) Memory consumed, in bytes, by indexing requests in the primary stage.
replica: (byte value) Memory consumed by indexing requests in the replica stage.
replica_in_bytes: (integer) Memory consumed, in bytes, by indexing requests in the replica stage.
all: (byte value) Memory consumed by indexing requests in the coordinating, primary, or replica stage.
all_in_bytes: (integer) Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.
coordinating_rejections: (integer) Number of indexing requests rejected in the coordinating stage.
primary_rejections: (integer) Number of indexing requests rejected in the primary stage.
replica_rejections: (integer) Number of indexing requests rejected in the replica stage.

limit

(byte value) Configured memory limit for the indexing requests. Replica requests have an automatic limit that is 1.5x this value.

limit_in_bytes

(integer) Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value.

adaptive_selection

(object) Contains adaptive selection statistics for the node.

Properties of adaptive_selection

outgoing_searches: (integer) The number of outstanding search requests from the node these stats are for to the keyed node.
avg_queue_size: (integer) The exponentially weighted moving average queue size of search requests on the keyed node.
avg_service_time: (time value) The exponentially weighted moving average service time of search requests on the keyed node.
avg_service_time_ns: (integer) The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.
avg_response_time: (time value) The exponentially weighted moving average response time of search requests on the keyed node.
avg_response_time_ns: (integer) The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.
rank: (string) The rank of this node; used for shard selection when routing search requests.

Examples

edit

# return just indices
GET /_nodes/stats/indices

# return just os and process
GET /_nodes/stats/os,process

# return just process for node with IP address 10.0.0.1
GET /_nodes/10.0.0.1/stats/process

All stats can be explicitly requested via /_nodes/stats/_all or /_nodes/stats?metric=_all.

You can get information about indices stats on node, indices, or shards level.

# Fielddata summarized by node
GET /_nodes/stats/indices/fielddata?fields=field1,field2

# Fielddata summarized by node and index
GET /_nodes/stats/indices/fielddata?level=indices&fields=field1,field2

# Fielddata summarized by node, index, and shard
GET /_nodes/stats/indices/fielddata?level=shards&fields=field1,field2

# You can use wildcards for field names
GET /_nodes/stats/indices/fielddata?fields=field*

You can get statistics about search groups for searches executed on this node.

# All groups with all stats
GET /_nodes/stats?groups=_all

# Some groups from just the indices stats
GET /_nodes/stats/indices?groups=foo,bar

Retrieve ingest statistics only

edit

To return only ingest-related node statistics, set the <metric> path parameter to ingest and use the filter_path query parameter.

GET /_nodes/stats/ingest?filter_path=nodes.*.ingest

You can use the metric and filter_path query parameters to get the same response.

GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest

To further refine the response, change the filter_path value. For example, the following request only returns ingest pipeline statistics.

GET /_nodes/stats?metric=ingest&filter_path=nodes.*.ingest.pipelines

« Nodes reload secure settings API Pending cluster tasks API »