Buffer BufferedLogger by newline to avoid log splitting - #39288
Conversation
|
r: @tvalentyn |
Summary of ChangesHello, 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
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 AssistThe 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
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 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
|
|
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
tvalentyn
left a comment
tvalentyn
left a comment
There was a problem hiding this comment.
cc: @jrmccluskey as well who worked on logging before.
* 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.
- Add Flush(ctx, err) to BufferedLogger to automatically flush at ERROR on failure or DEBUG on success. - Add executeWithLogger and executeWithOutput helpers to eliminate repetitive flush boilerplate. - Unify runtime dependency log outputs into single log entries. - Add unit tests and docstrings for BufferedLogger.
bbc6f24 to
c567876
Compare
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #39288 +/- ##
=========================================
Coverage 58.12% 58.13%
Complexity 13085 13085
=========================================
Files 2521 2521
Lines 264372 264389 +17
Branches 10788 10788
=========================================
+ Hits 153669 153691 +22
+ Misses 104934 104927 -7
- Partials 5769 5771 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Thanks for reviewing and all the insightful discussion! |
2 participants
BufferedLogger.Writeto search for newlines and accumulate partial log lines in the builder instead of immediately emitting them as separate entries.FlushAtDebugandFlushAtErrorto flush any remaining trailing text in the builder on exit or flush events.buffered_logging_test.gowhere log list assertions only verified the first element oflogCatcher.msgsinstead of checking all gathered log messages.TestBufferedLogger/partial_write_splittingto 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.
After this fix, the logs will be buffered and split by newline.
Internal bug id: 315054330.