describe_consumer_group
Describe 1–1000 Kafka consumer groups in one call: members, partition ownership, committed offsets and lag, to find which consumer instance owns a stuck or lagging partition.
Instructions
Describe 1 to 1000 consumer groups in one call through items: state, assignor, coordinator broker, every running member (member_id, client_id, host and the partitions assigned to it), and for every partition the group owns or has committed on, the committed offset, end offset, lag, and the member, client id and host consuming it. Partitions and members are sorted.
Use it to find which consumer instance owns a stuck or lagging partition, so the operator knows which pod or host to inspect. has_commit false means the group owns the partition but never committed there, so its starting point is decided by the consumer's auto.offset.reset rather than by an offset. An Empty group has no members but keeps its commits.
sample_seconds watches the group for that long first and reports observation: the states it passed through and the members that joined or left. A group that keeps cycling through PreparingRebalance, or whose members keep changing, is rebalancing; the departing members' client_id and host point at the consumer that keeps leaving.
Results follow items order, each carrying index with result or error.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | The groups to describe, 1 to 1000 of them. Describing one group is an array of length one. Results follow this order and a group that does not exist is reported against its own item. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| atomic | Yes | ||
| failed | Yes | ||
| applied | Yes | ||
| results | Yes | ||
| succeeded | Yes |