-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
(Backport to 6.x) Log rotation by time interval (#8349) #8489
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| // Licensed to Elasticsearch B.V. under one or more contributor | ||
| // license agreements. See the NOTICE file distributed with | ||
| // this work for additional information regarding copyright | ||
| // ownership. Elasticsearch B.V. licenses this file to you under | ||
| // the Apache License, Version 2.0 (the "License"); you may | ||
| // not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package file | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "sort" | ||
| "strconv" | ||
| "time" | ||
| ) | ||
|
|
||
| type intervalRotator struct { | ||
| interval time.Duration | ||
| lastRotate time.Time | ||
| fileFormat string | ||
| clock clock | ||
| weekly bool | ||
| arbitrary bool | ||
| newInterval func(lastTime time.Time, currentTime time.Time) bool | ||
| } | ||
|
|
||
| type clock interface { | ||
| Now() time.Time | ||
| } | ||
|
|
||
| type realClock struct{} | ||
|
|
||
| func (realClock) Now() time.Time { | ||
| return time.Now() | ||
| } | ||
|
|
||
| func newIntervalRotator(interval time.Duration) (*intervalRotator, error) { | ||
| if interval == 0 { | ||
| return nil, nil | ||
| } | ||
| if interval < time.Second && interval != 0 { | ||
| return nil, errors.New("the minimum time interval for log rotation is 1 second") | ||
| } | ||
|
|
||
| ir := &intervalRotator{interval: (interval / time.Second) * time.Second} // drop fractional seconds | ||
| ir.initialize() | ||
| return ir, nil | ||
| } | ||
|
|
||
| func (r *intervalRotator) initialize() error { | ||
| r.clock = realClock{} | ||
|
|
||
| switch r.interval { | ||
| case time.Second: | ||
| r.fileFormat = "2006-01-02-15-04-05" | ||
| r.newInterval = newSecond | ||
| case time.Minute: | ||
| r.fileFormat = "2006-01-02-15-04" | ||
| r.newInterval = newMinute | ||
| case time.Hour: | ||
| r.fileFormat = "2006-01-02-15" | ||
| r.newInterval = newHour | ||
| case 24 * time.Hour: // calendar day | ||
| r.fileFormat = "2006-01-02" | ||
| r.newInterval = newDay | ||
| case 7 * 24 * time.Hour: // calendar week | ||
| r.fileFormat = "" | ||
| r.newInterval = newWeek | ||
| r.weekly = true | ||
| case 30 * 24 * time.Hour: // calendar month | ||
| r.fileFormat = "2006-01" | ||
| r.newInterval = newMonth | ||
| case 365 * 24 * time.Hour: // calendar year | ||
| r.fileFormat = "2006" | ||
| r.newInterval = newYear | ||
| default: | ||
| r.arbitrary = true | ||
| r.fileFormat = "2006-01-02-15-04-05" | ||
| r.newInterval = func(lastTime time.Time, currentTime time.Time) bool { | ||
| lastInterval := lastTime.Unix() / (int64(r.interval) / int64(time.Second)) | ||
| currentInterval := currentTime.Unix() / (int64(r.interval) / int64(time.Second)) | ||
| return lastInterval != currentInterval | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (r *intervalRotator) LogPrefix(filename string, modTime time.Time) string { | ||
| var t time.Time | ||
| if r.lastRotate.IsZero() { | ||
| t = modTime | ||
| } else { | ||
| t = r.lastRotate | ||
| } | ||
|
|
||
| if r.weekly { | ||
| y, w := t.ISOWeek() | ||
| return fmt.Sprintf("%s-%04d-%02d-", filename, y, w) | ||
| } | ||
| if r.arbitrary { | ||
| intervalNumber := t.Unix() / (int64(r.interval) / int64(time.Second)) | ||
| intervalStart := time.Unix(0, intervalNumber*int64(r.interval)) | ||
| return fmt.Sprintf("%s-%s-", filename, intervalStart.Format(r.fileFormat)) | ||
| } | ||
| return fmt.Sprintf("%s-%s-", filename, t.Format(r.fileFormat)) | ||
| } | ||
|
|
||
| func (r *intervalRotator) NewInterval() bool { | ||
| now := r.clock.Now() | ||
| newInterval := r.newInterval(r.lastRotate, now) | ||
| return newInterval | ||
| } | ||
|
|
||
| func (r *intervalRotator) Rotate() { | ||
| r.lastRotate = r.clock.Now() | ||
| } | ||
|
|
||
| func (r *intervalRotator) SortIntervalLogs(strings []string) { | ||
| sort.Slice( | ||
| strings, | ||
| func(i, j int) bool { | ||
| return OrderIntervalLogs(strings[i]) < OrderIntervalLogs(strings[j]) | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| // OrderIntervalLogs, when given a log filename in the form [prefix]-[formattedDate]-n | ||
| // returns the filename after zero-padding the trailing n so that foo-[date]-2 sorts | ||
| // before foo-[date]-10. | ||
| func OrderIntervalLogs(filename string) string { | ||
| index, i, err := IntervalLogIndex(filename) | ||
| if err == nil { | ||
| return filename[:i] + fmt.Sprintf("%020d", index) | ||
| } | ||
|
|
||
| return "" | ||
| } | ||
|
|
||
| // IntervalLogIndex returns n as int given a log filename in the form [prefix]-[formattedDate]-n | ||
| func IntervalLogIndex(filename string) (uint64, int, error) { | ||
| i := len(filename) - 1 | ||
| for ; i >= 0; i-- { | ||
| if '0' > filename[i] || filename[i] > '9' { | ||
| break | ||
| } | ||
| } | ||
| i++ | ||
|
|
||
| s64 := filename[i:] | ||
| u64, err := strconv.ParseUint(s64, 10, 64) | ||
| return u64, i, err | ||
| } | ||
|
|
||
| func newSecond(lastTime time.Time, currentTime time.Time) bool { | ||
| return lastTime.Second() != currentTime.Second() || newMinute(lastTime, currentTime) | ||
| } | ||
|
|
||
| func newMinute(lastTime time.Time, currentTime time.Time) bool { | ||
| return lastTime.Minute() != currentTime.Minute() || newHour(lastTime, currentTime) | ||
| } | ||
|
|
||
| func newHour(lastTime time.Time, currentTime time.Time) bool { | ||
| return lastTime.Hour() != currentTime.Hour() || newDay(lastTime, currentTime) | ||
| } | ||
|
|
||
| func newDay(lastTime time.Time, currentTime time.Time) bool { | ||
| return lastTime.Day() != currentTime.Day() || newMonth(lastTime, currentTime) | ||
| } | ||
|
|
||
| func newWeek(lastTime time.Time, currentTime time.Time) bool { | ||
| lastYear, lastWeek := lastTime.ISOWeek() | ||
| currentYear, currentWeek := currentTime.ISOWeek() | ||
| return lastWeek != currentWeek || | ||
| lastYear != currentYear | ||
| } | ||
|
|
||
| func newMonth(lastTime time.Time, currentTime time.Time) bool { | ||
| return lastTime.Month() != currentTime.Month() || newYear(lastTime, currentTime) | ||
| } | ||
|
|
||
| func newYear(lastTime time.Time, currentTime time.Time) bool { | ||
| return lastTime.Year() != currentTime.Year() | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
comment on exported function OrderIntervalLogs should be of the form "OrderIntervalLogs ..."