Skip to content

MINOR: Improve Streams docs for transitory states #20980

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
merged 2 commits into from
Nov 25, 2025
+5 −0
Merged

MINOR: Improve Streams docs for transitory states #20980

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1734154
improve streams state documentation for transitory states
ezhou413 Nov 24, 2025
a1e415b
reword
ezhou413 Nov 24, 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
5 changes: 5 additions & 0 deletions streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,11 @@ public class KafkaStreams implements AutoCloseable {
* Any state except NOT_RUNNING, PENDING_ERROR or ERROR can go to PENDING_SHUTDOWN (whenever close is called)
* </li>
* <li>
* PENDING_SHUTDOWN and PENDING_ERROR are transitory states where the Streams application gracefully closes
* its existing resources before transitioning into their corresponding terminal states. These states are
* not recoverable, and only a restart would get an application back to the RUNNING state.
* </li>
* <li>
* Of special importance: If the global stream thread dies, or all stream threads die (or both) then
* the instance will be in the ERROR state. The user will not need to close it.
* </li>
Expand Down