-
Notifications
You must be signed in to change notification settings - Fork 24
docs(groups): updates the groups page to reflect group types #2393
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
PaulRMellor
wants to merge
7
commits into
streamshub:main
Choose a base branch
from
PaulRMellor:docs_groups-changes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+86
−56
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
21bdaec
docs(groups): updates the groups page to reflect group types
PaulRMellor b09197d
docs(review): updates from review by copilot
PaulRMellor e0dddc1
Merge branch 'main' into docs_groups-changes
PaulRMellor 2d8c909
docs(review): updates from comments by TC /01
PaulRMellor 01d5c47
docs(review): updates from comments by ME /01
PaulRMellor 8661a4a
Merge branch 'main' into docs_groups-changes
PaulRMellor b48d084
Merge branch 'main' into docs_groups-changes
PaulRMellor File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| :_mod-docs-content-type: CONCEPT | ||
|
|
||
| [id='con-groups-page-{context}'] | ||
| = Groups page | ||
|
|
||
| [role="_abstract"] | ||
| The *Groups* page lists all groups associated with a Kafka cluster. | ||
| Groups represent client applications that coordinate work across multiple instances. | ||
|
|
||
| You can filter the list by group name, type, or status. | ||
|
|
||
| Kafka supports the following group types: | ||
|
|
||
| * *Consumer groups* coordinate message consumption across multiple consumer instances. Each consumer in the group processes a subset of topic partitions. | ||
| * *Classic groups* use the original Kafka consumer group protocol used by earlier Kafka consumer clients. | ||
| * *Streams groups* are created by Kafka Streams applications to coordinate stream processing tasks. | ||
PaulRMellor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * *Share groups* distribute message processing across multiple consumers using a shared consumption model. Multiple consumers can process messages from the same partition concurrently. | ||
PaulRMellor marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Apache Kafka introduced a newer consumer group protocol in version 4.0. | ||
| Clients that use this protocol appear as *Consumer* groups in the console, while clients that use the original protocol appear as *Classic* groups. | ||
| Streams groups and Share groups were introduced in Apache Kafka 4.2. | ||
|
|
||
| For each group, the page shows information such as the group type and membership. | ||
| The console also displays the overall consumer lag across partitions and the number of members. | ||
| Click associated topics to view topic information available from the xref:con-topics-page-{context}[*Topics* page tabs]. | ||
|
|
||
| Group status indicates the current state of a group. | ||
| The exact states that appear depend on the group type. | ||
|
|
||
| Common states include: | ||
|
|
||
| * *Stable* indicates normal operation. | ||
| * *Empty* indicates that the group exists but currently has no active members. | ||
| * *Dead* indicates that the group is being removed after all members have left and retention has expired. | ||
|
|
||
| Some group types might display additional states depending on the group protocol: | ||
|
|
||
| * *PreparingRebalance* and *CompletingRebalance* can appear for Classic and Consumer groups while partition assignments are being updated. | ||
| * *Assigning* can appear for Consumer and Streams groups when a new partition assignment has been calculated but has not yet been applied to all members. | ||
| * *Reconciling* can appear for Consumer and Streams groups while members are transitioning to their assigned partitions. | ||
| * *NotReady* can appear for Streams groups when the application topology or required topics are not yet ready for processing. | ||
|
|
||
| Click a group name to view group details and membership information. | ||
| Select the options icon (three vertical dots) for a consumer group to reset consumer offsets. | ||
|
|
||
| NOTE: Resetting offsets is supported only for consumer groups. | ||
| Streams groups and Share groups do not currently support offset reset operations. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
16 changes: 8 additions & 8 deletions
16
docs/sources/modules/proc-checking-consumer-groups-members.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,17 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id='proc-checking-consumer-groups-members-{context}'] | ||
| = Checking consumer group members | ||
| [id='proc-checking-group-members-{context}'] | ||
| = Checking group members | ||
|
|
||
| [role="_abstract"] | ||
| Check the members of a specific consumer group from the *Consumer Groups* page. | ||
| Check the members of a group from the *Groups* page. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Log in to the Kafka cluster in the StreamsHub Console, then click *Consumer Groups*. | ||
| . On the *Consumer Groups* page, click the name of the consumer group you want to inspect. | ||
| . Click on the right arrow (>) next to a member ID to view the topic partitions a member is associated with, as well as any possible consumer lag. | ||
| . Log in to the Kafka cluster in the StreamsHub Console, then click *Groups*. | ||
| . On the *Groups* page, click the name of the group you want to inspect. | ||
| . Click the right arrow (>) next to a member ID to view the topic partitions associated with the member and any available lag information. | ||
| + | ||
| For each group member, you see the unique (consumer) client ID assigned to the consumer within the consumer group, overall consumer lag, and the number of assigned partitions. | ||
| For each group member, the console shows information such as the client ID, the number of assigned partitions, and any available offset or lag metrics. | ||
| + | ||
| Any consumer lag for a specific topic partition reflects the gap between the last message a consumer has picked up (committed offset position) and the latest message written by the producer (end offset position). | ||
| For consumer groups, lag reflects the gap between the last message processed by a consumer (committed offset position) and the latest message written to the partition (end offset position). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 15 additions & 13 deletions
28
docs/sources/modules/proc-resetting-consumer-offsets.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.