mjsax commented on code in PR #20946: URL: https://github.com/apache/kafka/pull/20946#discussion_r2558476517
########## docs/streams/developer-guide/kafka-streams-group-sh.html: ########## @@ -0,0 +1,278 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +<script><!--#include virtual="../../js/templateData.js" --></script> + +<script id="content-template" type="text/x-handlebars-template"> + <!-- h1>Developer Guide for Kafka Streams</h1 --> + <div class="sub-nav-sticky"> + <div class="sticky-top"> + <!-- div style="height:35px"> + <a href="/{{version}}/documentation/streams/">Introduction</a> + <a class="active-menu-item" href="/{{version}}/documentation/streams/developer-guide">Developer Guide</a> + <a href="/{{version}}/documentation/streams/core-concepts">Concepts</a> + <a href="/{{version}}/documentation/streams/quickstart">Run Demo App</a> + <a href="/{{version}}/documentation/streams/tutorial">Tutorial: Write App</a> + </div --> + </div> + </div> +<div class="everything"> + + <div class="container"> + <div class="toc" id="toc"> + <h2>Table of contents</h2> + <ul> + <li><a href="#overview">Overview</a></li> + <li><a href="#what-it-does">What the Streams Groups tool does</a></li> + <li><a href="#usage">Usage</a></li> + <li><a href="#commands">Commands</a></li> + <li><a href="#options">All options and flags</a></li> + <li><a href="#best-practices">Best practices and safety</a></li> + </ul> + </div> + + <div id="header"> + <div class="container"> + <h1>Kafka Streams Groups Tool (kafka-streams-groups.sh)</h1> + <p>Use <code>kafka-streams-groups.sh</code> to manage <strong>Streams groups</strong> 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).</p> + </div> + </div> + + <div id="overview"> + <span class="anchor" aria-hidden="true"></span> + <h2>Overview</h2> + <p>A <strong>Streams group</strong> 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.</p> + + <div class="admonition warning"> + <strong>Use with care:</strong> Mutating operations (offset resets/deletes, group deletion) affect how applications will reprocess data when restarted. Always preview with <span class="kbd">--dry-run</span> before executing and ensure application instances are stopped/inactive. + </div> + </div> + + <div id="what-it-does"> + <span class="anchor" aria-hidden="true"></span> + <h2>What the Streams Groups tool does</h2> + <ul> + <li><strong>List Streams groups</strong> across a cluster and display or filter by group state (Empty, Not Ready, Assigning, Reconciling, Stable, Dead).</li> + + <li><strong>Describe a Streams group</strong> and show: + <ul> + <li>Group state, group epoch, target assignment epoch (with <code>--state</code>, <code>--verbose</code> for additional details).</li> + <li>Per‑member info such as epochs, current vs target assignments, and whether a member still uses the classic protocol (with <code>--members</code> and <code>--verbose</code>).</li> + <li>Input‑topic offsets and lag (with <code>--offsets</code>), to understand how far behind processing is.</li> + </ul> + </li> + + <li><strong>Reset input‑topic offsets</strong> for a Streams group to control reprocessing boundaries using precise specifiers (earliest, latest, to‑offset, to‑datetime, by‑duration, shift‑by, from‑file). Requires <code>--dry-run</code> or <code>--execute</code> and inactive instances.</li> + + <li><strong>Delete offsets</strong> for input topics to force re‑consumption on next start.</li> + + <li><strong>Delete a Streams group</strong> to clean up broker‑side Streams metadata (offsets, topology, assignments). Optionally delete a subset of <strong>internal topics</strong> at the same time using <code>--internal-topics</code>.</li> + </ul> + </div> + + <div id="usage"> + <span class="anchor" aria-hidden="true"></span> + <h2>Usage</h2> + <p>The script is typically located in <code>bin/kafka-streams-groups.sh</code> and connects to your cluster via <code>--bootstrap-server</code>. For secured clusters, pass AdminClient properties using <code>--command-config</code>.</p> Review Comment: ```suggestion <p>The script is located in <code>bin/kafka-streams-groups.sh</code> and connects to your cluster via <code>--bootstrap-server</code>. For secured clusters, pass AdminClient properties using <code>--command-config</code>.</p> ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
