Add Support for EnvoyRateLimiter Implementation

[tarun-google]

Adding Envoy RateLimiter as a implementation of RateLimiter abstraction defined in #37547

https://pantheon.corp.google.com/dataflow/jobs/us-central1/2026-02-11_14_28_06-3806354753980489202

GitHub Actions Tests Status (on master branch)

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]

Summary of Changes

Hello @tarun-google, I'm Gemini Code Assist¹! 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 Apache Beam's I/O components by integrating support for the Envoy Rate Limit Service. This allows Beam pipelines to enforce external rate limits on operations that interact with external services, preventing overload and ensuring stable system behavior. The changes introduce a new Envoy-specific rate limiter implementation, along with supporting infrastructure for configuration, client management, and an illustrative example, making it easier for users to apply sophisticated rate limiting strategies within their data processing workflows.

Highlights

• Envoy RateLimiter Implementation: Introduced a new EnvoyRateLimiter class, implementing the RateLimiter abstraction, to enable rate limiting using an external Envoy Rate Limit Service (RLS).
• Envoy RateLimiter Factory and Context: Added EnvoyRateLimiterFactory for creating and managing Envoy-based rate limiters, and EnvoyRateLimiterContext to define the domain and descriptors for specific rate limit buckets.
• RateLimiter Client Cache: Implemented RateLimiterClientCache to efficiently manage and share gRPC channels to the Envoy RLS across multiple DoFn instances within a worker, using reference counting for proper lifecycle management.
• RateLimiter Options: Defined RateLimiterOptions to configure the address, timeout, and retry behavior for the Envoy Rate Limit Service.
• Example Usage: Provided a new example, RateLimiterSimple.java, demonstrating how to integrate and use the Envoy RateLimiter within a Beam pipeline to control external service calls.
• Build System Updates: Updated Gradle build files to include necessary dependencies for Envoy control plane API, gRPC, and AutoValue, ensuring the new components can be built and utilized.
• Comprehensive Testing: Included unit tests for EnvoyRateLimiterFactory, RateLimiterClientCache, and RateLimiterOptions to ensure the correctness and robustness of the new rate limiting components.

🧠 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 to enable Memory in your admin console.

Changelog

• buildSrc/src/main/groovy/org/apache/beam/gradle/BeamModulePlugin.groovy
  • Added envoy_control_plane_api dependency to the build configuration.
• examples/java/build.gradle
  • Added sdks:java:io:components project as an implementation dependency.
• examples/java/src/main/java/org/apache/beam/examples/RateLimiterSimple.java
  • Added a new example demonstrating the usage of EnvoyRateLimiter within a Beam pipeline.
• sdks/java/io/components/build.gradle
  • Added auto_value_annotations, envoy_control_plane_api, grpc_api, grpc_stub, and grpc_protobuf dependencies.
• sdks/java/io/components/src/main/java/org/apache/beam/sdk/io/components/ratelimiter/EnvoyRateLimiter.java
  • Added the EnvoyRateLimiter class, which implements the RateLimiter interface using an Envoy-based factory and context.
• sdks/java/io/components/src/main/java/org/apache/beam/sdk/io/components/ratelimiter/EnvoyRateLimiterContext.java
  • Added the EnvoyRateLimiterContext class, an AutoValue-generated class for defining Envoy rate limiter domains and descriptors.
• sdks/java/io/components/src/main/java/org/apache/beam/sdk/io/components/ratelimiter/EnvoyRateLimiterFactory.java
  • Added the EnvoyRateLimiterFactory class, responsible for creating Envoy rate limiters, managing gRPC communication, and handling retries and throttling signals.
• sdks/java/io/components/src/main/java/org/apache/beam/sdk/io/components/ratelimiter/RateLimiterClientCache.java
  • Added the RateLimiterClientCache class, providing a static cache for gRPC ManagedChannel instances to the Rate Limit Service with reference counting.
• sdks/java/io/components/src/main/java/org/apache/beam/sdk/io/components/ratelimiter/RateLimiterOptions.java
  • Added the RateLimiterOptions class, an AutoValue-generated class for configuring rate limiter parameters like address, max retries, and timeout.
• sdks/java/io/components/src/test/java/org/apache/beam/sdk/io/components/ratelimiter/EnvoyRateLimiterTest.java
  • Added unit tests for the EnvoyRateLimiterFactory to verify its behavior under various conditions, including successful allowance, over-limit responses, and RPC errors.
• sdks/java/io/components/src/test/java/org/apache/beam/sdk/io/components/ratelimiter/RateLimiterClientCacheTest.java
  • Added unit tests for the RateLimiterClientCache to ensure correct caching, reference counting, and concurrent access behavior.
• sdks/java/io/components/src/test/java/org/apache/beam/sdk/io/components/ratelimiter/RateLimiterOptionsTest.java
  • Added unit tests for the RateLimiterOptions class to validate its construction and argument checks.

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

[github-actions]

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

[tarun-google]

Run Java_GCP_IO_Direct PreCommit

[github-actions]

Assigning reviewers:

R: @ahmedabu98 for label java.
R: @damccorm for label build.

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

[damccorm]

/gemini review

[gemini-code-assist]

Code Review

This pull request introduces an implementation of a RateLimiter using Envoy's Rate Limit Service (RLS). The changes include the core EnvoyRateLimiterFactory, supporting classes for context and options, a client cache for gRPC channels, and an example pipeline demonstrating its usage. The implementation is well-structured and includes good practices like metrics and RPC retries. I have a few suggestions for improvement regarding error handling, retry strategies, and thread interruption handling to make it even more robust.

[damccorm]

Thanks, mostly lgtm - just had a question, along with a few minor Gemini suggestions

[damccorm]

Thanks!

[damccorm]

I'll merge once checks complete

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.98%. Comparing base (f96db37) to head (7163322).
⚠️ Report is 23 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##             master   #37573   +/-   ##
=========================================
  Coverage     56.98%   56.98%           
- Complexity     3404     3414   +10     
=========================================
  Files          1177     1177           
  Lines        187180   187203   +23     
  Branches       3581     3588    +7     
=========================================
+ Hits         106657   106682   +25     
+ Misses        77133    77132    -1     
+ Partials       3390     3389    -1     

Flag	Coverage Δ
java	71.94% <ø> (+0.02%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.