24.1 beta 23.3 23.2 23.1

rpk cluster self-test start

Starts one or more benchmark tests on one or more nodes of the cluster.

Available tests to run:

  • Disk tests

    • Throughput test: 512 KB messages, sequential read/write

      • Uses a larger request message sizes and deeper I/O queue depth to write/read more bytes in a shorter amount of time, at the cost of IOPS/latency.

    • Latency test: 4 KB messages, sequential read/write

      • Uses smaller request message sizes and lower levels of parallelism to achieve higher IOPS and lower latency.

  • Network tests

    • Throughput test: 8192-bit messages

      • Unique pairs of Redpanda nodes each act as a client and a server.

      • The test pushes as much data over the wire, within the test parameters.

This command immediately returns on success, and the tests run asynchronously. The user polls for results with the rpk cluster self-test status command.

Usage

rpk cluster self-test start [flags]

Flags

Value Type Description

--disk-duration-ms

duration

uint The in milliseconds of individual disk test runs (default 30000).

-h, --help

-

Help for start.

--network-duration-ms

duration

uint The in milliseconds of individual network test runs (default 30000).

--no-confirm

-

Acknowledge warning prompt skipping read from stdin.

--only-disk-test

-

Runs only the disk benchmarks.

--only-network-test

-

Runs only network benchmarks.

--participant-node-ids

-

ints IDs of nodes that the tests will run on. If not set, tests will run for all node IDs.

--config

string

Redpanda or rpk config file; default search paths are /var/lib/redpanda/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.