fix: backport wal corruption fix to 2.9.x #18229
Merged
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.
Backport 1954f67 from #18175
What this PR does / why we need it:
Currently a WAL corruption lead to endless restart loops, as reported in issue #12583. Users experience crashes with errors like:
and
This causes loki to crashloop indefinitely, repeatedly reading the WAL and updating object storage, which can be costly for large WALs.
This PR adds the ability to repair the WAL on startup (if possible). It also adds unit tests which corrupt the WAL and try to recover it after.
Notice that we only recover from the corruption at the TSDB WAL level. Any corruption in the data part (invalid chunks or invalid series) is unrecoverable and we just log the error and crash.
It also includes some documentation about the WAL format used for future reference.
The metric
wal_corruptions_repairs_total
is added to track whenever we fail or succeed to repair the corrupted WAL.Which issue(s) this PR fixes:
Fixes #12583
Special notes for your reviewer:
Checklist
CONTRIBUTING.md
guide (required)feat
PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.md
deprecated-config.yaml
anddeleted-config.yaml
files respectively in thetools/deprecated-config-checker
directory. Example PR