rpk cluster self-test start

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

Redpanda self-test runs benchmarks that consume significant system resources. Do not start self-test if large workloads are already running on the system.

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.

  • Cloud storage tests

    • Configuration/latency test: 1024-byte object.

    • If cloud storage is enabled (cloud_storage_enabled), a series of remote operations are performed:

      1. Upload an object (a random buffer of 1024 bytes) to the cloud storage bucket/container.

      2. List objects in the bucket/container.

      3. Download the uploaded object from the bucket/container.

      4. Download the uploaded object’s metadata from the bucket/container.

      5. Delete the uploaded object from the bucket/container.

      6. Upload and then delete multiple objects (random buffers) at once from the bucket/container.

This command prompts users for confirmation (unless the flag --no-confirm is specified), then returns a test identifier ID, and runs the tests.

To view the test status, poll rpk cluster self-test status. Once the tests end, the cached results will be available with rpk cluster self-test status.

Usage

rpk cluster self-test start [flags]
bash

Flags

Value Type Description

--cloud-backoff-ms

uint

The backoff in milliseconds for a cloud storage request (default 100).

--cloud-timeout-ms

uint

The timeout in milliseconds for a cloud storage request (default 5000).

--disk-duration-ms

uint

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

-h, --help

-

Help for start.

--network-duration-ms

uint

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

--no-confirm

-

Acknowledge warning prompt skipping read from stdin.

--only-cloud-test

-

Runs only cloud storage verification.

--only-disk-test

-

Runs only the disk benchmarks.

--only-network-test

-

Runs only network benchmarks.

--participant-node-ids

uints

Comma-separated list of broker IDs 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.