-
Notifications
You must be signed in to change notification settings - Fork 0
/
log.go
283 lines (236 loc) · 6.92 KB
/
log.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
// Package log provides a leveled, rotated, fast, structured logger.
// This package APIs Print and Fatal are compatible the standard library log.
package log
import (
"os"
"strconv"
"sync"
"time"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
lumberjack "gopkg.in/natefinch/lumberjack.v2"
)
type Logger struct {
*zap.SugaredLogger
rotator *timedRotatingWriter
}
// globalLogger will be inited env vars (detail in func newConfigFromEnv)
// All funcs in this package use globalLogger
var globalLogger *Logger = NewLogger(newConfigFromEnv())
// Config will be used for initializing a Logger
type Config struct {
LogFilePath string // default log to stdout
// default log both info and debug logs,
// change this field to true will only log info.
IsLogLevelInfo bool
// whether to log simultaneously to both stdout and file
IsNotLogBoth bool
// the maximum number of days to retain old log files, default 7
OldLogMaxDays int
// maximum size in megabytes of a log file, default 100
OneFileMaxMegabytes int
// default 24 hours (rotating once per day if size of the log file < OneFileMaxMegabytes)
RotateInterval time.Duration
// default rotate at midnight in UTC (or 7AM in Vietnam)
RotateRemainder time.Duration
// CallerSkip prevents this logger from always reporting the wrapper
// code position, default value skip 1 level (this package wrapper)
CallerSkip int
}
// newConfigFromEnv create a Config from env vars
func newConfigFromEnv() Config {
var c Config
c.LogFilePath = os.Getenv("LOG_FILE_PATH")
c.IsLogLevelInfo, _ = strconv.ParseBool(os.Getenv("LOG_LEVEL_INFO"))
c.IsNotLogBoth, _ = strconv.ParseBool(os.Getenv("LOG_NOT_STDOUT"))
c.OldLogMaxDays, _ = strconv.Atoi(os.Getenv("LOG_MAX_DAY"))
c.OneFileMaxMegabytes, _ = strconv.Atoi(os.Getenv("LOG_MAX_MB"))
c.RotateInterval = 24 * time.Hour
c.RotateRemainder = 0
c.CallerSkip = 0
return c
}
// NewLogger returns a inited Logger
func NewLogger(conf Config) *Logger {
if conf.RotateInterval == 0 {
conf.RotateInterval = 24 * time.Hour
}
ret := &Logger{}
encoderConf := zap.NewProductionEncoderConfig()
encoderConf.EncodeTime = zapcore.ISO8601TimeEncoder
encoder := zapcore.NewConsoleEncoder(encoderConf)
var writers []zapcore.WriteSyncer
stdWriter, _, _ := zap.Open("stdout")
if conf.LogFilePath == "" {
writers = []zapcore.WriteSyncer{stdWriter}
} else {
ret.rotator = newTimedRotatingWriter(conf.LogFilePath,
conf.RotateInterval, conf.RotateRemainder,
conf.OldLogMaxDays, conf.OneFileMaxMegabytes)
fileWriter := zapcore.AddSync(ret.rotator)
if conf.IsNotLogBoth {
writers = []zapcore.WriteSyncer{fileWriter}
} else { // default behavior
writers = []zapcore.WriteSyncer{stdWriter, fileWriter}
}
}
combinedWriter := zap.CombineWriteSyncers(writers...)
logLevel := zap.DebugLevel
if conf.IsLogLevelInfo {
logLevel = zap.InfoLevel
}
core := zapcore.NewCore(encoder, combinedWriter, logLevel)
zl := zap.New(core, zap.AddCaller())
zl = zl.WithOptions(zap.AddCallerSkip(1 + conf.CallerSkip))
ret.SugaredLogger = zl.Sugar()
return ret
}
func newTimedRotatingWriter(filePath string,
interval time.Duration, remainder time.Duration,
oldLogMaxDays int, oneFileMaxMegabytes int) *timedRotatingWriter {
if oldLogMaxDays <= 0 {
oldLogMaxDays = 32
}
if oneFileMaxMegabytes <= 0 {
oneFileMaxMegabytes = 100
}
base := &lumberjack.Logger{
Filename: filePath,
MaxAge: oldLogMaxDays,
MaxSize: oneFileMaxMegabytes,
}
w := &timedRotatingWriter{Logger: base, interval: interval, remainder: remainder}
w.mutex.Lock()
w.Logger.Rotate()
w.lastRotated = calcLastRotatedTime(time.Now(), w.interval, w.remainder)
w.mutex.Unlock()
return w
}
type timedRotatingWriter struct {
*lumberjack.Logger
interval time.Duration
remainder time.Duration
mutex sync.RWMutex
lastRotated time.Time
}
// SetGlobalLoggerConfig replace the globalLogger with a new logger from conf
func SetGlobalLoggerConfig(conf Config) {
globalLogger.SugaredLogger.Sync()
if globalLogger.rotator != nil {
globalLogger.rotator.close()
}
customizedLogger := NewLogger(conf)
globalLogger = customizedLogger
}
// Flush buffered log lines of globalLogger
func Flush() {
globalLogger.SugaredLogger.Sync()
}
func calcLastRotatedTime(now time.Time, interval, remainder time.Duration) time.Time {
nowUTC := now.UTC()
return nowUTC.Add(-remainder).Truncate(interval).Add(remainder)
}
func (w *timedRotatingWriter) rotateIfNeeded() error {
w.mutex.Lock()
defer w.mutex.Unlock()
if time.Since(w.lastRotated) < w.interval {
return nil
}
w.lastRotated = calcLastRotatedTime(time.Now(), w.interval, w.remainder)
err := w.Logger.Rotate()
return err
}
// Write implements io.Writer interface,
func (w *timedRotatingWriter) Write(p []byte) (int, error) {
err := w.rotateIfNeeded()
if err != nil {
return 0, err
}
// ensure no goroutine write log while rotating
w.mutex.RLock()
n, err := w.Logger.Write(p)
w.mutex.RUnlock()
return n, err
}
// close the log file
func (w *timedRotatingWriter) close() {
w.Logger.Close()
}
func Fatal(args ...interface{}) {
globalLogger.Fatal(args...)
}
func Fatalf(format string, args ...interface{}) {
globalLogger.Fatalf(format, args...)
}
func Info(args ...interface{}) {
globalLogger.Info(args...)
}
func Infof(format string, args ...interface{}) {
globalLogger.Infof(format, args...)
}
func Debug(args ...interface{}) {
globalLogger.Debug(args...)
}
func Debugf(format string, args ...interface{}) {
globalLogger.Debugf(format, args...)
}
func Print(args ...interface{}) {
globalLogger.Info(args...)
}
func Println(args ...interface{}) {
globalLogger.Info(args...)
}
func Printf(format string, args ...interface{}) {
globalLogger.Infof(format, args...)
}
func Condf(cond bool, format string, args ...interface{}) {
if cond {
globalLogger.Infof(format, args...)
}
}
// StdLogger is compatible with the standard library logger,
// This logger call the globalLogger funcs
type StdLogger struct{}
func padArgs(args []interface{}) []interface{} {
if len(args) <= 1 {
return args
}
newArgs := make([]interface{}, 2*len(args)-1)
for i, e := range args {
newArgs[2*i] = e
if i != len(args)-1 {
newArgs[2*i+1] = " "
}
}
return newArgs
}
func (l StdLogger) Print(args ...interface{}) {
globalLogger.Info(padArgs(args)...)
}
func (l StdLogger) Println(args ...interface{}) {
globalLogger.Info(padArgs(args)...)
}
func (l StdLogger) Printf(format string, args ...interface{}) {
globalLogger.Infof(format, args...)
}
func (l *StdLogger) Fatal(v ...interface{}) {
globalLogger.Fatal(padArgs(v)...)
}
func (l *StdLogger) Fatalln(v ...interface{}) {
globalLogger.Fatal(padArgs(v)...)
}
func (l *StdLogger) Fatalf(format string, v ...interface{}) {
globalLogger.Fatalf(format, v...)
}
func (l *StdLogger) Panic(v ...interface{}) {
globalLogger.Info(v...)
panic(1)
}
func (l *StdLogger) Panicf(format string, v ...interface{}) {
globalLogger.Infof(format, v...)
panic(1)
}
func (l *StdLogger) Panicln(v ...interface{}) {
globalLogger.Info(v...)
panic(1)
}