Skip to content

Conversation

@sjvanrossum
Copy link
Contributor

Continuing from #36075, this PR removes support for old Kafka client libraries, requiring at least Kafka 2.8.2 or newer. Note that every version of Kafka <4.0.0 still supports API protocol versions <0.10.0 and the compatibility matrix indicates that versions of Kafka >=3.0.0 would provide the best compatibility in combination with versions of Kafka >=4.0.0.

I've got another change to the poll loop queued up that leverages features only available in versions of Kafka >=3.0.0, so I'll address that compatibility bit in a following PR.

This PR leverages the Admin client to request end offsets without creating buffers like Consumer clients do. Profiling showed that Admin clients used 10% of the memory that was used by Consumer clients for end offset requests. The Admin client returns a KafkaFuture for every request which is fulfilled by an IO thread managed by the Kafka client library, thus restoring the background thread feature that was removed in #36075.

I intend to backport this change to KafkaUnboundedReader in a separate PR.


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • 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.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @sjvanrossum, I'm Gemini Code Assist1! 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 modernizes the KafkaIO connector by upgrading the minimum supported Kafka client version and refactoring how end offsets are retrieved. By switching from the Consumer client to the more efficient Admin client for offset requests, the change significantly improves memory performance and reintroduces asynchronous background processing for these operations. This update ensures better resource utilization and aligns the connector with more recent Kafka client capabilities.

Highlights

  • Kafka Version Upgrade: The minimum required Kafka client library version has been updated to 2.8.2 or newer, removing support for older versions (2.0.1, 2.3.1, 2.4.1, 2.5.1).
  • Memory Efficiency Improvement: The KafkaIO connector now leverages the Kafka Admin client instead of the Consumer client for requesting end offsets. This change significantly reduces memory usage, with profiling showing a 90% reduction for end offset requests.
  • Restored Background Thread Feature: The Admin client returns a KafkaFuture for each request, which is fulfilled by an I/O thread managed by the Kafka client library. This restores the background thread feature for offset requests that was previously removed.
  • API Modernization: New methods like withAdminFactoryFn have been added to KafkaIO.Read and KafkaIO.ReadSourceDescriptors to allow users to provide a custom Admin client factory, enhancing flexibility and supporting different Kafka Admin versions.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

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.

Customization

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.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 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.

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.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@sjvanrossum
Copy link
Contributor Author

Note that this change may break KafkaIO configurations with complex Consumer factories. A Consumer factory should not be used to alter the environment (a JvmInitializer is more fitting) or configuration (a configuration supplier property should be added). I'm actually thinking we should keep the existing implementation alongside the new and check if users have provided a custom Consumer factory and only use the new implementation when that isn't the case.

@github-actions
Copy link
Contributor

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant