Skip to content

[DOCS] Add descriptions for data stream stats #2176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 54 additions & 36 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,27 @@ import { RequestBase } from '@_types/Base'
import { ExpandWildcards, IndexName } from '@_types/common'

/**
* Retrieves statistics for one or more data streams.
* @rest_spec_name indices.data_streams_stats
* @availability stack since=7.9.0 stability=stable
* @availability serverless stability=stable visibility=public
* @index_privileges monitor
*/
export interface Request extends RequestBase {
path_parts: {
/**
* 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 `*`.
*/
name?: IndexName
}
query_parameters: {
expand_wildcards?: ExpandWildcards // default: open
/**
* Type of data stream that wildcard patterns can match.
* Supports comma-separated values, such as `open,hidden`.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,42 @@ import { EpochTime, UnitMillis } from '@_types/Time'

export class Response {
body: {
/** Contains information about shards that attempted to execute the request. */
_shards: ShardStatistics
/** Total number of backing indices for the selected data streams. */
backing_indices: integer
/** Total number of selected data streams. */
data_stream_count: integer
/** Contains statistics for the selected data streams. */
data_streams: DataStreamsStatsItem[]
/**
* Total size of all shards for the selected data streams.
* This property is included only if the `human` query parameter is `true`
*/
total_store_sizes?: ByteSize
/** Total size, in bytes, of all shards for the selected data streams. */
total_store_size_bytes: integer
data_streams: DataStreamsStatsItem[]
}
}

export class DataStreamsStatsItem {
/** Current number of backing indices for the data stream. */
backing_indices: integer
/** Name of the data stream. */
data_stream: Name
/**
* 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.
*/
maximum_timestamp: EpochTime<UnitMillis>
/**
* 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?: ByteSize
/** Total size, in bytes, of all shards for the data stream’s backing indices. */
store_size_bytes: integer
maximum_timestamp: EpochTime<UnitMillis>
}