Get node statistics

Auth

Get statistics for nodes in a cluster. By default, all stats are returned. You can limit the returned information by using metrics.

Required authorization

Cluster privileges monitor manage

Path parameters

node_id union string | string[] optional

Comma-separated list of node IDs or names used to limit returned information.

Leave it out to use /_nodes/stats.

metric union string | string[] optional

Limits the information returned to the specific metrics.

Leave it out to use /_nodes/stats.

index_metric union string | string[] 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.

Leave it out to use /_nodes/stats.

Query parameters

completion_fields union string | string[]

Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

fielddata_fields union string | string[]

Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

fields union string | string[]

Comma-separated list or wildcard expressions of fields to include in the statistics.

groups boolean

Comma-separated list of search groups to include in the search statistics.

include_segment_file_sizes boolean · 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).

level enum · default: node

Indicates whether statistics are aggregated at the node, indices, or shards level.

Values: cluster indices shards
timeout string · default: 30s

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

types string[]

A comma-separated list of document types for the indexing index metric.

include_unloaded_segments boolean · default: false

If true, the response includes information from segments that are not loaded into memory.

Response

application/json
_nodes object

Contains statistics about the number of nodes selected by the request’s node filters.

failures object[]
type string required

The type of error

reason union string nullable

A human-readable explanation of the error, in English.

One of: string
stack_trace string

The server stack trace. Present only if the error_trace=true parameter was sent with the request.

caused_by object
Same fields as failures in _nodes
root_cause object[]
Same fields as failures in _nodes
suppressed object[]
Same fields as failures in _nodes
total number required

Total number of nodes selected by the request.

successful number required

Number of nodes that responded successfully to the request.

failed number required

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
nodes map string to object required
<string> object
adaptive_selection map string to object

Statistics about adaptive replica selection.

<string> object
avg_queue_size number

The exponentially weighted moving average queue size of search requests on the keyed node.

avg_response_time string

The exponentially weighted moving average response time of search requests on the keyed node.

avg_response_time_ns number

The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.

avg_service_time string

The exponentially weighted moving average service time of search requests on the keyed node.

avg_service_time_ns number

The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.

outgoing_searches number

The number of outstanding search requests to the keyed node from the node these stats are for.

rank string

The rank of this node; used for shard selection when routing search requests.

allocations object

Statistics about shard allocations on the node.

shards number

Number of shards allocated to the node.

undesired_shards number

Number of shards allocated to the node that are currently undesired.

forecasted_ingest_load number

Forecasted ingest load for the node.

forecasted_disk_usage_in_bytes number

Forecasted disk usage, in bytes, for the node.

current_disk_usage_in_bytes number

Current disk usage, in bytes, for the node.

breakers map string to object

Statistics about the field data circuit breaker.

<string> object
estimated_size string

Estimated memory used for the operation.

estimated_size_in_bytes number

Estimated memory used, in bytes, for the operation.

limit_size string

Memory limit for the circuit breaker.

limit_size_in_bytes number

Memory limit, in bytes, for the circuit breaker.

overhead number

A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.

tripped number

Total number of times the circuit breaker has been triggered and prevented an out of memory error.

fs object

File system information, data path, free disk space, read/write stats.

data object[]

List of all file stores.

available string

Total amount of disk space available to this Java virtual machine on this file store.

available_in_bytes number

Total number of bytes available to this Java virtual machine on this file store.

disk_queue string
disk_reads number
disk_read_size string
disk_read_size_in_bytes number
disk_writes number
disk_write_size string
disk_write_size_in_bytes number
free string

Total amount of unallocated disk space in the file store.

free_in_bytes number

Total number of unallocated bytes in the file store.

mount string

Mount point of the file store (for example: /dev/sda2).

path string

Path to the file store.

total string

Total size of the file store.

total_in_bytes number

Total size of the file store in bytes.

type string

Type of the file store (ex: ext4).

timestamp number

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.

available string

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 number

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.

free string

Total unallocated disk space in all file stores.

free_in_bytes number

Total number of unallocated bytes in all file stores.

total string

Total size of all file stores.

total_in_bytes number

Total size of all file stores in bytes.

io_stats object

Contains I/O statistics for the node.

devices object[]

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.

device_name string

The Linux device name.

operations number

The total number of read and write operations for the device completed since starting Elasticsearch.

read_kilobytes number

The total number of kilobytes read for the device since starting Elasticsearch.

read_operations number

The total number of read operations for the device completed since starting Elasticsearch.

write_kilobytes number

The total number of kilobytes written for the device since starting Elasticsearch.

write_operations number

The total number of write operations for the device completed since starting Elasticsearch.

total object

The sum of the disk metrics for all devices that back an Elasticsearch data path.

device_name string

The Linux device name.

operations number

The total number of read and write operations for the device completed since starting Elasticsearch.

read_kilobytes number

The total number of kilobytes read for the device since starting Elasticsearch.

read_operations number

The total number of read operations for the device completed since starting Elasticsearch.

write_kilobytes number

The total number of kilobytes written for the device since starting Elasticsearch.

write_operations number

The total number of write operations for the device completed since starting Elasticsearch.

host string

Network host for the node, based on the network host setting.

http object

HTTP connection information.

current_open number

Current number of open HTTP connections for the node.

total_opened number

Total number of HTTP connections opened for the node.

clients object[]

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.

id number

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 connection.

remote_address string

Remote address for the HTTP connection.

last_uri string

The URI of the client’s most recent request.

opened_time_millis number

Time at which the client opened the connection.

closed_time_millis number

Time at which the client closed the connection if the connection is closed.

last_request_time_millis number

Time of the most recent request from this client.

request_count number

Number of requests from this client.

request_size_bytes number

Cumulative size in bytes of all requests from this client.

x_opaque_id string

Value from the client’s x-opaque-id HTTP header. If unavailable, this property is not included in the response.

routes map string to object required

Detailed HTTP stats broken down by route

<string> object
requests object required
count number required
total_size_in_bytes number required
size_histogram object[] required
count number required
ge_bytes number
lt_bytes number
responses object required
count number required
total_size_in_bytes number required
handling_time_histogram object[] required
count number required
ge_millis number
lt_millis number
size_histogram object[] required
count number required
ge_bytes number
lt_bytes number
ingest object

Statistics about ingest preprocessing.

pipelines map string to object

Contains statistics about ingest pipelines for the node.

<string> object
count number required

Total number of documents ingested during the lifetime of this node.

current number required

Total number of documents currently being ingested.

failed number required

Total number of failed ingest operations during the lifetime of this node.

processors string to object[] required

Total number of ingest processors.

time_in_millis number required

Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.

ingested_as_first_pipeline_in_bytes number required

Total number of bytes of all documents ingested by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors.

produced_as_first_pipeline_in_bytes number required

Total number of bytes of all documents produced by the pipeline. This field is only present on pipelines which are the first to process a document. Thus, it is not present on pipelines which only serve as a final pipeline after a default pipeline, a pipeline run after a reroute processor, or pipelines in pipeline processors. In situations where there are subsequent pipelines, the value represents the size of the document after all pipelines have run.

total object

Contains statistics about ingest operations for the node.

count number required

Total number of documents ingested during the lifetime of this node.

current number required

Total number of documents currently being ingested.

failed number required

Total number of failed ingest operations during the lifetime of this node.

time_in_millis number required

Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.

ip union string | string[]

IP address and port for the node.

jvm object

JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.

buffer_pools map string to object

Contains statistics about JVM buffer pools for the node.

<string> object
count number

Number of buffer pools.

total_capacity string

Total capacity of buffer pools.

total_capacity_in_bytes number

Total capacity of buffer pools in bytes.

used string

Size of buffer pools.

used_in_bytes number

Size of buffer pools in bytes.

classes object

Contains statistics about classes loaded by JVM for the node.

current_loaded_count number

Number of classes currently loaded by JVM.

total_loaded_count number

Total number of classes loaded since the JVM started.

total_unloaded_count number

Total number of classes unloaded since the JVM started.

gc object

Contains statistics about JVM garbage collectors for the node.

collectors map string to object

Contains statistics about JVM garbage collectors for the node.

<string> object
collection_count number

Total number of JVM garbage collectors that collect objects.

collection_time string

Total time spent by JVM collecting objects.

collection_time_in_millis number

Total time, in milliseconds, spent by JVM collecting objects.

mem object

Contains JVM memory usage statistics for the node.

heap_used_in_bytes number

Memory, in bytes, currently in use by the heap.

heap_used_percent number

Percentage of memory currently in use by the heap.

heap_committed_in_bytes number

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

heap_max_in_bytes number

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

heap_max number | string

Maximum amount of memory, available for use by the heap.

non_heap_used_in_bytes number

Non-heap memory used, in bytes.

non_heap_committed_in_bytes number

Amount of non-heap memory available, in bytes.

pools map string to object

Contains statistics about heap memory usage for the node.

<string> object
used_in_bytes number

Memory, in bytes, used by the heap.

max_in_bytes number

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

peak_used_in_bytes number

Largest amount of memory, in bytes, historically used by the heap.

peak_max_in_bytes number

Largest amount of memory, in bytes, historically used by the heap.

threads object

Contains statistics about JVM thread usage for the node.

count number

Number of active threads in use by JVM.

peak_count number

Highest number of threads used by JVM.

timestamp number

Last time JVM statistics were refreshed.

uptime string

Human-readable JVM uptime. Only returned if the human query parameter is true.

uptime_in_millis number

JVM uptime in milliseconds.

name string

Human-readable identifier for the node. Based on the node name setting.

os object

Operating system stats, load average, mem, swap.

cpu object
percent number
sys string
sys_in_millis number
total string
total_in_millis number
user string
user_in_millis number
load_average map string to number
mem object
adjusted_total_in_bytes number

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.

resident string
resident_in_bytes number
share string
share_in_bytes number
total_virtual string
total_virtual_in_bytes number
total_in_bytes number

Total amount of physical memory in bytes.

free_in_bytes number

Amount of free physical memory in bytes.

used_in_bytes number

Amount of used physical memory in bytes.

free_percent number

Percentage of free memory.

used_percent number

Percentage of used memory.

swap object
adjusted_total_in_bytes number

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.

resident string
resident_in_bytes number
share string
share_in_bytes number
total_virtual string
total_virtual_in_bytes number
total_in_bytes number

Total amount of physical memory in bytes.

free_in_bytes number

Amount of free physical memory in bytes.

used_in_bytes number

Amount of used physical memory in bytes.

cgroup object
cpuacct object

Contains statistics about cpuacct control group for the node.

control_group string

The cpuacct control group to which the Elasticsearch process belongs.

usage_nanos number

The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process.

cpu object

Contains statistics about cpu control group for the node.

control_group string

The cpu control group to which the Elasticsearch process belongs.

cfs_period_micros number

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 number

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 object

Contains CPU statistics for the node.

number_of_elapsed_periods number

The number of reporting periods (as specified by cfs_period_micros) that have elapsed.

number_of_times_throttled number

The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled.

time_throttled_nanos number

The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled.

memory object

Contains statistics about the memory control group for the node.

control_group string

The memory control group to which the Elasticsearch process belongs.

limit_in_bytes 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 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.

timestamp number
process object

Process statistics, memory consumption, cpu usage, open file descriptors.

cpu object

Contains CPU statistics for the node.

percent number
sys string
sys_in_millis number
total string
total_in_millis number
user string
user_in_millis number
load_average map string to number
mem object

Contains virtual memory statistics for the node.

Same fields as swap in os
open_file_descriptors number

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

max_file_descriptors number

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

timestamp number

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

roles enum[]

Roles assigned to the node.

Values: master data data_cold data_content data_frozen data_hot data_warm client ingest ml voting_only transform remote_cluster_client coordinating_only
script object

Contains script statistics for the node.

cache_evictions number

Total number of times the script cache has evicted old data.

compilations number

Total number of inline script compilations performed by the node.

compilations_history map string to number

Contains this recent history of script compilations.

compilation_limit_triggered number

Total number of times the script compilation circuit breaker has limited inline script compilations.

contexts object[]
context string
compilations number
cache_evictions number
compilation_limit_triggered number
script_cache map string to oneOf
thread_pool map string to object

Statistics about each thread pool, including current size, queue and rejected tasks.

<string> object
active number

Number of active threads in the thread pool.

completed number

Number of tasks completed by the thread pool executor.

largest number

Highest number of active threads in the thread pool.

queue number

Number of tasks in queue for the thread pool.

rejected number

Number of tasks rejected by the thread pool executor.

threads number

Number of threads in the thread pool.

timestamp number
transport object

Transport statistics about sent and received bytes in cluster communication.

inbound_handling_time_histogram object[]

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

count number

The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.

lt_millis number

The exclusive upper bound of the bucket in milliseconds. May be omitted on the last bucket if this bucket has no upper bound.

ge_millis number

The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound.

outbound_handling_time_histogram object[]

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

count number

The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.

lt_millis number

The exclusive upper bound of the bucket in milliseconds. May be omitted on the last bucket if this bucket has no upper bound.

ge_millis number

The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound.

rx_count number

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

rx_size string

Size of RX packets received by the node during internal cluster communication.

rx_size_in_bytes number

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

server_open number

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

tx_count number

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

tx_size string

Size of TX packets sent by the node during internal cluster communication.

tx_size_in_bytes number

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

total_outbound_connections number

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.

transport_address string

Host and port for the transport layer, used for internal communication between nodes in a cluster.

attributes map string to string

Contains a list of attributes for the node.

discovery object

Contains node discovery statistics for the node.

cluster_state_queue object

Contains statistics for the cluster state queue of the node.

total number

Total number of cluster states in queue.

pending number

Number of pending cluster states in queue.

committed number

Number of committed cluster states in queue.

published_cluster_states object

Contains statistics for the published cluster states of the node.

full_states number

Number of published cluster states.

incompatible_diffs number

Number of incompatible differences between published cluster states.

compatible_diffs number

Number of compatible differences between published cluster states.

cluster_state_update map 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 _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.

<string> object
count number required

The number of cluster state update attempts that did not change the cluster state since the node started.

computation_time string

The cumulative amount of time spent computing no-op cluster state updates since the node started.

computation_time_millis number

The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started.

publication_time string

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_time and master_apply_time.

publication_time_millis number

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_time and master_apply_time.

context_construction_time string

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.

context_construction_time_millis number

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_time string

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.

commit_time_millis number

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_time string

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.

completion_time_millis number

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_time string

The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started.

master_apply_time_millis number

The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started.

notification_time string

The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started.

notification_time_millis number

The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started.

serialized_cluster_states object
full_states object

Number of published cluster states.

count number
uncompressed_size string
uncompressed_size_in_bytes number
compressed_size string
compressed_size_in_bytes number
diffs object
count number
uncompressed_size string
uncompressed_size_in_bytes number
compressed_size string
compressed_size_in_bytes number
cluster_applier_stats object
recordings object[]
name string
cumulative_execution_count number
cumulative_execution_time string
cumulative_execution_time_millis number
indexing_pressure object

Contains indexing pressure statistics for the node.

memory object

Contains statistics for memory consumption from indexing load.

limit number | string

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

limit_in_bytes number

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

current object

Contains statistics for current indexing load.

all number | string

Memory consumed by indexing requests in the coordinating, primary, or replica stage.

all_in_bytes number

Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.

combined_coordinating_and_primary number | 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_bytes number

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 number | string

Memory consumed by indexing requests in the coordinating stage.

coordinating_in_bytes number

Memory consumed, in bytes, by indexing requests in the coordinating stage.

primary number | string

Memory consumed by indexing requests in the primary stage.

primary_in_bytes number

Memory consumed, in bytes, by indexing requests in the primary stage.

replica number | string

Memory consumed by indexing requests in the replica stage.

replica_in_bytes number

Memory consumed, in bytes, by indexing requests in the replica stage.

coordinating_rejections number

Number of indexing requests rejected in the coordinating stage.

primary_rejections number

Number of indexing requests rejected in the primary stage.

replica_rejections number

Number of indexing requests rejected in the replica stage.

primary_document_rejections number
large_operation_rejections number
total object

Contains statistics for the cumulative indexing load since the node started.

Same fields as current in memory
indices object

Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.

commit object
generation number required
id string required
num_docs number required
user_data map string to string required
completion object
size_in_bytes number required

Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.

size number | string

Total amount of memory used for completion across all shards assigned to selected nodes.

fields map string to object
<string> object
size number | string
size_in_bytes number required
docs object
count number required

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.

deleted number

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.

total_size_in_bytes number required

Returns the total size in bytes of all documents in this stats. This value may be more reliable than store_stats.size_in_bytes in estimating the index size.

total_size number | string

Human readable total_size_in_bytes

fielddata object
evictions number
memory_size number | string
memory_size_in_bytes number required
fields map string to object
<string> object
memory_size number | string
memory_size_in_bytes number required
global_ordinals object required
build_time_in_millis number required
build_time string
fields map string to object
<string> object
build_time_in_millis number required
build_time string
shard_max_value_count number required
flush object
periodic number required
total number required
total_time string
total_time_in_millis number required
get object
current number required
exists_time string
exists_time_in_millis number required
exists_total number required
missing_time string
missing_time_in_millis number required
missing_total number required
time string
time_in_millis number required
total number required
indexing object
index_current number required
delete_current number required
delete_time string
delete_time_in_millis number required
delete_total number required
is_throttled boolean required
noop_update_total number required
throttle_time string
throttle_time_in_millis number required
index_time string
index_time_in_millis number required
index_total number required
index_failed number required
types map string to object
write_load number
mappings object
total_count number required
total_estimated_overhead number | string
total_estimated_overhead_in_bytes number required
merges object
current number required
current_docs number required
current_size string
current_size_in_bytes number required
total number required
total_auto_throttle string
total_auto_throttle_in_bytes number required
total_docs number required
total_size string
total_size_in_bytes number required
total_stopped_time string
total_stopped_time_in_millis number required
total_throttled_time string
total_throttled_time_in_millis number required
total_time string
total_time_in_millis number required
shard_path object
data_path string required
is_custom_data_path boolean required
state_path string required
query_cache object
cache_count number required
cache_size number required
evictions number required
hit_count number required
memory_size_in_bytes number required
miss_count number required
total_count number required
recovery object
current_as_source number required
current_as_target number required
throttle_time string
throttle_time_in_millis number required
refresh object
external_total number required
external_total_time_in_millis number required
listeners number required
total number required
total_time string
total_time_in_millis number required
request_cache object
evictions number required
hit_count number required
memory_size string
memory_size_in_bytes number required
miss_count number required
retention_leases object
primary_term number required
version number required
leases object[] required
id string required
retaining_seq_no number required
timestamp number required
source string required
routing object
node string required
primary boolean required
relocating_node union string nullable
One of: string
state enum required
Values: UNASSIGNED INITIALIZING STARTED RELOCATING
fetch_current number required
fetch_time string
fetch_time_in_millis number required
fetch_total number required
open_contexts number
query_current number required
query_time string
query_time_in_millis number required
query_total number required
scroll_current number required
scroll_time string
scroll_time_in_millis number required
scroll_total number required
suggest_current number required
suggest_time string
suggest_time_in_millis number required
suggest_total number required
groups map string to object
segments object
count number required

Total number of segments across all shards assigned to selected nodes.

doc_values_memory number | string

Total amount of memory used for doc values across all shards assigned to selected nodes.

doc_values_memory_in_bytes number required

Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.

file_sizes map string to object required

This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.

<string> object
description string required
size_in_bytes number required
min_size_in_bytes number
max_size_in_bytes number
average_size_in_bytes number
count number
fixed_bit_set number | 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_bytes number required

Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.

index_writer_memory number | string

Total amount of memory used by all index writers across all shards assigned to selected nodes.

index_writer_memory_in_bytes number required

Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.

max_unsafe_auto_id_timestamp number required

Unix timestamp, in milliseconds, of the most recently retried indexing request.

memory number | string

Total amount of memory used for segments across all shards assigned to selected nodes.

memory_in_bytes number required

Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.

norms_memory number | string

Total amount of memory used for normalization factors across all shards assigned to selected nodes.

norms_memory_in_bytes number required

Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.

points_memory number | string

Total amount of memory used for points across all shards assigned to selected nodes.

points_memory_in_bytes number required

Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.

stored_fields_memory_in_bytes number required

Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.

stored_fields_memory number | string

Total amount of memory used for stored fields across all shards assigned to selected nodes.

terms_memory_in_bytes number required

Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.

terms_memory number | string

Total amount of memory used for terms across all shards assigned to selected nodes.

term_vectors_memory number | string

Total amount of memory used for term vectors across all shards assigned to selected nodes.

term_vectors_memory_in_bytes number required

Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.

version_map_memory number | string

Total amount of memory used by all version maps across all shards assigned to selected nodes.

version_map_memory_in_bytes number required

Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.

seq_no object
global_checkpoint number required
local_checkpoint number required
max_seq_no number required
store object
size number | string

Total size of all shards assigned to selected nodes.

size_in_bytes number required

Total size, in bytes, of all shards assigned to selected nodes.

reserved number | 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_bytes number required

A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.

total_data_set_size number | string

Total data set size of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.

total_data_set_size_in_bytes number

Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.

translog object
earliest_last_modified_age number required
operations number required
size string
size_in_bytes number required
uncommitted_operations number required
uncommitted_size string
uncommitted_size_in_bytes number required
warmer object
current number required
total number required
total_time string
total_time_in_millis number required
bulk object
total_operations number required
total_time string
total_time_in_millis number required
total_size number | string
total_size_in_bytes number required
avg_time string
avg_time_in_millis number required
avg_size number | string
avg_size_in_bytes number required
shards map string to object
shard_stats object
total_count number required
indices object
primaries object
completion object

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

size_in_bytes number required

Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.

size number | string

Total amount of memory used for completion across all shards assigned to selected nodes.

fields map string to object
<string> object
size number | string
size_in_bytes number required
docs object

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

count number required

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.

deleted number

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.

total_size_in_bytes number required

Returns the total size in bytes of all documents in this stats. This value may be more reliable than store_stats.size_in_bytes in estimating the index size.

total_size number | string

Human readable total_size_in_bytes

fielddata object

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

Same fields as fielddata in indices
flush object

Contains statistics about flush operations for the node.

periodic number required
total number required
total_time string
total_time_in_millis number required
get object

Contains statistics about get operations for the node.

Same fields as get in indices
indexing object

Contains statistics about indexing operations for the node.

Same fields as indexing in indices
indices object

Contains statistics about indices operations for the node.

Same fields as indices in indices
merges object

Contains statistics about merge operations for the node.

Same fields as merges in indices
query_cache object

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

cache_count number required

Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.

cache_size number required

Total number of entries currently in the query cache across all shards assigned to selected nodes.

evictions number required

Total number of query cache evictions across all shards assigned to selected nodes.

hit_count number required

Total count of query cache hits across all shards assigned to selected nodes.

memory_size number | string

Total amount of memory used for the query cache across all shards assigned to selected nodes.

memory_size_in_bytes number required

Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.

miss_count number required

Total count of query cache misses across all shards assigned to selected nodes.

total_count number required

Total count of hits and misses in the query cache across all shards assigned to selected nodes.

recovery object

Contains statistics about recovery operations for the node.

current_as_source number required
current_as_target number required
throttle_time string
throttle_time_in_millis number required
refresh object

Contains statistics about refresh operations for the node.

external_total number required
external_total_time_in_millis number required
listeners number required
total number required
total_time string
total_time_in_millis number required
request_cache object

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

evictions number required
hit_count number required
memory_size string
memory_size_in_bytes number required
miss_count number required

Contains statistics about search operations for the node.

Same fields as search in indices
segments object

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

Same fields as segments in indices
store object

Contains statistics about the size of shards assigned to the node.

size number | string

Total size of all shards assigned to selected nodes.

size_in_bytes number required

Total size, in bytes, of all shards assigned to selected nodes.

reserved number | 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_bytes number required

A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.

total_data_set_size number | string

Total data set size of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.

total_data_set_size_in_bytes number

Total data set size, in bytes, of all shards assigned to selected nodes. This includes the size of shards not stored fully on the nodes, such as the cache for partially mounted indices.

translog object

Contains statistics about transaction log operations for the node.

earliest_last_modified_age number required
operations number required
size string
size_in_bytes number required
uncommitted_operations number required
uncommitted_size string
uncommitted_size_in_bytes number required
warmer object

Contains statistics about index warming operations for the node.

current number required
total number required
total_time string
total_time_in_millis number required
bulk object
total_operations number required
total_time string
total_time_in_millis number required
total_size number | string
total_size_in_bytes number required
avg_time string
avg_time_in_millis number required
avg_size number | string
avg_size_in_bytes number required
shard_stats object
total_count number required
shards map string to object
total object
Same fields as primaries in indices
uuid string
health enum

Supported values include:

  • green (or GREEN): All shards are assigned.
  • yellow (or YELLOW): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.
  • red (or RED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.
  • unknown
  • unavailable
Values: green GREEN yellow YELLOW red RED unknown unavailable
status enum
Values: open close