MINOR: Streams developer guide improvement #21000
Open
+18
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mjsax
reviewed
Nov 26, 2025
| <span id="streams-developer-guide-execution-scaling"></span><h2><a class="toc-backref" href="#id9">Handling crashes and failures</a><a class="headerlink" href="#handling-crashes-and-failures" title="Permalink to this headline"></a></h2> | ||
| <p>There are a few things you can do to reduce the likelihood of crashes and failures of your Kafka Streams application. | ||
| <ul class="simple"> | ||
| <li>Kafka Streams has a few configurations that can help with resilience in the face of broker failures. They can be found here: <a class="reference internal" href="config-streams.html#recommended-configuration-parameters-for-resiliency">Recommended configuration parameters for resiliency</a></li> |
Member
There was a problem hiding this comment.
They can be found here
It is bad writing style to use "here". Text should be written as if it was a book, with no hyperlinks, and the sentence should still make sense w/o any hyperlinks.
So something like:
They can be found in the configuration guide.
and just make "configuration guide" the link.
| <p>If your Kafka Streams application does crash or fail, it will first enter the <code class="docutils literal"><span class="pre">PENDING_ERROR</span></code> state | ||
| to gracefully close all of its existing resources, and then transition into the <code class="docutils literal"><span class="pre">ERROR</span></code> state. | ||
| It is important to note that the <code class="docutils literal"><span class="pre">PENDING_ERROR</span></code> state is not recoverable, and only a | ||
| restart will get the application back to the RUNNING state. |
Member
There was a problem hiding this comment.
Maybe add a sentence about monitoring both states?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a section about how to prevent crashes and failures to the Kafka
Streams developer guide.
Reviewers: Matthias J. Sax matthias@confluent.io