Streaming

rpk group describe

Describe group offset status & lag.

This command describes group members, calculates their lag, and prints detailed information about the members. COORDINATOR-PARTITION indicates the partition in the __consumer_offsets topic responsible for the group, if topic details are available; run with –verbose for more info if it is missing.

The --regex flag (-r) parses arguments as regular expressions and describes groups that match any of the expressions.

Usage

rpk group describe <groups...> [flags]

Examples

This section provides examples of how to use rpk group describe.

Describe groups <foo> and <bar>.

rpk group describe <foo> <bar>

Describe any group starting with f and ending in r.

rpk group describe -r '^f.*' '.*r$'

Describe all groups.

rpk group describe -r '*'

Describe any one-character group.

rpk group describe -r .

Flags

Value Type Description

--format

string

Output format (json,yaml,text,wide,help).

-i, --instance-ID

bool

Include each group member’s instance ID.

-c, --print-commits

bool

Print only the group commits section.

-t, --print-lag-per-topic

bool

Print the aggregated lag per topic.

-s, --print-summary

bool

Print only the group summary section.

-r, --regex

bool

Parse arguments as regex; describe any group that matches any input group expression.

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.