Skip to content

Commit ca511cd

Browse files
authored
MINOR: update Kafka Streams docs for 4.0 KIP changes (#18307)
Reviewers: Lucas Brutschy <[email protected]>
1 parent 40e0543 commit ca511cd

File tree

6 files changed

+88
-55
lines changed

6 files changed

+88
-55
lines changed

docs/ops.html

+21-1
Original file line numberDiff line numberDiff line change
@@ -2783,9 +2783,14 @@ <h5 class="anchor-heading"><a id="kafka_streams_client_monitoring" class="anchor
27832783
</tr>
27842784
<tr>
27852785
<td>state</td>
2786-
<td>The state of the Kafka Streams client.</td>
2786+
<td>The state of the Kafka Streams client as a string.</td>
27872787
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
27882788
</tr>
2789+
<tr>
2790+
<td>client-state</td>
2791+
<td>The state of the Kafka Streams client as a number (<code>ordinal()</code> of the corresponding enum).</td>
2792+
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+),process-id=([-.\w]+)</td>
2793+
</tr>
27892794
<tr>
27902795
<td>alive-stream-threads</td>
27912796
<td>The current number of alive stream threads that are running or participating in rebalance.</td>
@@ -2796,6 +2801,11 @@ <h5 class="anchor-heading"><a id="kafka_streams_client_monitoring" class="anchor
27962801
<td>The number of failed stream threads since the start of the Kafka Streams client.</td>
27972802
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+)</td>
27982803
</tr>
2804+
<tr>
2805+
<td>recording-level</td>
2806+
<td>The metric recording level as a number (0 = INFO, 1 = DEBUG, 2 = TRACE).</td>
2807+
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+),process-id=([-.\w]+)</td>
2808+
</tr>
27992809
</tbody>
28002810
</table>
28012811

@@ -2808,6 +2818,16 @@ <h5 class="anchor-heading"><a id="kafka_streams_thread_monitoring" class="anchor
28082818
<th>Description</th>
28092819
<th>Mbean name</th>
28102820
</tr>
2821+
<tr>
2822+
<td>state</td>
2823+
<td>The state of the thread as a string.</td>
2824+
<td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
2825+
</tr>
2826+
<tr>
2827+
<td>thread-state</td>
2828+
<td>The state of the thread as a number (<code>ordinal()</code> of the corresponding enum).</td>
2829+
<td>kafka.streams:type=stream-thread-metrics,thread-id=([-.\w]+)</td>
2830+
</tr>
28112831
<tr>
28122832
<td>commit-latency-avg</td>
28132833
<td>The average execution time in ms, for committing, across all running tasks of this thread.</td>

docs/streams/developer-guide/app-reset-tool.html

+3-7
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
</ul>
4646
<p>The application reset tool does not:</p>
4747
<ul class="simple">
48-
<li>Reset output topics of an application. If any output (or intermediate) topics are consumed by downstream
48+
<li>Reset output topics of an application. If any output topics are consumed by downstream
4949
applications, it is your responsibility to adjust those downstream applications as appropriate when you reset the
5050
upstream application.</li>
5151
<li>Reset the local environment of your application instances. It is your responsibility to delete the local
@@ -78,9 +78,6 @@ <h2>Step 1: Run the application reset tool<a class="headerlink" href="#step-1-ru
7878
(s) to connect to. The broker list
7979
string in the form HOST1:PORT1,HOST2:
8080
PORT2.
81-
--bootstrap-servers &lt;String: urls&gt; DEPRECATED: Comma-separated list of
82-
broker urls with format: HOST1:PORT1,
83-
HOST2:PORT2 (default: localhost:9092)
8481
--by-duration &lt;String: urls&gt; Reset offsets to offset by duration from
8582
current timestamp. Format: &#39;PnDTnHnMnS&#39;
8683
--config-file &lt;String: file name&gt; Property file containing configs to be
@@ -123,8 +120,7 @@ <h2>Step 1: Run the application reset tool<a class="headerlink" href="#step-1-ru
123120
</ul>
124121
<p>Only one of these scenarios can be defined. If not, <code>to-earliest</code> will be executed by default</p>
125122
<p>All the other parameters can be combined as needed. For example, if you want to restart an application from an
126-
empty internal state, but not reprocess previous data, simply omit the parameters <code class="docutils literal"><span class="pre">--input-topics</span></code> and
127-
<code class="docutils literal"><span class="pre">--intermediate-topics</span></code>.</p>
123+
empty internal state, but not reprocess previous data, simply omit the parameter <code class="docutils literal"><span class="pre">--input-topics</span></code>.
128124
</div>
129125
<div class="section" id="step-2-reset-the-local-environments-of-your-application-instances">
130126
<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>
@@ -133,7 +129,7 @@ <h2>Step 1: Run the application reset tool<a class="headerlink" href="#step-1-ru
133129
use either of these methods:</p>
134130
<ul class="simple">
135131
<li>The API method <code class="docutils literal"><span class="pre">KafkaStreams#cleanUp()</span></code> in your application code.</li>
136-
<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>
132+
<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>
137133
</ul>
138134
</div>
139135
</div>

0 commit comments

Comments
 (0)