[KAFKA-14335] Admin.listConsumerGroups should allow filtering, pagination

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: 3.3.0
• Component/s: admin, clients, protocol
• Labels: needs-kip
• Assignee: Kirk True
• Reporter: Kirk True
• Created: 24/Oct/22 18:28
• Updated: 30/Jun/23 22:41

Description

The Admin API provides a means for clients to list the consumer groups in the cluster. When the list of consumer groups becomes very large, it can cause problems for the client (e.g., OOM errors) as well as overhead for the broker and network.

The proposal is to enhance the ListConsumerGroupsOptions class to have optional values such as:

• Consumer group ID regex (evaluated on broker)
• Pagination token (consumer group ID, probably)

This will require a KIP since it is enhancing the admin API, protocol, and broker.