stack es indices stats cli command

elastic stack es indices stats [options]

Get index statistics.

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--completion-fields string

Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics.

Repeatable: pass --completion-fields multiple times to supply more than one value

--expand-wildcards enum

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

Values: all, open, closed, hidden, none

Repeatable: pass --expand-wildcards multiple times to supply more than one value

--fielddata-fields string

Comma-separated list or wildcard expressions of fields to include in fielddata statistics.

Repeatable: pass --fielddata-fields multiple times to supply more than one value

--fields string

Comma-separated list or wildcard expressions of fields to include in the statistics.

Repeatable: pass --fields multiple times to supply more than one value

--forbid-closed-indices

If true, statistics are not collected from closed indices.

--groups string

Comma-separated list of search groups to include in the search statistics.

Repeatable: pass --groups multiple times to supply more than one value

--include-segment-file-sizes

If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested).

--include-unloaded-segments

If true, the response includes information from segments that are not loaded into memory.

--level enum

Indicates whether statistics are aggregated at the cluster, indices, or shards level.

Values: cluster, indices, shards

--metric enum

Comma-separated list of metrics used to limit the request.

Values: _all, store, indexing, get, search, merge, flush, refresh, query_cache, fielddata, docs, warmer, completion, segments, translog, request_cache, recovery, bulk, shard_stats, mappings, dense_vector, sparse_vector

Repeatable: pass --metric multiple times to supply more than one value

--index string

A comma-separated list of index names; use _all or empty string to perform the operation on all indices

Repeatable: pass --index multiple times to supply more than one value

--error-trace

When set to true Elasticsearch will include the full stack trace of errors when they occur.

--filter-path string

Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch.

Repeatable: pass --filter-path multiple times to supply more than one value

--human

When set to true will return statistics in a format suitable for humans. For example "exists_time": "1h" for humans and "exists_time_in_millis": 3600000 for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines.

--pretty

If set to true the returned JSON will be "pretty-formatted". Only use this option for debugging only.

--input-file string

path to a JSON file to use as command input

--dry-run

validate all inputs and exit without performing any action (preview changes without applying them)

--no-validate

skip input validation and send the request as-is

--output-fields string

comma-separated list of fields to include in output (dot-notation supported)

--output-template string

Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")

--json

output as JSON