Skip to content

Fix a memory leak in the failed instruction id cache.#39405

Merged
tvalentyn merged 2 commits into
apache:masterfrom
tvalentyn:instructions_cache
Jul 21, 2026
Merged

Fix a memory leak in the failed instruction id cache.#39405
tvalentyn merged 2 commits into
apache:masterfrom
tvalentyn:instructions_cache

Conversation

@tvalentyn

@tvalentyn tvalentyn commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Sanitize the exception message stored for failed instructions to limit RAM growth.

Storing the original exception in the cache inadvertently captures stack frames and local variables, such as BundleProcessor objects, in the heap.

Drive by: decrease failed instruction ID cache size, and cap its growth by limiting exception message length.

fixes: #39406

internal reference: b/531440331


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.

…d inadvertently capturing the content of stack frames in the heap and limit RAM growth due to cache size.
@gemini-code-assist

Copy link
Copy Markdown
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 addresses a potential memory leak in the SDK worker's failed instruction cache. By capping the cache size and sanitizing the stored exception information—specifically by truncating excessively long error messages and tracebacks—the change ensures more stable memory usage during instruction failures.

Highlights

  • Memory Optimization: Reduced the maximum number of failed instructions stored in the cache from 10,000 to 1,000 to limit memory growth.
  • Exception Sanitization: Implemented truncation for exception messages and tracebacks stored in the failed instruction cache to prevent heap memory issues.
  • Testing: Added unit tests to verify that the cache size is correctly capped and that long exception tracebacks are properly truncated.
New Features

🧠 You can now enable Memory (public preview) 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 the 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 counterproductive. 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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request improves the memory management of the BundleProcessorCache by reducing the maximum number of stored failed instructions and implementing truncation for exception tracebacks. Unit tests were added to verify the cache size limits and traceback truncation logic. A valid review comment identified a potential compatibility issue with traceback.format_exception in Python versions prior to 3.10, providing a necessary fix to ensure backward compatibility.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

processor = None
with self._lock:
self.failed_instruction_ids[instruction_id] = exception
tb_str = "".join(traceback.format_exception(exception))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

In Python versions prior to 3.10, traceback.format_exception does not accept a single exception object as a positional argument and will raise a TypeError (missing value and tb arguments). Since Apache Beam supports Python 3.8 and 3.9, you should pass type(exception), exception, exception.__traceback__ to maintain backward compatibility.

      tb_str = "".join(
          traceback.format_exception(
              type(exception), exception, exception.__traceback__))

@tvalentyn

Copy link
Copy Markdown
Contributor Author

R: @damccorm

@github-actions

Copy link
Copy Markdown
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

@tvalentyn
tvalentyn merged commit 7bc2fb4 into apache:master Jul 21, 2026
99 checks passed
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.

[Bug]: Memory leak in Apache Beam Python SDK 2.67.0 - 2.75.0

2 participants