Skip to content

KAFKA-19734: Updating the docs for KIP-1221 #20804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mjsax merged 7 commits into from
Nov 20, 2025
Merged

KAFKA-19734: Updating the docs for KIP-1221 #20804

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
eb92ea8
Follow up to 20766: updating the docs
gensericghiro Oct 31, 2025
fd432e6
Typo
gensericghiro Oct 31, 2025
9b73ab0
Merge remote-tracking branch 'upstream/trunk' into genseric/applicati…
gensericghiro Nov 4, 2025
b1fdd34
Removing application id tag from thread state metric's documentation
gensericghiro Nov 4, 2025
aac02ec
Merge remote-tracking branch 'upstream/trunk' into genseric/applicati…
gensericghiro Nov 20, 2025
eca315b
Adding upgrade note
gensericghiro Nov 20, 2025
1d49eec
Addressing comments
gensericghiro Nov 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ops.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3040,7 +3040,7 @@ <h5 class="anchor-heading"><a id="kafka_streams_client_monitoring" class="anchor
<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>
<td>kafka.streams:type=stream-metrics,client-id=([-.\w]+),process-id=([-.\w]+),application-id=([-.\w]+)</td>
</tr>
<tr>
<td>alive-stream-threads</td>
Expand Down
7 changes: 7 additions & 0 deletions docs/streams/upgrade-guide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,13 @@ <h3><a id="streams_api_changes_420" href="#streams_api_changes_420">Streams API
More details can be found in <a href="https://cwiki.apache.org/confluence/x/ywnxFg">KIP-1216</a>.
</p>

<p>
The <code>application-id</code> tag is now available for the Kafka Streams client state metric (<code>client-state</code>).
Additionally, the <code>process-id</code> tag is no longer a default client-level tag. It is now only available
for the following three metrics: <code>client-state</code>, <code>recording-level</code>, and <code>thread-state</code>.
More details can be found in <a href="https://cwiki.apache.org/confluence/x/jQobFw">KIP-1221</a>
</p>

<h3><a id="streams_api_changes_410" href="#streams_api_changes_410">Streams API changes in 4.1.0</a></h3>

<p><b>Note:</b> Kafka Streams 4.1.0 contains a critical memory leak bug (<a href="https://issues.apache.org/jira/browse/KAFKA-19748">KAFKA-19748</a>) that affects users of range scans and certain DSL operators (session windows, sliding windows, stream-stream joins, foreign-key joins). Users running Kafka Streams should consider upgrading directly to 4.1.1, which includes the fix for it.</p>
Expand Down