-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
glog_logger_rotate.go
297 lines (283 loc) · 8.66 KB
/
glog_logger_rotate.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.
package glog
import (
"context"
"fmt"
"strings"
"time"
"github.com/gogf/gf/v2/container/garray"
"github.com/gogf/gf/v2/encoding/gcompress"
"github.com/gogf/gf/v2/internal/intlog"
"github.com/gogf/gf/v2/os/gfile"
"github.com/gogf/gf/v2/os/gmlock"
"github.com/gogf/gf/v2/os/gtime"
"github.com/gogf/gf/v2/os/gtimer"
"github.com/gogf/gf/v2/text/gregex"
)
const (
memoryLockPrefixForRotating = "glog.rotateChecksTimely:"
)
// rotateFileBySize rotates the current logging file according to the
// configured rotation size.
func (l *Logger) rotateFileBySize(ctx context.Context, now time.Time) {
if l.config.RotateSize <= 0 {
return
}
if err := l.doRotateFile(ctx, l.getFilePath(now)); err != nil {
// panic(err)
intlog.Errorf(ctx, `%+v`, err)
}
}
// doRotateFile rotates the given logging file.
func (l *Logger) doRotateFile(ctx context.Context, filePath string) error {
memoryLockKey := "glog.doRotateFile:" + filePath
if !gmlock.TryLock(memoryLockKey) {
return nil
}
defer gmlock.Unlock(memoryLockKey)
intlog.PrintFunc(ctx, func() string {
return fmt.Sprintf(`start rotating file by size: %s, file: %s`, gfile.SizeFormat(filePath), filePath)
})
defer intlog.PrintFunc(ctx, func() string {
return fmt.Sprintf(`done rotating file by size: %s, size: %s`, gfile.SizeFormat(filePath), filePath)
})
// No backups, it then just removes the current logging file.
if l.config.RotateBackupLimit == 0 {
if err := gfile.Remove(filePath); err != nil {
return err
}
intlog.Printf(
ctx,
`%d size exceeds, no backups set, remove original logging file: %s`,
l.config.RotateSize, filePath,
)
return nil
}
// Else it creates new backup files.
var (
dirPath = gfile.Dir(filePath)
fileName = gfile.Name(filePath)
fileExtName = gfile.ExtName(filePath)
newFilePath = ""
)
// Rename the logging file by adding extra datetime information to microseconds, like:
// access.log -> access.20200326101301899002.log
// access.20200326.log -> access.20200326.20200326101301899002.log
for {
var (
now = gtime.Now()
micro = now.Microsecond() % 1000
)
if micro == 0 {
micro = 101
} else {
for micro < 100 {
micro *= 10
}
}
newFilePath = gfile.Join(
dirPath,
fmt.Sprintf(
`%s.%s%d.%s`,
fileName, now.Format("YmdHisu"), micro, fileExtName,
),
)
if !gfile.Exists(newFilePath) {
break
} else {
intlog.Printf(ctx, `rotation file exists, continue: %s`, newFilePath)
}
}
intlog.Printf(ctx, "rotating file by size from %s to %s", filePath, newFilePath)
if err := gfile.Rename(filePath, newFilePath); err != nil {
return err
}
return nil
}
// rotateChecksTimely timely checks the backups expiration and the compression.
func (l *Logger) rotateChecksTimely(ctx context.Context) {
defer gtimer.AddOnce(ctx, l.config.RotateCheckInterval, l.rotateChecksTimely)
// Checks whether file rotation not enabled.
if l.config.RotateSize <= 0 && l.config.RotateExpire == 0 {
intlog.Printf(
ctx,
"logging rotation ignore checks: RotateSize: %d, RotateExpire: %s",
l.config.RotateSize, l.config.RotateExpire.String(),
)
return
}
// It here uses memory lock to guarantee the concurrent safety.
memoryLockKey := memoryLockPrefixForRotating + l.config.Path
if !gmlock.TryLock(memoryLockKey) {
return
}
defer gmlock.Unlock(memoryLockKey)
var (
now = time.Now()
pattern = "*.log, *.gz"
files, err = gfile.ScanDirFile(l.config.Path, pattern, true)
)
if err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
intlog.Printf(ctx, "logging rotation start checks: %+v", files)
// get file name regex pattern
// access-{y-m-d}-test.log => access-$-test.log => access-\$-test\.log => access-(.+?)-test\.log
fileNameRegexPattern, _ := gregex.ReplaceString(`{.+?}`, "$", l.config.File)
fileNameRegexPattern = gregex.Quote(fileNameRegexPattern)
fileNameRegexPattern = strings.ReplaceAll(fileNameRegexPattern, "\\$", "(.+?)")
// =============================================================
// Rotation of expired file checks.
// =============================================================
if l.config.RotateExpire > 0 {
var (
mtime time.Time
subDuration time.Duration
expireRotated bool
)
for _, file := range files {
// ignore backup file
if gregex.IsMatchString(`.+\.\d{20}\.log`, gfile.Basename(file)) || gfile.ExtName(file) == "gz" {
continue
}
// ignore not matching file
if !gregex.IsMatchString(fileNameRegexPattern, file) {
continue
}
mtime = gfile.MTime(file)
subDuration = now.Sub(mtime)
if subDuration > l.config.RotateExpire {
func() {
memoryLockFileKey := memoryLockPrefixForPrintingToFile + file
if !gmlock.TryLock(memoryLockFileKey) {
return
}
defer gmlock.Unlock(memoryLockFileKey)
expireRotated = true
intlog.Printf(
ctx,
`%v - %v = %v > %v, rotation expire logging file: %s`,
now, mtime, subDuration, l.config.RotateExpire, file,
)
if err = l.doRotateFile(ctx, file); err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
}()
}
}
if expireRotated {
// Update the files array.
files, err = gfile.ScanDirFile(l.config.Path, pattern, true)
if err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
}
}
// =============================================================
// Rotated file compression.
// =============================================================
needCompressFileArray := garray.NewStrArray()
if l.config.RotateBackupCompress > 0 {
for _, file := range files {
// Eg: access.20200326101301899002.log.gz
if gfile.ExtName(file) == "gz" {
continue
}
// ignore not matching file
originalLoggingFilePath, _ := gregex.ReplaceString(`\.\d{20}`, "", file)
if !gregex.IsMatchString(fileNameRegexPattern, originalLoggingFilePath) {
continue
}
// Eg:
// access.20200326101301899002.log
if gregex.IsMatchString(`.+\.\d{20}\.log`, gfile.Basename(file)) {
needCompressFileArray.Append(file)
}
}
if needCompressFileArray.Len() > 0 {
needCompressFileArray.Iterator(func(_ int, path string) bool {
err := gcompress.GzipFile(path, path+".gz")
if err == nil {
intlog.Printf(ctx, `compressed done, remove original logging file: %s`, path)
if err = gfile.Remove(path); err != nil {
intlog.Print(ctx, err)
}
} else {
intlog.Print(ctx, err)
}
return true
})
// Update the files array.
files, err = gfile.ScanDirFile(l.config.Path, pattern, true)
if err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
}
}
// =============================================================
// Backups count limitation and expiration checks.
// =============================================================
backupFiles := garray.NewSortedArray(func(a, b interface{}) int {
// Sorted by rotated/backup file mtime.
// The older rotated/backup file is put in the head of array.
var (
file1 = a.(string)
file2 = b.(string)
result = gfile.MTimestampMilli(file1) - gfile.MTimestampMilli(file2)
)
if result <= 0 {
return -1
}
return 1
})
if l.config.RotateBackupLimit > 0 || l.config.RotateBackupExpire > 0 {
for _, file := range files {
// ignore not matching file
originalLoggingFilePath, _ := gregex.ReplaceString(`\.\d{20}`, "", file)
if !gregex.IsMatchString(fileNameRegexPattern, originalLoggingFilePath) {
continue
}
if gregex.IsMatchString(`.+\.\d{20}\.log`, gfile.Basename(file)) {
backupFiles.Add(file)
}
}
intlog.Printf(ctx, `calculated backup files array: %+v`, backupFiles)
diff := backupFiles.Len() - l.config.RotateBackupLimit
for i := 0; i < diff; i++ {
path, _ := backupFiles.PopLeft()
intlog.Printf(ctx, `remove exceeded backup limit file: %s`, path)
if err := gfile.Remove(path.(string)); err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
}
// Backups expiration checking.
if l.config.RotateBackupExpire > 0 {
var (
mtime time.Time
subDuration time.Duration
)
backupFiles.Iterator(func(_ int, v interface{}) bool {
path := v.(string)
mtime = gfile.MTime(path)
subDuration = now.Sub(mtime)
if subDuration > l.config.RotateBackupExpire {
intlog.Printf(
ctx,
`%v - %v = %v > %v, remove expired backup file: %s`,
now, mtime, subDuration, l.config.RotateBackupExpire, path,
)
if err := gfile.Remove(path); err != nil {
intlog.Errorf(ctx, `%+v`, err)
}
return true
} else {
return false
}
})
}
}
}