Skip to content

Commit 85726ef

Browse files
authored
added new consumer group states (#526)
* added new consumer group states * applied updates as suggested by reviewers for consumer group states * replaced general references to 'Kafka' with 'the Kafka instance'
1 parent 1634b0b commit 85726ef

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

docs/kafka/consumer-configuration-kafka/README.adoc

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,12 +113,24 @@ When you enter the preceding command, you should see output similar to the follo
113113

114114
[source,subs="+quotes,+attributes"]
115115
----
116-
CONSUMER GROUP ID ACTIVE MEMBERS PARTITIONS WITH LAG
117-
------------------- ---------------- ---------------------
118-
consumergroup1 2 0
119-
consumergroup2 1 0
116+
Consumer group ID Active members Partitions with lag State
117+
------------------- ---------------- --------------------- -------
118+
consumergroup1 2 0 Empty
119+
consumergroup2 1 0 Stable
120120
----
121121

122+
[id="con-consumer-group-state_{context}"]
123+
=== Consumer group states
124+
Consumer group states displayed in the OpenShift Streams for Apache Kafka web console and `rhoas` CLI can be one of the following values:
125+
126+
* *Empty*: The group exists but has no members.
127+
* *Stable*: Rebalancing already occurred and consumers are consuming.
128+
* *PreparingRebalance*: The group is waiting for consumers to join, which requires the reassignment of partitions, so the Kafka instance is currently rebalancing.
129+
* *CompletingRebalance*: The Kafka instance is still rebalancing and reassigning partitions.
130+
* *Dead*: The group is due to be removed from this Kafka instance soon. This deletion might be due to inactivity, or the group is being migrated to a different group coordinator.
131+
* *Unknown*: The state is too new for it to be parsed.
132+
133+
122134
[id="con-consumer-group-script_{context}"]
123135
=== Connecting the Kafka consumer group script
124136

@@ -161,7 +173,7 @@ To create a consumer group, you specify a consumer group ID in your consumer app
161173

162174
A group ID is required for a consumer to be able to join a consumer group.
163175
The group ID is the name of the consumer group.
164-
When you configure a consumer client application to access Kafka, you assign a group ID to associate it with a consumer group.
176+
When you configure a consumer client application to access a Kafka instance, you assign a group ID to associate it with a consumer group.
165177
All consumers with the same group ID belong to the consumer group with that ID.
166178

167179
Consumer groups connected to a Kafka instance are displayed in the {product-kafka} web console.

0 commit comments

Comments
 (0)