Streaming

rpk group describe

Describe group offset status & lag.

This command describes group members, calculates their lag, and prints detailed information about the members.

The COORDINATOR-PARTITION column indicates the partition in the __consumer_offsets topic responsible for the group, if topic details are available; run with --verbose for more information 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]

Flags

Value Type Description

--format

string

Output format. Possible values: json, yaml, text, wide, help. Default: text.

-h, --help

-

Help for describe.

-i, --instance-ID

-

Include each group member’s instance ID.

-c, --print-commits

-

Print only the group commits section.

-s, --print-summary

-

Print only the group summary section.

-r, --regex

string

Parse arguments as regex. Describe any group that matches any input group expression.

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

Examples

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 .