stack es snapshot repository-analyze cli command

elastic stack es snapshot repository-analyze --repository <repository> [options]
		

Analyze a snapshot repository.

Behaviour flags:

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

--repository string required

The name of the repository.

--blob-count number

The total number of blobs to write to the repository during the test. For realistic experiments, set this parameter to at least 2000.

--check-overwrite-protection

Whether to run the overwrite protection check. For realistic experiments, leave this parameter unset.

--concurrency number

The number of operations to run concurrently during the test. For realistic experiments, leave this parameter unset.

--detailed

Indicates whether to return detailed results, including timing information for every operation performed during the analysis. If false, it returns only a summary of the analysis.

--early-read-node-count number

The number of nodes on which to perform an early read operation while writing each blob. Early read operations are only rarely performed. For realistic experiments, leave this parameter unset.

--max-blob-size string

The maximum size of a blob to be written during the test. For realistic experiments, set this parameter to at least 2gb.

--max-total-data-size string

An upper limit on the total size of all the blobs written during the test. For realistic experiments, set this parameter to at least 1tb.

--rare-action-probability number

The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob. For realistic experiments, leave this parameter unset.

--rarely-abort-writes

Indicates whether to rarely cancel writes before they complete. For realistic experiments, leave this parameter unset.

--read-node-count number

The number of nodes on which to read a blob after writing. For realistic experiments, leave this parameter unset.

--register-operation-count number

The minimum number of linearizable register operations to perform in total. For realistic experiments, set this parameter to at least 100.

--seed number

The seed for the pseudo-random number generator used to generate the list of operations performed during the test. To repeat the same set of operations in multiple experiments, use the same seed in each experiment. Note that the operations are performed concurrently so might not always happen in the same order on each run. For realistic experiments, leave this parameter unset.

--timeout string

The period of time to wait for the test to complete. If no response is received before the timeout expires, the test is cancelled and returns an error. For realistic experiments, set this parameter sufficiently long to allow the test to complete.

--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)

--json

output as JSON