Data stream stats APIedit
Retrieves statistics for one or more data streams.
GET /_data_stream/my-data-stream/_stats
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
monitorormanageindex privilege for the data stream.
Requestedit
GET /_data_stream/<data-stream>/_stats
Path parametersedit
-
<data-stream> -
(Optional, string) Comma-separated list of data streams used to limit the request. Wildcard expressions (
*) are supported.To target all data streams in a cluster, omit this parameter or use
*.
Query parametersedit
-
expand_wildcards -
(Optional, string) Type of data stream that wildcard patterns can match. Supports comma-separated values, such as
open,hidden. Valid values are:-
all,hidden - Match any data stream, including hidden ones.
-
open,closed - Matches any non-hidden data stream. Data streams cannot be closed.
-
none - Wildcard patterns are not accepted.
Defaults to
open. -
-
human -
(Optional, Boolean)
If
true, the response includes statistics in human-readable byte values. Defaults tofalse.
Response bodyedit
-
_shards -
(object) Contains information about shards that attempted to execute the request.
Properties of
_shards-
total - (integer) Total number of shards that attempted to execute the request.
-
successful - (integer) Number of shards that successfully executed the request.
-
failed - (integer) Number of shards that failed to execute the request.
-
-
data_stream_count - (integer) Total number of selected data streams.
-
backing_indices - (integer) Total number of backing indices for the selected data streams.
-
total_store_size -
(byte value)
Total size of all shards for the selected data streams.
This property is included only if the
humanquery parameter istrue. -
total_store_size_bytes - (integer) Total size, in bytes, of all shards for the selected data streams.
-
data_streams -
(array of objects) Contains statistics for the selected data streams.
Properties of objects in
data_streams-
data_stream - (string) Name of the data stream.
-
backing_indices - (integer) Current number of backing indices for the data stream.
-
store_size -
(byte value)
Total size of all shards for the data stream’s backing indices.
This parameter is only returned if the
humanquery parameter istrue. -
store_size_bytes - (integer) Total size, in bytes, of all shards for the data stream’s backing indices.
-
maximum_timestamp -
(integer) The data stream’s highest
@timestampvalue, converted to milliseconds since the Unix epoch.This timestamp is provided as a best effort. The data stream may contain
@timestampvalues higher than this if one or more of the following conditions are met:- The stream contains closed backing indices.
-
Backing indices with a lower generation contain
higher
@timestampvalues.
-
Examplesedit
GET /_data_stream/my-data-stream*/_stats?human=true
The API returns the following response.
{
"_shards": {
"total": 10,
"successful": 5,
"failed": 0
},
"data_stream_count": 2,
"backing_indices": 5,
"total_store_size": "7kb",
"total_store_size_bytes": 7268,
"data_streams": [
{
"data_stream": "my-data-stream",
"backing_indices": 3,
"store_size": "3.7kb",
"store_size_bytes": 3772,
"maximum_timestamp": 1607512028000
},
{
"data_stream": "my-data-stream-two",
"backing_indices": 2,
"store_size": "3.4kb",
"store_size_bytes": 3496,
"maximum_timestamp": 1607425567000
}
]
}