Skip to content

Buffer BufferedLogger by newline to avoid log splitting#39288

Open
shunping wants to merge 3 commits into
apache:masterfrom
shunping:logging-of-faulthander
Open

Buffer BufferedLogger by newline to avoid log splitting#39288
shunping wants to merge 3 commits into
apache:masterfrom
shunping:logging-of-faulthander

Conversation

@shunping

@shunping shunping commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator
  • Update BufferedLogger.Write to search for newlines and accumulate partial log lines in the builder instead of immediately emitting them as separate entries.
  • Update FlushAtDebug and FlushAtError to flush any remaining trailing text in the builder on exit or flush events.
  • Fix bug in buffered_logging_test.go where log list assertions only verified the first element of logCatcher.msgs instead of checking all gathered log messages.
  • Add TestBufferedLogger/partial_write_splitting to verify correct chunked write buffering and line assembly behavior.

Background

Previously, when the worker segvfault, the logs from fault handler will be split in different log entries in Cloud Logging UI, making them very inconvenient to read.
image

After this fix, the logs will be buffered and split by newline.
image

Internal bug id: 315054330.

* Update BufferedLogger.Write to search for newlines and accumulate
  partial log lines in the builder instead of immediately emitting
  them as separate entries.
* Update FlushAtDebug and FlushAtError to flush any remaining
  trailing text in the builder on exit or flush events.
* Fix bug in buffered_logging_test.go where log list assertions
  only verified the first element of logCatcher.msgs instead of
  checking all gathered log messages.
* Add TestBufferedLogger/partial_write_splitting to verify correct
  chunked write buffering and line assembly behavior.
@shunping

Copy link
Copy Markdown
Collaborator Author

r: @tvalentyn

@shunping shunping marked this pull request as ready for review July 10, 2026 20:17
@shunping shunping requested a review from tvalentyn July 10, 2026 20:17
@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 improves the log formatting for the BufferedLogger by introducing newline-aware buffering. Previously, logs were emitted immediately, leading to fragmented entries in the Cloud Logging UI. The changes ensure that log messages are properly assembled and split by newlines before being flushed, resulting in cleaner and more readable logs. Additionally, the test suite has been updated to be more robust in verifying log output.

Highlights

  • Log Buffering Logic: Updated BufferedLogger.Write to intelligently split input by newlines, ensuring that log entries are not fragmented in the Cloud Logging UI.
  • Flush Handling: Modified FlushAtDebug and FlushAtError to ensure any remaining partial log lines in the builder are flushed during exit or periodic flush events.
  • Test Improvements: Enhanced buffered_logging_test.go to verify all log messages rather than just the first, and added a new test case for partial write splitting.
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.

@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

@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 updates the Go SDK's BufferedLogger to properly handle partial writes by splitting incoming log messages on newlines and buffering incomplete lines. It also ensures any remaining partial lines are flushed and adds tests to verify this behavior. The review feedback suggests optimizing the line-splitting logic in the Write method to avoid unnecessary string allocations and multiple scans by using strings.IndexByte in a loop.

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.

Comment thread sdks/go/container/tools/buffered_logging.go
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