-
Notifications
You must be signed in to change notification settings - Fork 19
/
log.go
412 lines (371 loc) · 11 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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
// Copyright (c) 2022 Gobalsky Labs Limited
//
// Use of this software is governed by the Business Source License included
// in the LICENSE file and at https://www.mariadb.com/bsl11.
//
// Change Date: 18 months from the later of the date of the first publicly
// available Distribution of this version of the repository, and 25 June 2022.
//
// On the date above, in accordance with the Business Source License, use
// of this software will be governed by version 3 or later of the GNU General
// Public License.
package logging
import (
"fmt"
"strings"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
// A Level is a logging priority. Higher levels are more important.
type Level int8
// Logging levels (matching zap core internals).
const (
// DebugLevel logs are typically voluminous, and are usually disabled in
// production.
DebugLevel Level = -1
// InfoLevel is the default logging priority.
InfoLevel Level = 0
// WarnLevel logs are more important than Info, but don't need individual
// human review.
WarnLevel Level = 1
// ErrorLevel logs are high-priority. If an application is running smoothly,
// it shouldn't generate any error-level logs.
ErrorLevel Level = 2
// PanicLevel logs a message, then panics.
PanicLevel Level = 4
// FatalLevel logs a message, then calls os.Exit(1).
FatalLevel Level = 5
)
// ParseLevel parse a log level from a string.
func ParseLevel(l string) (Level, error) {
l = strings.ToLower(l)
switch l {
case "debug":
return DebugLevel, nil
case "info":
return InfoLevel, nil
case "warning":
return WarnLevel, nil
case "error":
return ErrorLevel, nil
case "panic":
return PanicLevel, nil
case "fatal":
return FatalLevel, nil
default:
return Level(100), fmt.Errorf("log level \"%s\" is not supported", l)
}
}
// String marshal a log level to a string representation.
func (l Level) String() string {
switch l {
case DebugLevel:
return "Debug"
case InfoLevel:
return "Info"
case WarnLevel:
return "Warning"
case ErrorLevel:
return "Error"
case PanicLevel:
return "Panic"
case FatalLevel:
return "Fatal"
default:
return "Unknown"
}
}
// ZapLevel return the log level of internal zap level.
func (l *Level) ZapLevel() zapcore.Level {
return zapcore.Level(*l)
}
// Logger is an abstraction on to of the zap logger.
type Logger struct {
*zap.Logger
config *zap.Config
environment string
name string
}
func (log *Logger) ToSugared() *zap.SugaredLogger {
return log.WithOptions(zap.AddCallerSkip(1)).Sugar()
}
// Clone will clone the internal logger.
func (log *Logger) Clone() *Logger {
newConfig := cloneConfig(log.config)
newLogger, err := newConfig.Build()
if err != nil {
panic(err)
}
return New(newLogger, newConfig, log.environment, log.name)
}
// GetLevel returns the log level.
func (log *Logger) GetLevel() Level {
return (Level)(log.config.Level.Level())
}
// IsDebug returns true if logger level is less or equal to DebugLevel.
func (log *Logger) IsDebug() bool {
return log.GetLevel() <= DebugLevel
}
// GetLevelString return a string representation of the current
// log level.
func (log *Logger) GetLevelString() string {
return log.config.Level.String()
}
// GetEnvironment returns the current environment name.
func (log *Logger) GetEnvironment() string {
return log.environment
}
// GetName return the name of this logger.
func (log *Logger) GetName() string {
return log.name
}
// Named instantiate a new logger by cloning it first
// and name it with the string specified.
func (log *Logger) Named(name string) *Logger {
var (
c = log.Clone()
newName string
)
if log.name == "" || log.name == "root" {
newName = name
} else {
newName = fmt.Sprintf("%s.%s", log.name, name)
}
c.Logger = c.Logger.Named(newName)
c.name = newName
return c
}
// New instantiate a new logger.
func New(zaplogger *zap.Logger, zapconfig *zap.Config, environment, name string) *Logger {
return &Logger{
Logger: zaplogger,
config: zapconfig,
environment: environment,
name: name,
}
}
// SetLevel change the level of this logger.
func (log *Logger) SetLevel(level Level) {
lvl := (zapcore.Level)(level)
if log.config.Level.Level() == lvl {
return
}
log.config.Level.SetLevel(lvl)
}
// With will add default field to each logs.
func (log *Logger) With(fields ...zap.Field) *Logger {
c := log.Clone()
c.Logger = c.Logger.With(fields...)
return c
}
// AtExit flushes the logs before exiting the process. Useful when an
// app shuts down so we store all logging possible. This is meant to be used
// with defer when initializing your logger.
func (log *Logger) AtExit() {
if log.Logger != nil {
log.Logger.Sync()
}
}
func cloneConfig(cfg *zap.Config) *zap.Config {
c := zap.Config{
Level: zap.NewAtomicLevelAt(cfg.Level.Level()),
Development: cfg.Development,
DisableCaller: cfg.DisableCaller,
DisableStacktrace: cfg.DisableStacktrace,
Sampling: nil,
Encoding: cfg.Encoding,
EncoderConfig: cfg.EncoderConfig,
OutputPaths: cfg.OutputPaths,
ErrorOutputPaths: cfg.ErrorOutputPaths,
InitialFields: make(map[string]interface{}),
}
for k, v := range cfg.InitialFields {
c.InitialFields[k] = v
}
if cfg.Sampling != nil {
c.Sampling = &zap.SamplingConfig{
Initial: cfg.Sampling.Initial,
Thereafter: cfg.Sampling.Thereafter,
}
}
return &c
}
// newLoggerFromConfig creates a logger according to the given custom config.
func newLoggerFromConfig(config Config) *Logger {
encoderConfig := zapcore.EncoderConfig{
CallerKey: config.Custom.ZapEncoder.CallerKey,
LevelKey: config.Custom.ZapEncoder.LevelKey,
LineEnding: config.Custom.ZapEncoder.LineEnding,
MessageKey: config.Custom.ZapEncoder.MessageKey,
NameKey: config.Custom.ZapEncoder.NameKey,
TimeKey: config.Custom.ZapEncoder.TimeKey,
}
encoderConfig.EncodeCaller.UnmarshalText([]byte(config.Custom.ZapEncoder.EncodeCaller))
encoderConfig.EncodeDuration.UnmarshalText([]byte(config.Custom.ZapEncoder.EncodeDuration))
encoderConfig.EncodeLevel.UnmarshalText([]byte(config.Custom.ZapEncoder.EncodeLevel))
encoderConfig.EncodeName.UnmarshalText([]byte(config.Custom.ZapEncoder.EncodeName))
encoderConfig.EncodeTime.UnmarshalText([]byte(config.Custom.ZapEncoder.EncodeTime))
zapconfig := zap.Config{
Level: zap.NewAtomicLevelAt(zapcore.Level(config.Custom.Zap.Level)),
Development: config.Custom.Zap.Development,
Encoding: config.Custom.Zap.Encoding,
EncoderConfig: encoderConfig,
OutputPaths: config.Custom.Zap.OutputPaths,
ErrorOutputPaths: config.Custom.Zap.ErrorOutputPaths,
}
zaplogger, err := zapconfig.Build()
if err != nil {
panic(err)
}
zaplogger = zaplogger.Named("root")
return New(zaplogger, &zapconfig, config.Environment, "root")
}
// NewDevLogger creates a new logger suitable for development environments.
func NewDevLogger() *Logger {
config := Config{
Environment: "dev",
Custom: &Custom{
Zap: &Zap{
Development: true,
Encoding: "console",
Level: DebugLevel,
OutputPaths: []string{"stdout"},
ErrorOutputPaths: []string{"stderr"},
},
ZapEncoder: &ZapEncoder{
CallerKey: "C",
EncodeCaller: "short",
EncodeDuration: "string",
EncodeLevel: "capital",
EncodeName: "full",
EncodeTime: "iso8601",
LevelKey: "L",
LineEnding: "\n",
MessageKey: "M",
NameKey: "N",
TimeKey: "T",
},
},
}
return newLoggerFromConfig(config)
}
// NewTestLogger creates a new logger suitable for golang unit test
// environments, ie when running "go test ./...".
func NewTestLogger() *Logger {
config := Config{
Environment: "test",
Custom: &Custom{
Zap: &Zap{
Development: true,
Encoding: "console",
Level: DebugLevel,
OutputPaths: []string{"stdout"},
ErrorOutputPaths: []string{"stderr"},
},
ZapEncoder: &ZapEncoder{
CallerKey: "C",
EncodeCaller: "short",
EncodeDuration: "string",
EncodeLevel: "capital",
EncodeName: "full",
EncodeTime: "iso8601",
LevelKey: "L",
LineEnding: "\n",
MessageKey: "M",
NameKey: "N",
TimeKey: "T",
},
},
}
return newLoggerFromConfig(config)
}
// NewProdLogger creates a new logger suitable for production environments,
// including sending logs to ElasticSearch.
func NewProdLogger() *Logger {
config := Config{
Environment: "prod",
Custom: &Custom{
Zap: &Zap{
Development: false,
Encoding: "json",
Level: InfoLevel,
OutputPaths: []string{"stdout"},
ErrorOutputPaths: []string{"stderr"},
},
ZapEncoder: &ZapEncoder{
CallerKey: "caller",
EncodeCaller: "short",
EncodeDuration: "string",
EncodeLevel: "lowercase",
EncodeName: "full",
EncodeTime: "iso8601",
LevelKey: "level",
LineEnding: "\n",
MessageKey: "message",
NameKey: "logger",
TimeKey: "@timestamp",
},
},
}
return newLoggerFromConfig(config)
}
// NewLoggerFromConfig creates a standard or custom logger.
func NewLoggerFromConfig(config Config) *Logger {
switch config.Environment {
case "dev":
return NewDevLogger()
case "test":
return NewTestLogger()
case "prod":
return NewProdLogger()
case "custom":
return newLoggerFromConfig(config)
}
// Default:
return NewDevLogger()
}
// Check helps avoid spending CPU time on log entries that will never be printed.
func (log *Logger) Check(l Level) bool {
return log.Logger.Check(l.ZapLevel(), "") != nil
}
// Errorf implement badger interface.
func (log *Logger) Errorf(s string, args ...interface{}) {
if ce := log.Logger.Check(zap.ErrorLevel, ""); ce != nil {
log.Logger.WithOptions(zap.AddCallerSkip(2)).Sugar().Errorf(strings.TrimSpace(s), args...)
}
}
// Warningf implement badger interface.
func (log *Logger) Warningf(s string, args ...interface{}) {
if ce := log.Logger.Check(zap.WarnLevel, ""); ce != nil {
log.Logger.WithOptions(zap.AddCallerSkip(2)).Sugar().Warnf(strings.TrimSpace(s), args...)
}
}
// Infof implement badger interface.
func (log *Logger) Infof(s string, args ...interface{}) {
if ce := log.Logger.Check(zap.InfoLevel, ""); ce != nil {
log.Logger.WithOptions(zap.AddCallerSkip(2)).Sugar().Infof(strings.TrimSpace(s), args...)
}
}
// Debugf implement badger interface.
func (log *Logger) Debugf(s string, args ...interface{}) {
if ce := log.Logger.Check(zap.DebugLevel, ""); ce != nil {
log.Logger.WithOptions(zap.AddCallerSkip(2)).Sugar().Debugf(strings.TrimSpace(s), args...)
}
}
type ZapGooseLogger struct {
zap.SugaredLogger
}
func (l *ZapGooseLogger) Print(v ...interface{}) {
l.Info(v...)
}
func (l *ZapGooseLogger) Println(v ...interface{}) {
l.Info(v...)
}
func (l *ZapGooseLogger) Printf(format string, v ...interface{}) {
// l.Logger.WithOptions(zap.AddCallerSkip(2))
l.Infof(strings.TrimSpace(format), v...)
}
func (log *Logger) GooseLogger() *ZapGooseLogger {
gl := log.Logger.WithOptions(zap.AddCallerSkip(2)).Sugar()
return &ZapGooseLogger{SugaredLogger: *gl}
}