Streaming

rpk topic describe-storage

Describe the cloud storage status of a topic, including storage mode, offset availability, segment sizes, and synchronization state.

Usage

rpk topic describe-storage <topic> [flags]

Summary

The summary section contains general information about the topic, the cloud storage mode (one of disabled, write_only, read_only, full, read_replica, cloud_topic, and cloud_topic_read_replica), and the delta in milliseconds since the last upload of either the partition manifest or a segment.

Offset

The offset section contains the start and last offsets (inclusive) per partition of data available in both the cloud and on local disk.

Size

For tiered storage topics, the size section contains the total bytes per partition in the cloud and on local disk, the total size of the log of each partition (excluding cloud and local overlap), and the number of segments in the cloud and on local disk. The cloud segment count does not include segments queued for deletion.

For cloud topics, the size section shows the L0 (level zero) and L1 (level one) byte breakdown, the total bytes, and the number of L1 extents.

Sync

The sync section contains the state of cloud synchronization: milliseconds since the last upload of the partition manifest, milliseconds since the last segment upload, milliseconds since the last manifest sync (for read replicas), and whether the remote metadata has a pending update to include all uploaded segments.

Flags

Value Type Description

-H, --human-readable

bool

Print times (in milliseconds) and byte values in human-readable units (for example, 1.2 GiB, 3m 20s).

-a, --print-all

bool

Print all cloud storage status.

-o, --print-offset

bool

Print the offset section.

-z, --print-size

bool

Print the log size section.

-s, --print-summary

bool

Print the summary section.

-y, --print-sync

bool

Print the sync section.

Global flags

Value Type Description

--config

string

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

-X, --config-opt

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

--ignore-profile

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

--profile

string

rpk profile to use.

-v, --verbose

bool

Enable verbose logging.