Add log rotation for debug logs #1372
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When running with --debug, logs are now automatically rotated when they exceed 10MB. Up to 3 backup files are kept (cagent.debug.log.1, .2, .3). This prevents unbounded log file growth during long running sessions. Fixes docker#1336 Assisted-By: cagent
rumpl
force-pushed
the
feature/rotate-debug-logs
branch
from
0e41c27 to
97e0b43
Compare
Member
Author
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Overall Review
Great implementation of log rotation! The code is well-structured, properly tested, and addresses the issue effectively. I have a few suggestions to improve robustness and Go idiomaticity.
Strengths
- ✅ Clean API with functional options pattern
- ✅ Comprehensive test coverage including edge cases
- ✅ Thread-safe implementation with proper mutex usage
- ✅ Good error handling throughout
- ✅ No race conditions detected
Key Recommendations
- File sync after write - Consider calling
Sync()after writes for durability - Nil file check - Add defensive check in
Write()method - Error handling in rotate - Handle file close error more robustly
- Resource cleanup - Ensure file is closed on all error paths
The changes integrate nicely with the existing codebase and solve the stated problem. With the minor improvements suggested, this will be production-ready.
dgageot
approved these changes
Jan 15, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
When running with
--debug, logs are now automatically rotated when they exceed 10MB. Up to 3 backup files are kept (cagent.debug.log.1,.2,.3).This prevents unbounded log file growth during long running sessions.
Changes
pkg/loggingpackage with aRotatingFilewritercmd/root/root.goto use the rotating writer for debug logsTesting
Fixes #1336