You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by "junaiddshaukat (via GitHub)" <gi...@apache.org> on 2026/02/14 19:46:15 UTC
[PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
junaiddshaukat opened a new pull request, #37607:
URL: https://github.com/apache/beam/pull/37607
Resolves #37606
## Summary
`KafkaCommitOffset.CommitOffsetDoFn.commitSync()` currently catches all
exceptions and silently skips them, meaning transient failures (network
timeouts, temporary broker issues) cause offsets to never be committed.
This can lead to duplicate processing after a restart.
This PR addresses the existing `// TODO: consider retrying.` by adding
exponential backoff retry (3 retries: 500ms, 1s, 2s) for Kafka's
`RetriableException` subclasses, while preserving warn-and-skip for
non-retriable exceptions. Retry count is consistent with Beam's existing
Kafka producer default (`RETRIES_CONFIG = 3`).
## Changes
**`KafkaCommitOffset.java`**
- Retry up to 3 times with exponential backoff (500ms, 1s, 2s) when
`commitSync()` throws a `RetriableException` (e.g., `TimeoutException`)
- Non-retriable exceptions still log a warning and skip (preserving
existing behavior)
- Thread interruption during backoff is handled gracefully
**`KafkaCommitOffsetTest.java`**
- Added `testCommitOffsetRetriableErrorSucceedsAfterRetry`: verifies
that transient failures are retried and the offset is committed on
the successful attempt
- Added `KafkaRetriableMockConsumer`: mock that throws
`RetriableCommitFailedException` N times before succeeding
## Test plan
- [x] Existing `KafkaCommitOffsetTest` tests pass
- [x] New retry test verifies commit succeeds after transient failures
- [x] Existing error test confirms non-retriable exceptions still
warn-and-skip
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [X] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment `fixes #<ISSUE NUMBER>` instead.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [ ] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://github.com/apache/beam/blob/master/CONTRIBUTING.md#make-the-reviewers-job-easier).
To check the build health, please visit [https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md](https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md)
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Go+tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI or the [workflows README](https://github.com/apache/beam/blob/master/.github/workflows/README.md) to see a list of phrases to trigger workflows.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "junaiddshaukat (via GitHub)" <gi...@apache.org>.
junaiddshaukat commented on PR #37607:
URL: https://github.com/apache/beam/pull/37607#issuecomment-3922215348
@johnjcasey please have a look at this PR when you got some time. Thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "sjvanrossum (via GitHub)" <gi...@apache.org>.
sjvanrossum commented on PR #37607:
URL: https://github.com/apache/beam/pull/37607#issuecomment-4091553679
Please read the `KafkaConsumer` docs. It clearly states that`commitSync()` does not produce any recoverable exceptions except `TimeOutException` after `default.api.timeout.ms` expires.
Feel free to close this PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "gemini-code-assist[bot] (via GitHub)" <gi...@apache.org>.
gemini-code-assist[bot] commented on PR #37607:
URL: https://github.com/apache/beam/pull/37607#issuecomment-3902409530
## Summary of Changes
Hello @junaiddshaukat, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the robustness of Kafka offset committing within Apache Beam by introducing a retry mechanism with exponential backoff. This change addresses the issue where transient failures could lead to silently skipped offset commits and subsequent duplicate data processing. By retrying operations that encounter retriable exceptions, the system becomes more resilient to temporary network or broker issues, ensuring greater data consistency without altering the handling of permanent errors.
### Highlights
* **Retry Logic**: Implemented an exponential backoff retry mechanism for transient Kafka commit failures in `KafkaCommitOffset.CommitOffsetDoFn.commitSync()`.
* **Error Handling**: Differentiated between retriable and non-retriable exceptions during offset commits, applying retries only for `RetriableException` subclasses while preserving existing warn-and-skip behavior for others.
* **Test Coverage**: Added a new test case (`testCommitOffsetRetriableErrorSucceedsAfterRetry`) and a specialized mock consumer (`KafkaRetriableMockConsumer`) to thoroughly validate the new retry functionality.
🧠**New Feature in Public Preview:** You can now enable **Memory** to help **Gemini Code Assist** learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. **Click [here](https://codeassist.google/code-review/login) to enable Memory in your admin console.**
<details>
<summary><b>Changelog</b></summary>
* **sdks/java/io/kafka/src/main/java/org/apache/beam/sdk/io/kafka/KafkaCommitOffset.java**
* Imported `org.apache.kafka.common.errors.RetriableException` for specific error handling.
* Defined `MAX_RETRIES` (3) and `INITIAL_BACKOFF_MS` (500) constants to configure the retry mechanism.
* Wrapped the `consumer.commitSync()` call within a `for` loop to implement up to 3 retries.
* Introduced exponential backoff (500ms, 1s, 2s) using `Thread.sleep()` between retries specifically for `RetriableException` types.
* Added detailed logging for retry attempts and final failure messages.
* Gracefully handled `InterruptedException` during the backoff period.
* Maintained the existing warn-and-skip behavior for non-retriable `Exception` types.
* **sdks/java/io/kafka/src/test/java/org/apache/beam/sdk/io/kafka/KafkaCommitOffsetTest.java**
* Imported `java.util.concurrent.atomic.AtomicInteger` and `org.apache.kafka.clients.consumer.RetriableCommitFailedException` for new test utilities.
* Instantiated `KafkaRetriableMockConsumer` to simulate retriable commit failures in tests.
* Added a new test method, `testCommitOffsetRetriableErrorSucceedsAfterRetry`, to verify that `CommitOffsetDoFn` successfully commits after encountering transient retriable errors.
* Implemented `KafkaRetriableMockConsumer` as a private static inner class, which is designed to throw `RetriableCommitFailedException` a specified number of times before allowing a successful commit.
</details>
<details>
<summary><b>Activity</b></summary>
* The pull request resolves issue #37606.
* Existing `KafkaCommitOffsetTest` tests were confirmed to pass.
* A new retry test was added and verified to ensure commits succeed after transient failures.
* Existing error tests were confirmed to show that non-retriable exceptions still warn and skip.
* The author completed the checklist item for mentioning the appropriate issue in the description.
</details>
<details>
<summary><b>Using Gemini Code Assist</b></summary>
<br>
The full guide for Gemini Code Assist can be found on our [documentation page](https://developers.google.com/gemini-code-assist/docs/review-github-code), here are some quick tips.
<b>Invoking Gemini</b>
You can request assistance from Gemini at any point by creating a comment using either `/gemini <command>` or `@gemini-code-assist <command>`. Below is a summary of the supported commands on the current page.
Feature | Command | Description
--- | --- | ---
Code Review | `/gemini review` | Performs a code review for the current pull request in its current state.
Pull Request Summary | `/gemini summary` | Provides a summary of the current pull request in its current state.
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help | `/gemini help` | Displays a list of available commands.
<b>Customization</b>
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a `.gemini/` folder in the base of the repository. Detailed instructions can be found [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github).
<b>Limitations & Feedback</b>
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up [here](https://google.qualtrics.com/jfe/form/SV_2cyuGuTWsEw84yG).
<b>You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the [Gemini Code Assist IDE Extension](https://cloud.google.com/products/gemini/code-assist).</b>
</details>
[^1]: Review the [Privacy Notices](https://policies.google.com/privacy), [Generative AI Prohibited Use Policy](https://policies.google.com/terms/generative-ai/use-policy), [Terms of Service](https://policies.google.com/terms), and learn how to configure Gemini Code Assist in GitHub [here](https://developers.google.com/gemini-code-assist/docs/customize-gemini-behavior-github). Gemini can make mistakes, so double check it and [use code with caution](https://support.google.com/legal/answer/13505487).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37607:
URL: https://github.com/apache/beam/pull/37607#issuecomment-4023393409
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment `assign to next reviewer`:
R: @Abacn for label java.
R: @shunping for label kafka.
Available commands:
- `stop reviewer notifications` - opt out of the automated review tooling
- `remind me after tests pass` - tag the comment author after tests pass
- `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37607:
URL: https://github.com/apache/beam/pull/37607#issuecomment-4067329664
Reminder, please take a look at this pr: @Abacn @shunping
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37607:
URL: https://github.com/apache/beam/pull/37607#issuecomment-3902487887
Assigning reviewers:
R: @ahmedabu98 for label java.
R: @johnjcasey for label kafka.
Note: If you would like to opt out of this review, comment `assign to next reviewer`.
Available commands:
- `stop reviewer notifications` - opt out of the automated review tooling
- `remind me after tests pass` - tag the comment author after tests pass
- `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
The PR bot will only process comments in the main thread (not review comments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37607:
URL: https://github.com/apache/beam/pull/37607#issuecomment-3997224958
Reminder, please take a look at this pr: @ahmedabu98 @johnjcasey
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #37607:
URL: https://github.com/apache/beam/pull/37607#issuecomment-4089781928
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment `assign to next reviewer`:
R: @kennknowles for label java.
R: @johnjcasey for label kafka.
Available commands:
- `stop reviewer notifications` - opt out of the automated review tooling
- `remind me after tests pass` - tag the comment author after tests pass
- `waiting on author` - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add retry logic for transient commit failures in KafkaCommitOffset [beam]
Posted by "junaiddshaukat (via GitHub)" <gi...@apache.org>.
junaiddshaukat closed pull request #37607: Add retry logic for transient commit failures in KafkaCommitOffset
URL: https://github.com/apache/beam/pull/37607
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@beam.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org