diff --git a/docs/sources/assemblies/assembly-deploying.adoc b/docs/sources/assemblies/assembly-deploying.adoc index cb7985085..d84eaedbf 100644 --- a/docs/sources/assemblies/assembly-deploying.adoc +++ b/docs/sources/assemblies/assembly-deploying.adoc @@ -16,14 +16,14 @@ You can configure the console to use an existing Prometheus source. If no source is set, the operator creates a private Prometheus instance when the console is deployed. However, this default setup is not recommended for production and should only be used for development or evaluation purposes. -Connect the console to one or more Kafka clusters to provide visibility into topics, Kafka nodes, and consumer groups. +Connect the console to one or more Kafka clusters to provide visibility into topics, Kafka nodes, and groups used by Kafka client applications to coordinate work. Configure the console to integrate with related services, including: -* **Authentication providers** for securing access to Kafka clusters -* **Kafka Connect clusters** for viewing connector and configuration details -* **Metrics providers** for monitoring Kafka cluster performance -* **Schema registries** for validating and decoding messages using data schemas +* **Authentication providers** to secure access to Kafka clusters +* **Kafka Connect clusters** to view connector and configuration details +* **Metrics providers** to monitor Kafka cluster performance +* **Schema registries** to validate and decode messages using data schemas Define these integrations in the `Console` custom resource configuration YAML file. diff --git a/docs/sources/index.adoc b/docs/sources/index.adoc index cc593b3b9..5a5ab11bf 100644 --- a/docs/sources/index.adoc +++ b/docs/sources/index.adoc @@ -29,6 +29,6 @@ include::modules/proc-checking-connectors.adoc[leveloffset=+2] include::modules/proc-checking-connect-clusters.adoc[leveloffset=+2] include::modules/con-users-page.adoc[leveloffset=+1] include::modules/proc-checking-users.adoc[leveloffset=+2] -include::modules/con-consumer-groups-page.adoc[leveloffset=+1] +include::modules/con-groups-page.adoc[leveloffset=+1] include::modules/proc-checking-consumer-groups-members.adoc[leveloffset=+2] include::modules/proc-resetting-consumer-offsets.adoc[leveloffset=+2] diff --git a/docs/sources/modules/con-consumer-groups-page.adoc b/docs/sources/modules/con-consumer-groups-page.adoc deleted file mode 100644 index 35ef9e58f..000000000 --- a/docs/sources/modules/con-consumer-groups-page.adoc +++ /dev/null @@ -1,20 +0,0 @@ -:_mod-docs-content-type: CONCEPT - -[id='con-consumer-groups-page-{context}'] -= Consumer Groups page - -[role="_abstract"] -The *Consumer Groups* page lists all consumer groups associated with a Kafka cluster. -You can filter the list by consumer group name or status. - -For each consumer group, view the status, the overall consumer lag across all partitions, and the number of members. -Click on associated topics to show the topic information available from the xref:con-topics-page-{context}[*Topics* page tabs]. - -Consumer group status can be one of the following: - -* *Stable* indicates normal functioning -* *Rebalancing* indicates ongoing adjustments to the consumer group’s members. -* *Empty* suggests no active members. If in the empty state, consider adding members to the group. - -Click on a consumer group name to check group members. -Select the options icon (three vertical dots) against a consumer group to reset consumer offsets. \ No newline at end of file diff --git a/docs/sources/modules/con-groups-page.adoc b/docs/sources/modules/con-groups-page.adoc new file mode 100644 index 000000000..caf5fc39f --- /dev/null +++ b/docs/sources/modules/con-groups-page.adoc @@ -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. +* *Share groups* distribute message processing across multiple consumers using a shared consumption model. Multiple consumers can process messages from the same partition concurrently. + +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. \ No newline at end of file diff --git a/docs/sources/modules/con-navigating-the-console.adoc b/docs/sources/modules/con-navigating-the-console.adoc index f1ca7164d..e6deda18b 100644 --- a/docs/sources/modules/con-navigating-the-console.adoc +++ b/docs/sources/modules/con-navigating-the-console.adoc @@ -12,7 +12,8 @@ Nodes:: Details broker and controller nodes, including roles, status, and partit Topics:: Lists topics with configuration details, partition data, and associated groups. Kafka Connect:: Displays information about Kafka Connect clusters, including connector status, configuration details, and available plugins. Kafka Users:: Lists Kafka users associated with the selected cluster and shows the namespace for each user. -Consumer groups:: Shows group activity, offsets, lag metrics, and partition assignments. +Groups:: Lists groups associated with the cluster and shows group activity, membership, and assignments. +Offset and lag metrics are available for consumer groups. NOTE: If the cluster navigation menu is hidden, click the navigation menu icon (three horizontal lines) in the console header to reveal it. diff --git a/docs/sources/modules/con-topics-page.adoc b/docs/sources/modules/con-topics-page.adoc index b6e334060..9af47131b 100644 --- a/docs/sources/modules/con-topics-page.adoc +++ b/docs/sources/modules/con-topics-page.adoc @@ -7,18 +7,18 @@ The *Topics* page lists all topics created for a Kafka cluster. You can filter the list by topic name, ID, or status. -The *Topics* page shows the overall replication status for partitions in the topic, as well as counts for the partitions in the topic and the number of associated consumer groups. -The overall storage used by the topic is also shown. +The *Topics* page shows the overall replication status of topic partitions, the number of partitions, and the number of associated groups. +The page also shows the total storage used by the topic data. WARNING: Internal topics must not be modified. You can choose to hide internal topics from the list of topics returned on the *Topics* page. Click on a topic name to view additional topic information presented on a series of tabs: -Messages:: Messages shows the message log for a topic. -Partitions:: Partitions shows the replication status of each partition in a topic. -Consumer groups:: Consumer groups lists the names and status of the consumer groups and group members connected to a topic. -Configuration:: Configuration shows the configuration of a topic. +Messages:: Shows the message log for the topic. +Partitions:: Shows the replication status of each partition. +Groups:: Lists the groups associated with the topic, including their status and members. Offset and lag information is available for groups. +Configuration:: Shows the topic configuration. -If a topic is shown as *Managed*, it means that is managed using the Strimzi Topic Operator and was not created directly in the Kafka cluster. +If a topic is shown as *Managed*, it means that it is managed by the Strimzi Topic Operator and was not created directly in the Kafka cluster. Use the information provided on the tabs to check and modify the configuration of your topics. \ No newline at end of file diff --git a/docs/sources/modules/proc-checking-consumer-groups-members.adoc b/docs/sources/modules/proc-checking-consumer-groups-members.adoc index ef09eb370..9f332e752 100644 --- a/docs/sources/modules/proc-checking-consumer-groups-members.adoc +++ b/docs/sources/modules/proc-checking-consumer-groups-members.adoc @@ -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). \ No newline at end of file diff --git a/docs/sources/modules/proc-checking-topic-consumer-groups.adoc b/docs/sources/modules/proc-checking-topic-consumer-groups.adoc index 57169fdb9..0e6d144f0 100644 --- a/docs/sources/modules/proc-checking-topic-consumer-groups.adoc +++ b/docs/sources/modules/proc-checking-topic-consumer-groups.adoc @@ -18,7 +18,7 @@ NOTE: Monitoring consumer group behavior is essential for ensuring optimal distr Consumer groups:: For each consumer group, view the status, the overall consumer lag across all partitions, and the number of members. -For more information on checking consumer groups, see xref:con-consumer-groups-page-{context}[]. +For more information on checking consumer groups, see xref:con-groups-page-{context}[]. Group members:: 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. diff --git a/docs/sources/modules/proc-resetting-consumer-offsets.adoc b/docs/sources/modules/proc-resetting-consumer-offsets.adoc index 880bfd0ad..d1c0db0e0 100644 --- a/docs/sources/modules/proc-resetting-consumer-offsets.adoc +++ b/docs/sources/modules/proc-resetting-consumer-offsets.adoc @@ -1,35 +1,37 @@ :_mod-docs-content-type: PROCEDURE -[id='proc-restting-consumer-offsets-{context}'] +[id='proc-resetting-consumer-offsets-{context}'] = Resetting consumer offsets [role="_abstract"] -Reset the consumer offsets of a specific consumer group from the *Consumer Groups* page. +Reset the consumer offsets of a specific consumer group from the *Groups* page. You might want to do this when reprocessing old data, skipping unwanted messages, or recovering from downtime. +NOTE: Resetting offsets is supported only for consumer groups. +Streams groups and Share groups do not currently support offset reset operations. + .Prerequisites All active members of the consumer group must be shut down before resetting the consumer offsets. .Procedure -. Log in to the Kafka cluster in the StreamsHub Console, then click *Consumer Groups*. +. Log in to the Kafka cluster in the StreamsHub Console, then click *Groups*. -. Click the options icon (three vertical dots) for the consumer group and click the reset consumer offsets option to display the *Reset consumer offset* page. +. Click the options icon (three vertical dots) for the consumer group and select the reset consumer offsets option to open the *Reset consumer offset* page. -. Choose to apply the offset reset to all consumer topics associated with the consumer group or select a specific topic. +. Choose whether to apply the offset reset to all consumer topics associated with the consumer group or to a specific topic. + -If you selected a topic, choose to apply the offset reset to all partitions or select a specific partition. +If you selected a topic, choose whether to apply the offset reset to all partitions or to a specific partition. . Choose the position to reset the offset: + -* Custom offset (available only if you selected a specific topic _and_ a specific partition). -If you select this option, enter the custom offset value. +* Custom offset (available only if you selected a specific topic and a specific partition). Enter the custom offset value. * Latest offset * Earliest offset * Specific date and time -* Delete committed offsets (available only if you selected a specific topic). +* Delete committed offsets (available only if you selected a specific topic) + If you selected date and time, choose the appropriate format and enter the date in that format. + @@ -37,11 +39,11 @@ IMPORTANT: The *Delete committed offsets* option removes the stored offsets from When the group resumes, offset behavior depends on the consumer configuration (for example, the `auto.offset.reset` setting). Use this option with caution. -. (Optional) Perform a dry run before applying the offset reset. +. (Optional) Perform a dry run before applying the offset reset. ++ +.. Click the down arrow next to *Dry run*. +.. Choose to run the dry run and view the results in the console, or copy the command to run it independently against the consumer group. + -.. Click the down arrow next to *Dry run*. -.. Choose the option to run the dry run and view the results in the console, or copy the command to run it independently against the consumer group. -+ The results display the new offsets for each topic partition included in the reset operation. A download option is available for the results.