Skip to content

Add Public Website documentation for RateLimiter#37949

Open
tarun-google wants to merge 8 commits intoapache:masterfrom
tarun-google:ratelimiter_doc
Open

Add Public Website documentation for RateLimiter#37949
tarun-google wants to merge 8 commits intoapache:masterfrom
tarun-google:ratelimiter_doc

Conversation

@tarun-google
Copy link
Contributor

Add Public Website documentation for RateLimiter
overview page:
Screenshot 2026-03-25 at 8 46 45 AM
Main documentation:
Screenshot 2026-03-25 at 8 49 52 AM
Screenshot 2026-03-25 at 8 50 17 AM

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.

@tarun-google tarun-google marked this pull request as ready for review March 25, 2026 15:52
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 significantly enhances the Apache Beam documentation by introducing a dedicated section on rate limiting patterns. It addresses the critical challenge of managing interactions with external systems that impose quotas in highly parallelized Beam pipelines. The new documentation provides guidance on deploying a centralized Rate Limit Service (RLS) on GKE, offers detailed code examples for both Java and Python, and explains how to integrate rate limiting with Dataflow, including its autoscaler. This addition aims to help users effectively prevent external service overload and ensure stable pipeline operations.

Highlights

  • New Rate Limiting Documentation: Introduced a comprehensive documentation page explaining rate limiting patterns in Apache Beam, including the use of a Centralized Rate Limit Service (RLS), deployment on GKE, and integration with Dataflow's autoscaler.
  • Example Code Tagging: Updated existing Java and Python example files (RateLimiterSimple.java, rate_limiter_vertex_ai.py, rate_limiter_simple.py) with [START] and [END] tags to facilitate their inclusion in the new documentation.
  • Gradle Task for Examples: Added a new exec Gradle task in examples/java/build.gradle to provide a flexible way to run any Java example by class name, with dynamic classpath configuration based on the specified runner.

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

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.

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.

@codecov
Copy link

codecov bot commented Mar 25, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 56.89%. Comparing base (298f309) to head (f8d5dd5).
⚠️ Report is 119 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master   #37949      +/-   ##
============================================
+ Coverage     56.87%   56.89%   +0.02%     
  Complexity     3417     3417              
============================================
  Files          1178     1178              
  Lines        187492   187612     +120     
  Branches       3590     3590              
============================================
+ Hits         106628   106739     +111     
- Misses        77472    77481       +9     
  Partials       3392     3392              
Flag Coverage Δ
python 80.10% <ø> (+0.01%) ⬆️

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.

@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

@tarun-google
Copy link
Contributor Author

R: @damccorm @rezarokni

@github-actions
Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

Copy link
Contributor

@damccorm damccorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks - generally LGTM, just had one comment

Copy link
Contributor

@damccorm damccorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Rerunning some checks to get a green signal, then I'll merge

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.

2 participants