Get cluster statistics
- GET /_cluster/stats/nodes/{node_id}
- GET /_cluster/stats
Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
Required authorization
- Cluster privileges monitor
Query parameters
-
timeoutstring -
Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s
_nodes.failedproperty. Defaults to no timeout. - Reference
Response
-
indicesobjectrequired -
Contains statistics about indices with shards assigned to selected nodes.
-
analysisobject -
Contains statistics about analyzers and analyzer components used in selected nodes.
-
analyzer_typesobjectrequired -
Contains statistics about analyzer types used in selected nodes.
-
indexed_vector_countnumber -
For dense_vector field types, number of indexed vector types in selected nodes.
-
indexed_vector_dim_maxnumber -
For dense_vector field types, the maximum dimension of all indexed vector types in selected nodes.
-
indexed_vector_dim_minnumber -
For dense_vector field types, the minimum dimension of all indexed vector types in selected nodes.
-
vector_index_type_countmap string to number -
For dense_vector field types, count of mappings by index type
-
built_in_analyzersobjectrequired -
Contains statistics about built-in analyzers used in selected nodes.
-
built_in_char_filtersobjectrequired -
Contains statistics about built-in character filters used in selected nodes.
-
built_in_filtersobjectrequired -
Contains statistics about built-in token filters used in selected nodes.
-
built_in_tokenizersobjectrequired -
Contains statistics about built-in tokenizers used in selected nodes.
-
docsobjectrequired -
Contains counts for documents in selected nodes.
-
countnumberrequired -
Total number of non-deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments and may include documents from nested fields.
-
deletednumber -
Total number of deleted documents across all primary shards assigned to selected nodes. This number is based on documents in Lucene segments. Elasticsearch reclaims the disk space of deleted Lucene documents when a segment is merged.
-
query_cacheobjectrequired -
Contains statistics about the query cache of selected nodes.
-
cache_countnumberrequired -
Total number of entries added to the query cache across all shards assigned to selected nodes. This number includes current and evicted entries.
-
cache_sizenumberrequired -
Total number of entries currently in the query cache across all shards assigned to selected nodes.
-
evictionsnumberrequired -
Total number of query cache evictions across all shards assigned to selected nodes.
-
hit_countnumberrequired -
Total count of query cache hits across all shards assigned to selected nodes.
-
memory_sizenumber | string -
Total amount of memory used for the query cache across all shards assigned to selected nodes.
-
memory_size_in_bytesnumberrequired -
Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
-
searchobjectrequired -
Holds a snapshot of the search usage statistics. Used to hold the stats for a single node that's part of a ClusterStatsNodeResponse, as well as to accumulate stats for the entire cluster and return them as part of the ClusterStatsResponse.
-
segmentsobjectrequired -
Contains statistics about segments in selected nodes.
-
doc_values_memorynumber | string -
Total amount of memory used for doc values across all shards assigned to selected nodes.
-
doc_values_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
-
file_sizesmap string to objectrequired -
This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
-
fixed_bit_setnumber | string -
Total amount of memory used by fixed bit sets across all shards assigned to selected nodes. Fixed bit sets are used for nested object field types and type filters for join fields.
-
fixed_bit_set_memory_in_bytesnumberrequired -
Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
-
index_writer_memorynumber | string -
Total amount of memory used by all index writers across all shards assigned to selected nodes.
-
index_writer_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
-
max_unsafe_auto_id_timestampnumberrequired -
Unix timestamp, in milliseconds, of the most recently retried indexing request.
-
memorynumber | string -
Total amount of memory used for segments across all shards assigned to selected nodes.
-
memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
-
norms_memorynumber | string -
Total amount of memory used for normalization factors across all shards assigned to selected nodes.
-
norms_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
-
points_memorynumber | string -
Total amount of memory used for points across all shards assigned to selected nodes.
-
points_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
-
stored_fields_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
-
stored_fields_memorynumber | string -
Total amount of memory used for stored fields across all shards assigned to selected nodes.
-
terms_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
-
terms_memorynumber | string -
Total amount of memory used for terms across all shards assigned to selected nodes.
-
term_vectors_memorynumber | string -
Total amount of memory used for term vectors across all shards assigned to selected nodes.
-
term_vectors_memory_in_bytesnumberrequired -
Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
-
shardsobjectrequired -
Contains statistics about indices with shards assigned to selected nodes.
-
storeobjectrequired -
Contains statistics about the size of shards assigned to selected nodes.
-
reservednumber | string -
A prediction of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
-
reserved_in_bytesnumberrequired -
A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
-
mappingsobject -
Contains statistics about field mappings in selected nodes.
-
runtime_field_typesobjectrequired -
Contains statistics about runtime field data types used in selected nodes.
-
chars_totalnumberrequired -
Total number of characters for the scripts that define the current runtime field data type.
-
doc_totalnumberrequired -
Total number of accesses to doc_values for the scripts that define the current runtime field data type.
-
index_countnumberrequired -
Number of indices containing a mapping of the runtime field data type in selected nodes.
-
total_deduplicated_field_countnumber -
Total number of fields in all non-system indices, accounting for mapping deduplication.
-
total_deduplicated_mapping_sizenumber | string -
Total size of all mappings after deduplication and compression.
-
nodesobjectrequired -
Contains statistics about nodes selected by the request’s node filters.
-
discovery_typesmap string to numberrequired -
Contains statistics about the discovery types used by selected nodes.
-
fsobjectrequired -
Contains statistics about file stores by selected nodes.
-
available_in_bytesnumber -
Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than
nodes.fs.free_in_byes. This is the actual amount of free disk space the selected Elasticsearch nodes can use. -
availablenumber | string -
Total number of bytes available to JVM in file stores across all selected nodes. Depending on operating system or process-level restrictions, this number may be less than
nodes.fs.free_in_byes. This is the actual amount of free disk space the selected Elasticsearch nodes can use. -
indexing_pressureobjectrequired -
memoryobjectrequired -
limitnumber | string -
Configured memory limit for the indexing requests. Replica requests have an automatic limit that is 1.5x this value.
-
limit_in_bytesnumber -
Configured memory limit, in bytes, for the indexing requests. Replica requests have an automatic limit that is 1.5x this value.
-
currentobject -
Contains statistics for current indexing load.
-
allnumber | string -
Memory consumed by indexing requests in the coordinating, primary, or replica stage.
-
all_in_bytesnumber -
Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.
-
combined_coordinating_and_primarynumber | string -
Memory consumed by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.
-
combined_coordinating_and_primary_in_bytesnumber -
Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.
-
jvmobjectrequired -
Contains statistics about the Java Virtual Machines (JVMs) used by selected nodes.
-
memobjectrequired -
Contains statistics about memory used by selected nodes.
-
network_typesobjectrequired -
Contains statistics about the transport and HTTP networks used by selected nodes.
-
osobjectrequired -
Contains statistics about the operating systems used by selected nodes.
-
allocated_processorsnumberrequired -
Number of processors used to calculate thread pool size across all selected nodes. This number can be set with the processors setting of a node and defaults to the number of processors reported by the operating system. In both cases, this number will never be larger than 32.
-
architecturesobject -
Contains statistics about processor architectures (for example, x86_64 or aarch64) used by selected nodes.
-
available_processorsnumberrequired -
Number of processors available to JVM across all selected nodes.
-
memobjectrequired -
Contains statistics about memory used by selected nodes.
-
adjusted_total_in_bytesnumber -
Total amount, in bytes, of memory across all selected nodes, but using the value specified using the
es.total_memory_bytessystem property instead of measured total memory for those nodes where that system property was set. -
adjusted_totalnumber | string -
Total amount of memory across all selected nodes, but using the value specified using the
es.total_memory_bytessystem property instead of measured total memory for those nodes where that system property was set. -
total_in_bytesnumberrequired -
Total amount, in bytes, of physical memory across all selected nodes.
-
packaging_typesobjectrequired -
Contains statistics about Elasticsearch distributions installed on selected nodes.
-
pluginsobjectrequired -
Contains statistics about installed plugins and modules by selected nodes. If no plugins or modules are installed, this array is empty.
-
repositoriesmap string to string to numberrequired -
Contains stats on repository feature usage exposed in cluster stats for telemetry.
-
status -
Health status of the cluster, based on the state of its primary and replica shards.
Supported values include:
green(orGREEN): All shards are assigned.yellow(orYELLOW): 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(orRED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.unknownunavailable
-
Values:
greenGREENyellowYELLOWredREDunknownunavailable -
timestampnumberrequired -
Unix timestamp, in milliseconds, for the last time the cluster statistics were refreshed.
-
ccsobjectrequired -
Cross-cluster stats
-
clustersmap string to object -
Contains remote cluster settings and metrics collected from them. The keys are cluster names, and the values are per-cluster data. Only present if
include_remotesoption is set to true. -
<string>object -
The
skip_unavailablesetting used for this remote cluster. -
statusrequired -
Health status of the cluster, based on the state of its primary and replica shards.
Supported values include:
green(orGREEN): All shards are assigned.yellow(orYELLOW): 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(orRED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.unknownunavailable
-
Values:
greenGREENyellowYELLOWredREDunknownunavailable -
indices_total_size_in_bytesnumberrequired -
Total data set size, in bytes, of all shards assigned to selected nodes.
-
indices_total_sizestring -
Total data set size of all shards assigned to selected nodes, as a human-readable string.
-
max_heap_in_bytesnumberrequired -
Maximum amount of memory, in bytes, available for use by the heap across the nodes of the remote cluster.
-
max_heapstring -
Maximum amount of memory available for use by the heap across the nodes of the remote cluster, as a human-readable string.
-
_searchobjectrequired -
Information about cross-cluster search usage.
-
totalnumberrequired -
The total number of cross-cluster search requests that have been executed by the cluster.
-
successnumberrequired -
The total number of cross-cluster search requests that have been successfully executed by the cluster.
-
skippednumberrequired -
The total number of cross-cluster search requests (successful or failed) that had at least one remote cluster skipped.
-
took_mrt_trueobject -
Statistics about the time taken to execute cross-cluster search requests for which the
ccs_minimize_roundtripssetting was set totrue. -
took_mrt_falseobject -
Statistics about the time taken to execute cross-cluster search requests for which the
ccs_minimize_roundtripssetting was set tofalse. -
remotes_per_search_maxnumberrequired -
The maximum number of remote clusters that were queried in a single cross-cluster search request.
-
remotes_per_search_avgnumberrequired -
The average number of remote clusters that were queried in a single cross-cluster search request.
-
failure_reasonsmap string to numberrequired -
Statistics about the reasons for cross-cluster search request failures. The keys are the failure reason names and the values are the number of requests that failed for that reason.
-
featuresmap string to numberrequired -
The keys are the names of the search feature, and the values are the number of requests that used that feature. Single request can use more than one feature (e.g. both
asyncandwildcard). -
clientsmap string to numberrequired -
Statistics about the clients that executed cross-cluster search requests. The keys are the names of the clients, and the values are the number of requests that were executed by that client. Only known clients (such as
kibanaorelasticsearch) are counted. -
clustersmap string to objectrequired -
Statistics about the clusters that were queried in cross-cluster search requests. The keys are cluster names, and the values are per-cluster telemetry data. This also includes the local cluster itself, which uses the name
(local). -
<string>object -
totalnumberrequired -
The total number of successful (not skipped) cross-cluster search requests that were executed against this cluster. This may include requests where partial results were returned, but not requests in which the cluster has been skipped entirely.
-
skippednumberrequired -
The total number of cross-cluster search requests for which this cluster was skipped.