logging: prune logs on startup #9012
Merged
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
dnephin
commented
Oct 22, 2020
Comment on lines
-13
to
-15
| testFileName = "Consul.log" | ||
| testDuration = 50 * time.Millisecond | ||
| testBytes = 10 |
There was a problem hiding this comment.
I removed this, because test constants like this can actually be harmful instead of helpful.
- it encourages tests which use the same values, instead of different values, which could lead to hidden bugs because only a single value is tested.
- it makes tests less obvious because the input values are hidden away instead of explicit in the test case.
schristoff
reviewed
Oct 22, 2020
| // Prune if there are more files stored than the configured max | ||
| stale = len(matches) - l.MaxFiles | ||
|
|
||
| switch { |
There was a problem hiding this comment.
Nit: A comment above this statement would be awesome, not necessary since it isn't that complicated, but would be a nice touch.
schristoff
approved these changes
Oct 22, 2020
dnephin
force-pushed
the
dnephin/log-fix-rotation
branch
from
31be934
to
653a5d7
Compare
To ensure that files are pruned before a new one is created. Also clean up the logic in pruneFiles
dnephin
force-pushed
the
dnephin/log-fix-rotation
branch
from
653a5d7
to
bc86896
Compare
Standardize naming Use stricter assertions and reduce boilerplate to make the intent of the tests more obvious. Also explicitly sort the filenames so that the correct files are pruned, and so that the tests can not flake.
dnephin
force-pushed
the
dnephin/log-fix-rotation
branch
from
bc86896
to
752e3ec
Compare
|
🍒 If backport labels were added before merging, cherry-picking will start automatically. To retroactively trigger a backport after merging, add backport labels and re-run https://circleci.com/gh/hashicorp/consul/287125. |
|
🍒✅ Cherry pick of commit 5e69cab onto |
hashicorp-ci
pushed a commit
that referenced
this pull request
Nov 23, 2020
logging: prune logs on startup
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.
The issue was reported here: https://discuss.hashicorp.com/t/log-rotate-max-files-not-working/14834
When Consul starts it creates a new log file, but it only prunes log files when
rotateis called. This could result in more thanMaxFilesnumber of log files.By calling
pruneFileson startup we not only ensure the number of files is enforced, we also get the error frompruneFilesimmediately. Normally if a log file fails to write, rotate, or prune we would not see the error anywhere, because where would it go? It can't go to logs because that would likely fail. So seeing any failures to prune on startup should help debug issues with file permissions.Also does a bunch of cleanup in both
pruneFilesand the tests forLogFile.