MINOR: extend consumer close java doc with error handling behaviour #20472
+34
−12
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
chia7712
reviewed
Sep 3, 2025
| @@ -1833,6 +1838,9 @@ public void close(Duration timeout) { | |||
| * {@link ConsumerConfig#REQUEST_TIMEOUT_MS_CONFIG} for these requests to complete during the close operation. | |||
| * Note that the execution time of callbacks (such as {@link OffsetCommitCallback} and | |||
| * {@link ConsumerRebalanceListener}) does not consume time from the close timeout. | |||
| * <p> | |||
| * This close operation will attempt all shutdown steps even if one of them fails. | |||
| * It logs all encountered errors, continues to execute the next steps, and finally throws the first error found. | |||
There was a problem hiding this comment.
Should we also list the exceptions, as we do for other close methods?
There was a problem hiding this comment.
+1, makes sense to me to align these comments.
mjsax
approved these changes
Sep 4, 2025
AndrewJSchofield
requested changes
Sep 4, 2025
|
Thank you all for the reviews. Comments addressed adding missing exceptions to the KafkaConsumer (and checked the ShareKafkaConsumer has them already consistently). |
|
@lianetm Checkstyle :) |
AndrewJSchofield
approved these changes
Sep 5, 2025
frankvicky
approved these changes
Sep 5, 2025
chia7712
approved these changes
Sep 5, 2025
|
the root cause of flaky is https://github.com/apache/kafka/pull/20244/files#r2325557949 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 to the consumer.close java doc to describe the error handling
behaviour.
Reviewers: Matthias J. Sax [email protected], Chia-Ping Tsai
[email protected], Andrew Schofield [email protected],
TengYao Chi [email protected]