Path parameters
-
Limit the information returned to the specified metrics
-
Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.
Query parameters
-
Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.
-
Comma-separated list or wildcard expressions of fields to include in fielddata statistics.
-
Comma-separated list or wildcard expressions of fields to include in the statistics.
-
Comma-separated list of search groups to include in the search statistics.
-
If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).
-
Indicates whether statistics are aggregated at the cluster, index, or shard level.
Values are
cluster
,indices
, orshards
. -
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Values are
-1
or0
. -
A comma-separated list of document types for the indexing index metric.
-
If
true
, the response includes information from segments that are not loaded into memory.
Responses
-
Hide response attributes Show response attributes object
-
Contains statistics about the number of nodes selected by the request.
Hide _nodes attributes Show _nodes attributes object
-
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
Hide failures attributes Show failures attributes object
-
The type of error
-
The server stack trace. Present only if the
error_trace=true
parameter was sent with the request. -
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
-
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
-
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
-
-
Total number of nodes selected by the request.
-
Number of nodes that responded successfully to the request.
-
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.
-
-
Hide nodes attribute Show nodes attribute object
-
Hide * attributes Show * attributes object
-
Statistics about adaptive replica selection.
Hide adaptive_selection attribute Show adaptive_selection attribute object
-
Hide * attributes Show * attributes object
-
The exponentially weighted moving average queue size of search requests on the keyed node.
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.
-
The number of outstanding search requests to the keyed node from the node these stats are for.
-
The rank of this node; used for shard selection when routing search requests.
-
-
-
Statistics about the field data circuit breaker.
Hide breakers attribute Show breakers attribute object
-
Hide * attributes Show * attributes object
-
Estimated memory used for the operation.
-
Estimated memory used, in bytes, for the operation.
-
Memory limit for the circuit breaker.
-
Memory limit, in bytes, for the circuit breaker.
-
A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.
-
Total number of times the circuit breaker has been triggered and prevented an out of memory error.
-
-
-
Hide fs attributes Show fs attributes object
-
List of all file stores.
-
Last time the file stores statistics were refreshed. Recorded in milliseconds since the Unix Epoch.
-
Hide total attributes Show total attributes object
-
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. -
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. -
Total unallocated disk space in all file stores.
-
Total number of unallocated bytes in all file stores.
-
Total size of all file stores.
-
Total size of all file stores in bytes.
-
-
-
Hide http attributes Show http attributes object
-
Current number of open HTTP connections for the node.
-
Total number of HTTP connections opened for the node.
-
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. -
Detailed HTTP stats broken down by route
-
-
Hide ingest attributes Show ingest attributes object
-
Contains statistics about ingest pipelines for the node.
-
Hide total attributes Show total attributes object
-
-
Hide jvm attributes Show jvm attributes object
-
Contains statistics about JVM buffer pools for the node.
-
Hide mem attributes Show mem attributes object
-
Memory, in bytes, currently in use by the heap.
-
Percentage of memory currently in use by the heap.
-
Amount of memory, in bytes, available for use by the heap.
-
Maximum amount of memory, in bytes, available for use by the heap.
-
Non-heap memory used, in bytes.
-
Amount of non-heap memory available, in bytes.
-
Contains statistics about heap memory usage for the node.
-
-
Last time JVM statistics were refreshed.
-
Human-readable JVM uptime. Only returned if the
human
query parameter istrue
. -
JVM uptime in milliseconds.
-
-
Hide os attributes Show os attributes object
-
Hide cpu attributes Show cpu attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
Hide swap attributes Show swap attributes object
-
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 astotal_in_bytes
. -
Total amount of physical memory in bytes.
-
Amount of free physical memory in bytes.
-
Amount of used physical memory in bytes.
-
-
-
Hide process attributes Show process attributes object
-
Hide cpu attributes Show cpu attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
Hide mem attributes Show mem attributes object
-
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 astotal_in_bytes
. -
Total amount of physical memory in bytes.
-
Amount of free physical memory in bytes.
-
Amount of used physical memory in bytes.
-
-
Number of opened file descriptors associated with the current or
-1
if not supported. -
Maximum number of file descriptors allowed on the system, or
-1
if not supported. -
Last time the statistics were refreshed. Recorded in milliseconds since the Unix Epoch.
-
-
Values are
master
,data
,data_cold
,data_content
,data_frozen
,data_hot
,data_warm
,client
,ingest
,ml
,voting_only
,transform
,remote_cluster_client
, orcoordinating_only
. -
Hide script attributes Show script attributes object
-
Total number of times the script cache has evicted old data.
-
Total number of inline script compilations performed by the node.
-
Contains this recent history of script compilations.
-
Total number of times the script compilation circuit breaker has limited inline script compilations.
-
-
-
Statistics about each thread pool, including current size, queue and rejected tasks.
Hide thread_pool attribute Show thread_pool attribute object
-
Hide * attributes Show * attributes object
-
Number of active threads in the thread pool.
-
Number of tasks completed by the thread pool executor.
-
Highest number of active threads in the thread pool.
-
Number of tasks in queue for the thread pool.
-
Number of tasks rejected by the thread pool executor.
-
Number of threads in the thread pool.
-
-
-
Hide transport attributes Show transport attributes object
-
The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.
-
The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.
-
Total number of RX (receive) packets received by the node during internal cluster communication.
-
Size of RX packets received by the node during internal cluster communication.
-
Size, in bytes, of RX packets received by the node during internal cluster communication.
-
Current number of inbound TCP connections used for internal communication between nodes.
-
Total number of TX (transmit) packets sent by the node during internal cluster communication.
-
Size of TX packets sent by the node during internal cluster communication.
-
Size, in bytes, of TX packets sent by the node during internal cluster communication.
-
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.
-
-
Contains a list of attributes for the node.
-
Hide discovery attributes Show discovery attributes object
-
Hide published_cluster_states attributes Show published_cluster_states attributes 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.
-
Hide indexing_pressure attribute Show indexing_pressure attribute object
-
Hide indices attributes Show indices attributes object
-
Hide docs attributes Show docs attributes object
-
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.
-
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.
-
-
Hide get attributes Show get attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
Hide indexing attributes Show indexing attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
Hide merges attributes Show merges attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
Hide recovery attributes Show recovery attributes object
-
Hide refresh attributes Show refresh attributes object
-
Hide search attributes Show search attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
Hide segments attributes Show segments attributes object
-
Total number of segments across all shards assigned to selected nodes.
-
Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
-
This object is not populated by the cluster stats API. To get information on segment files, use the node stats API.
-
Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
-
Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
-
Unix timestamp, in milliseconds, of the most recently retried indexing request.
-
Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
-
Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
-
Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
-
Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
-
Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
-
Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
-
Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
-
-
Hide store attributes Show store attributes object
-
Total size, in bytes, of all shards assigned to selected nodes.
-
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, 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.
-
Hide warmer attributes Show warmer attributes object
-
Hide bulk attributes Show bulk attributes object
-
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
-
-
-
curl \
--request GET 'http://api.example.com/_nodes/stats/{metric}/{index_metric}' \
--header "Authorization: $API_KEY"