Adapt retention and rotation policy for bec_logger#1006
Open
cappel89 wants to merge 1 commit into
Open
Conversation
cappel89
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the BEC logging system to make file log rotation and retention configurable via the service configuration, addressing operational issues where log directories can grow too large due to verbose/polling clients.
Changes:
- Add configurable log rotation (by file size) and retention (by max file count and max age) with sensible defaults (50 MB, 3 files, 14 days).
- Support per-service overrides for the log file policy through
service_config.log_writer.service_overrides. - Add unit tests covering defaults, per-service overrides, validation of positive values, and behavior of rotation/retention.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
bec_lib/bec_lib/logger.py |
Implements policy resolution and a callable retention function; updates loguru sinks to rotate by size and retain by policy. |
bec_lib/bec_lib/service_config.py |
Extends the Pydantic config schema to include log rotation/retention defaults and per-service overrides with validation. |
bec_lib/tests/test_bec_logger.py |
Adds tests for policy resolution, config validation, and file rotation/retention behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+241
to
+245
| files_by_age = sorted(files, key=lambda path: (-os.stat(path).st_mtime, path)) | ||
|
|
||
| for index, path in enumerate(files_by_age): | ||
| if index >= max_archives or os.stat(path).st_mtime <= cutoff: | ||
| os.remove(path) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Our logs are regularly becoming relatively large if we are not careful with what is being logged. Recently, this happened at x10sa-bec-001, where the /var/log/bec folder was getting swamped with logs from BECClients actively polling via "read(cached=False)" commands. This obviously should not be implemented like this, I would nevertheless suggest an updated policy for rotation and retention.
The following PR adds an option to configure the retention policy optionally through the service config. This can be adapted on a per service basis, or global for all services. Per default, reasonable entries are chosen. 50MB size policy for logs, which a maximum of 3 files. So in total 150MB logs per service. In addition, a retention policy kicks in on a rotation that drops any file logs older than 14days. This second option can be discussed.
For now, I keep this PR as a draft and suggestion.