Skip to content

Commit

Permalink
MINOR: update Kafka Streams docs for 4.0 KIP changes (#18307)
Browse files Browse the repository at this point in the history
Reviewers: Lucas Brutschy <[email protected]>
  • Loading branch information
mjsax authored Jan 3, 2025
1 parent 40e0543 commit ca511cd
Show file tree
Hide file tree
Showing 6 changed files with 88 additions and 55 deletions.
22 changes: 21 additions & 1 deletion docs/ops.html
Original file line number Diff line number Diff line change
Expand Up @@ -2783,9 +2783,14 @@ <h5 class="anchor-heading"><a id="kafka_streams_client_monitoring" class="anchor
</tr>
<tr>
<td>state</td>
<td>The state of the Kafka Streams client.</td>
<td>The state of the Kafka Streams client as a string.</td>
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
</tr>
<tr>
<td>client-state</td>
<td>The state of the Kafka Streams client as a number (<code>ordinal()</code> of the corresponding enum).</td>
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+),process-id=([-.\w]+)</td>
</tr>
<tr>
<td>alive-stream-threads</td>
<td>The current number of alive stream threads that are running or participating in rebalance.</td>
Expand All @@ -2796,6 +2801,11 @@ <h5 class="anchor-heading"><a id="kafka_streams_client_monitoring" class="anchor
<td>The number of failed stream threads since the start of the Kafka Streams client.</td>
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
</tr>
<tr>
<td>recording-level</td>
<td>The metric recording level as a number (0 = INFO, 1 = DEBUG, 2 = TRACE).</td>
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+),process-id=([-.\w]+)</td>
</tr>
</tbody>
</table>

Expand All @@ -2808,6 +2818,16 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
<th>Description</th>
<th>Mbean name</th>
</tr>
<tr>
<td>state</td>
<td>The state of the thread as a string.</td>
<td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
</tr>
<tr>
<td>thread-state</td>
<td>The state of the thread as a number (<code>ordinal()</code> of the corresponding enum).</td>
<td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
</tr>
<tr>
<td>commit-latency-avg</td>
<td>The average execution time in ms, for committing, across all running tasks of this thread.</td>
Expand Down
10 changes: 3 additions & 7 deletions docs/streams/developer-guide/app-reset-tool.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
</ul>
<p>The application reset tool does not:</p>
<ul class="simple">
<li>Reset output topics of an application. If any output (or intermediate) topics are consumed by downstream
<li>Reset output topics of an application. If any output topics are consumed by downstream
applications, it is your responsibility to adjust those downstream applications as appropriate when you reset the
upstream application.</li>
<li>Reset the local environment of your application instances. It is your responsibility to delete the local
Expand Down Expand Up @@ -78,9 +78,6 @@ <h2>Step 1: Run the application reset tool<a class="headerlink" href="#step-1-ru
(s) to connect to. The broker list
string in the form HOST1:PORT1,HOST2:
PORT2.
--bootstrap-servers &lt;String: urls&gt; DEPRECATED: Comma-separated list of
broker urls with format: HOST1:PORT1,
HOST2:PORT2 (default: localhost:9092)
--by-duration &lt;String: urls&gt; Reset offsets to offset by duration from
current timestamp. Format: &#39;PnDTnHnMnS&#39;
--config-file &lt;String: file name&gt; Property file containing configs to be
Expand Down Expand Up @@ -123,8 +120,7 @@ <h2>Step 1: Run the application reset tool<a class="headerlink" href="#step-1-ru
</ul>
<p>Only one of these scenarios can be defined. If not, <code>to-earliest</code> will be executed by default</p>
<p>All the other parameters can be combined as needed. For example, if you want to restart an application from an
empty internal state, but not reprocess previous data, simply omit the parameters <code class="docutils literal"><span class="pre">--input-topics</span></code> and
<code class="docutils literal"><span class="pre">--intermediate-topics</span></code>.</p>
empty internal state, but not reprocess previous data, simply omit the parameter <code class="docutils literal"><span class="pre">--input-topics</span></code>.
</div>
<div class="section" id="step-2-reset-the-local-environments-of-your-application-instances">
<span id="streams-developer-guide-reset-local-environment"></span><h2>Step 2: Reset the local environments of your application instances<a class="headerlink" href="#step-2-reset-the-local-environments-of-your-application-instances" title="Permalink to this headline"></a></h2>
Expand All @@ -133,7 +129,7 @@ <h2>Step 1: Run the application reset tool<a class="headerlink" href="#step-1-ru
use either of these methods:</p>
<ul class="simple">
<li>The API method <code class="docutils literal"><span class="pre">KafkaStreams#cleanUp()</span></code> in your application code.</li>
<li>Manually delete the corresponding local state directory (default location: <code class="docutils literal"><span class="pre">/tmp/kafka-streams/&lt;application.id&gt;</span></code>). For more information, see <a href="/{{version}}/javadoc/org/apache/kafka/streams/StreamsConfig.html#STATE_DIR_CONFIG">Streams</a> javadocs.</li>
<li>Manually delete the corresponding local state directory (default location: <code class="docutils literal"><span class="pre">/${java.io.tmpdir}/kafka-streams/&lt;application.id&gt;</span></code>). For more information, see <a href="/{{version}}/javadoc/org/apache/kafka/streams/StreamsConfig.html#STATE_DIR_CONFIG">Streams</a> javadocs.</li>
</ul>
</div>
</div>
Expand Down
Loading

0 comments on commit ca511cd

Please sign in to comment.