You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by "hvishwanath (via GitHub)" <gi...@apache.org> on 2026/01/06 04:57:28 UTC
[PR] Add missing streams groups tools doc [kafka]
hvishwanath opened a new pull request, #21248:
URL: https://github.com/apache/kafka/pull/21248
(no comment)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Add missing streams groups tools doc [kafka]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #21248:
URL: https://github.com/apache/kafka/pull/21248#discussion_r2664783339
##########
docs/streams/developer-guide/kafka-streams-group-sh.md:
##########
@@ -0,0 +1,166 @@
+---
+title: Kafka Streams Groups Tool
+type: docs
+description:
+weight: 14
+tags: ['kafka', 'docs']
+aliases:
+keywords:
+---
+
+Use `kafka-streams-groups.sh` to manage **Streams groups** for the Streams Rebalance Protocol (KIP‑1071): list and describe groups, inspect members and offsets/lag, reset or delete offsets for input topics, and delete groups (optionally including internal topics).
+
+
+# Overview
+
+A **Streams group** is a broker‑coordinated group type for Kafka Streams that uses Streams‑specific RPCs and metadata, distinct from classic consumer groups. The CLI surfaces Streams‑specific states, assignments, and input‑topic offsets to simplify visibility and administration.
+
+**Use with care:** Mutating operations (offset resets/deletes, group deletion) affect how applications will reprocess data when restarted. Always preview with \--dry-run before executing and ensure application instances are stopped/inactive and the group is empty before executing the command.
+
+# What the Streams Groups tool does
+
+ * **List Streams groups** across a cluster and display or filter by group state (Empty, Not Ready, Assigning, Reconciling, Stable, Dead).
+ * **Describe a Streams group** and show:
+ * Group state, group epoch, target assignment epoch (with `--state`, `--verbose` for additional details).
+ * Per‑member info such as epochs, current vs target assignments, and whether a member still uses the classic protocol (with `--members` and `--verbose`).
+ * Input‑topic offsets and lag (with `--offsets`), to understand how far behind processing is.
+ * **Reset input‑topic offsets** for a Streams group to control reprocessing boundaries using precise specifiers (earliest, latest, to‑offset, to‑datetime, by‑duration, shift‑by, from‑file). Requires `--dry-run` or `--execute` and inactive instances.
+ * **Delete offsets** for input topics to force re‑consumption on next start.
+ * **Delete a Streams group** to clean up broker‑side Streams metadata (offsets, topology, assignments). Optionally delete all, or a subset of, **internal topics** at the same time using `--internal-topics`.
+
+
+
+# Usage
+
+The script is located in `bin/kafka-streams-groups.sh` and connects to your cluster via `--bootstrap-server`. For secured clusters, pass AdminClient properties using `--command-config`.
+
+
+ $ kafka-streams-groups.sh --bootstrap-server <host:port> [COMMAND] [OPTIONS]
+
+**Note:** `kafka-streams-groups.sh` complements the Streams Admin API for Streams groups. The CLI exposes list/describe/delete operations and offset management similar in spirit to consumer-group tools, but tailored to Streams groups defined in KIP‑1071.
+
+# Commands
+
+## List Streams groups
+
+Discovering groups
+
+
+ # List all Streams groups
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 --list
+
+
+## Describe Streams groups
+
+Inspecting group's state, members, and lag
+
+
+ # Describe a group: state + epochs
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --describe --group my-streams-app --state --verbose
+
+ # Describe a group: members (assignments vs target, classic/streams)
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --describe --group my-streams-app --members --verbose
+
+ # Describe a group: input-topic offsets and lag
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --describe --group my-streams-app --offsets
+
+
+## Reset input-topic offsets (preview, then apply) {#reset-offsets}
+
+Ensure all application instances are stopped/inactive. Always preview changes with `--dry-run` before using `--execute`.
+
+
+ # Preview resetting all input topics to a specific timestamp
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --group my-streams-app \
+ --reset-offsets --all-input-topics --to-datetime 2025-01-31T23:57:00.000 \
+ --dry-run
+
+ # Apply the reset
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --group my-streams-app \
+ --reset-offsets --all-input-topics --to-datetime 2025-01-31T23:57:00.000 \
+ --execute
+
+
+## Delete offsets to force re-consumption
+
+Delete offsets for all or specific input topics to have the group re-read data on restart.
+
+
+ # Delete offsets for all input topics (execute)
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --group my-streams-app \
+ --delete-offsets --all-input-topics --execute
+
+ # Delete offsets for specific topics
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --group my-streams-app \
+ --delete-offsets --topic input-a --topic input-b --execute
+
+
+## Delete a Streams group (cleanup)
+
+Delete broker-side Streams metadata for a group and optionally remove a subset of internal topics.
+
+
+ # Delete Streams group metadata
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --delete --group my-streams-app
+
+ # Delete a subset of internal topics alongside the group (use with care)
+ kafka-streams-groups.sh --bootstrap-server localhost:9092 \
+ --delete --group my-streams-app \
+ --internal-topics my-app-repartition-0,my-app-changelog
+
+
+# All options and flags
+
+## Core actions
+
+ * `--list`: List Streams groups. Use `--state` to display/filter by state.
+ * `--describe`: Describe a group selected by `--group`. Combine with:
+ * `--state` (group state and epochs), `--members` (members and assignments), `--offsets` (input and repartition topics offsets/lag).
Review Comment:
Grammatical inconsistency: should be either 'input and repartition topic offsets/lag' (singular) or 'input and repartition topics' offsets/lag' (with apostrophe for possessive). The current phrasing 'topics offsets/lag' is grammatically incorrect.
```suggestion
* `--state` (group state and epochs), `--members` (members and assignments), `--offsets` (input and repartition topic offsets/lag).
```
##########
docs/streams/developer-guide/kafka-streams-group-sh.md:
##########
@@ -0,0 +1,166 @@
+---
+title: Kafka Streams Groups Tool
+type: docs
+description:
Review Comment:
The description field in the front matter is empty. Consider adding a brief description of what this page covers, which can be useful for SEO and search functionality within the documentation site.
```suggestion
description: CLI reference for `kafka-streams-groups.sh` to list, describe, reset offsets, and delete Kafka Streams groups using the Streams Rebalance Protocol (KIP‑1071).
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Add missing streams groups tools doc [kafka]
Posted by "lucasbru (via GitHub)" <gi...@apache.org>.
lucasbru merged PR #21248:
URL: https://github.com/apache/kafka/pull/21248
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add missing streams groups tools doc [kafka]
Posted by "aliehsaeedii (via GitHub)" <gi...@apache.org>.
aliehsaeedii commented on PR #21248:
URL: https://github.com/apache/kafka/pull/21248#issuecomment-3714065017
Thanks, LGTM!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] MINOR: Add missing streams groups tools doc [kafka]
Posted by "lucasbru (via GitHub)" <gi...@apache.org>.
lucasbru commented on PR #21248:
URL: https://github.com/apache/kafka/pull/21248#issuecomment-3767277362
cherry-picked to 4.2
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org