Get data stream stats

  • GET /_data_stream/{name}/_stats
  • GET /_data_stream/_stats
Auth

Get statistics for one or more data streams.

Required authorization

Index privileges monitor

Path parameters

name union string | string[] optional

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

Leave it out to use /_data_stream/_stats.

Query parameters

expand_wildcards union oneOf · default: open,closed

Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden.

Supported values include:

  • all: Match any data stream or index, including hidden ones.
  • open: Match open, non-hidden indices. Also matches any non-hidden data stream.
  • closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
  • hidden: Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
  • none: Wildcard expressions are not accepted.
Values: all open closed hidden none

Response

application/json
_shards object required

Contains information about shards that attempted to execute the request.

failed number required

The number of shards the operation or search attempted to run on but failed.

successful number required

The number of shards the operation or search succeeded on.

total number required

The number of shards the operation or search will run on overall.

failures object[]
index string
node string
reason object required
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 reason in failures
root_cause object[]
Same fields as reason in failures
suppressed object[]
Same fields as reason in failures
shard number
status string
primary boolean
skipped number
backing_indices number required

Total number of backing indices for the selected data streams.

data_stream_count number required

Total number of selected data streams.

data_streams object[] required

Contains statistics for the selected data streams.

backing_indices number required

Current number of backing indices for the data stream.

data_stream string required

Name of the data stream.

maximum_timestamp number required

The data stream’s highest @timestamp value, converted to milliseconds since the Unix epoch. NOTE: This timestamp is provided as a best effort. The data stream may contain @timestamp values 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 @timestamp values.

store_size number | string

Total size of all shards for the data stream’s backing indices. This parameter is only returned if the human query parameter is true.

store_size_bytes number required

Total size, in bytes, of all shards for the data stream’s backing indices.

total_store_sizes number | string

Total size of all shards for the selected data streams. This property is included only if the human query parameter is true

total_store_size_bytes number required

Total size, in bytes, of all shards for the selected data streams.