fix(diagnostics): handle log rotation races #8215
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
| This pull request does not have a backport label. Could you fix it @andrewkroh? 🙏
|
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files.
andrewkroh force-pushed the fix/diag-zip-log-rotatation-race branch from d48294a to f1188bc Compare 
pierrehilbert added the Team:Elastic-Agent-Control-Plane 
| Pinging @elastic/elastic-agent-control-plane (Team:Elastic-Agent-Control-Plane) |
pkoutsovasilis added the backport-active-all 
pkoutsovasilis previously approved these changes May 23, 2025
There was a problem hiding this comment.
aside a nit about non-relevant to this PR linter issue this LGTM, thanks for handling it @andrewkroh 🙂 Also since this is a bug-fix I added the backport to all active branches
|
💚 Build Succeeded
History
cc @andrewkroh |
| @Mergifyio backport 8.17 8.18 8.19 9.0 |
✅ Backports have been created
|
mergify bot pushed a commit that referenced this pull request May 23, 2025
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files. Also, address and unrelated linter warning by using fmt.Fprintf. (cherry picked from commit 751acc1)
mergify bot pushed a commit that referenced this pull request May 23, 2025
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files. Also, address and unrelated linter warning by using fmt.Fprintf. (cherry picked from commit 751acc1)
8 tasks
mergify bot pushed a commit that referenced this pull request May 23, 2025
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files. Also, address and unrelated linter warning by using fmt.Fprintf. (cherry picked from commit 751acc1)
This was referenced May 23, 2025
mergify bot pushed a commit that referenced this pull request May 23, 2025
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files. Also, address and unrelated linter warning by using fmt.Fprintf. (cherry picked from commit 751acc1)
8 tasks
andrewkroh added a commit that referenced this pull request May 26, 2025
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files. Also, address and unrelated linter warning by using fmt.Fprintf. (cherry picked from commit 751acc1) Co-authored-by: Andrew Kroh <andrew.kroh@elastic.co>
andrewkroh added a commit that referenced this pull request May 26, 2025
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files. Also, address and unrelated linter warning by using fmt.Fprintf. (cherry picked from commit 751acc1) Co-authored-by: Andrew Kroh <andrew.kroh@elastic.co>
andrewkroh added a commit that referenced this pull request May 26, 2025
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files. Also, address and unrelated linter warning by using fmt.Fprintf. (cherry picked from commit 751acc1) Co-authored-by: Andrew Kroh <andrew.kroh@elastic.co>
andrewkroh added a commit that referenced this pull request May 26, 2025
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when `filepath.WalkDir` reads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive. To handle this, `fs.ErrNotExist` errors are ignored when attempting to add log files. Also, address and unrelated linter warning by using fmt.Fprintf. (cherry picked from commit 751acc1) Co-authored-by: Andrew Kroh <andrew.kroh@elastic.co>
v1v added a commit to v1v/elastic-agent that referenced this pull request May 27, 2025
* main: chore: Update to elastic/beats@c51fee3a852e (elastic#8246) chore: Update to elastic/beats@82f47f73acbd (elastic#8239) Fix minor typo in beats update job (elastic#8233) fix(diagnostics): handle log rotation races (elastic#8215) Fix some minor issues with the beats version update job (elastic#8224) [main][Automation] Update elastic/beats to 9382cc20546b (elastic#8222) Automatically update beats module versions (elastic#8174) chore: deps(ironbank): Bump ubi version to 9.6 (elastic#8218)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 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.
What does this PR do?
Handle a race condition that can occur in Agent diagnostics if log rotation happens while logs are being zipped. There is a time window between when
filepath.WalkDirreads the directory contents and when log files are opened for reading. During this time window, log rotation can happen, resulting in files that no longer exist and cannot be added to the diagnostic archive.To handle this,
fs.ErrNotExisterrors are ignored when attempting to add log files.Why is it important?
This race can happen at any time, so any user could be affected. The problem is worse if debug logging is enabled and logs are being rotated quickly.
Checklist
./changelog/fragmentsusing the changelog toolScreenshots
This is the user reported error:
via OCR, it says:
Disruptive User Impact
How to test this PR locally
Related issues
Questions to ask yourself