feat: [log retention improvements pt. 1] introduce file layout interface #2534
Conversation
This file contains 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
tedim52
force-pushed
the
tedi/granularetention
branch
from
9ca8d22 to
11449c1
Compare
tedim52
commented
Aug 16, 2024
.../engine/centralized_logs/client_implementations/persistent_volume/file_layout/file_layout.go
Show resolved
Hide resolved
h4ck3rk3y
approved these changes
Aug 16, 2024
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 16, 2024
🤖 I have created a release *beep* *boop* --- ## [1.1.0](1.0.0...1.1.0) (2024-08-16) ### Features * [log retention improvements pt. 1] introduce file layout interface ([#2534](#2534)) ([a494278](a494278)) * make kurtosis service logs faster ([#2525](#2525)) ([d6b246a](d6b246a)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: kurtosisbot <[email protected]>
4 tasks
tedim52
added a commit
that referenced
this pull request
Aug 30, 2024
… retention period (#2536) ## Description Log Retention Improvements: This PR allows users to configure log retention period with `--log-retention-period` flag on engine starts/restarts. Default is set to 1 week. - [x] PR 1: Introduce `LogFileLayout` and `PerWeekLogFileLayout` and adjust `LogFileManager` and `LogsDatabaseClient` to use this for retrieving log file paths - [x] PR 2: Make retention configurable via a CLI flag - [ ] PR 3: Implement `PerHourFileLayout` and swap storage format from `PerWeekFileLayout` to `PerHourFileLayout` - [ ] PR 4: Make `LogsAggregator` use `LogFileLayout` for determining storage format and set it to use `PerHourFileLayout` ------------------------------ ## Is this change user facing? NO ## References #2443 #2190 #2534
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.
Description
Log Retention Improvements:
Users have had issues with logs from long running enclaves taking up tons of storage. We have a retention mechanism that automatically rotates logs after some time but currently it a) is only able to rotate logs weekly b) can not be configured.
These improvements will allow retention to be as granular as hourly and will allow users to configure the retention period (eg.
1hr,2hr,1day,1week). To do this, a few changes need to happen. Most notably the way logs are stored and retrieved needs to change to support rotating log files hourly. Implementing this requires changes across a few components(LogsAggregator,LogsDatabaseClient,LogFileManager, cli, so I'll be making them incrementally.LogFileLayoutandPerWeekLogFileLayoutand adjustLogFileManagerandLogsDatabaseClientto use this for retrieving log file pathsPerHourFileLayoutand swap storage format fromPerWeekFileLayouttoPerHourFileLayoutLogsAggregatoruseLogFileLayoutfor determining storage format and set it to usePerHourFileLayoutThis first PR sets the stage for this change by introducing a new interface called
LogFileLayoutand migrating the existing storage format to use it. Right now, knowledge about the log storage format is spread across several entities (LogsAggregator- to store,LogFileManager- to rotate logs,StreamLogsStrategy- to read logs). This interface consolidates knowledge of how logs are stored into one module that can be used by any entity doing operations that require retrieving log files from the filesystem. This will make the transition to a different storage format safer (only requires implementing + testingPerHourFileLayoutmodule) and makes it easier to swap out the storage format in the future (eg. if even more granular retention is need) without breaking other entities.Is this change user facing?
NO
References
#2443
#2190