/
log.go
90 lines (78 loc) · 2.14 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
// Package log provides simple functions to build an application logger based
// on the [logr.Logger] interface and the [zap] logging library.
//
// Use [New] to build the logger and [Sync] to flush buffered logs, e.g.;
//
// logger := logr.New(os.Stderr)
// defer log.Sync(logger)
// logger.Info("Hello!", "count", 10)
//
// [New] accepts multiple functional options, e.g. use [WithLevel] to specify
// the verbosity of the logger:
//
// logger := logr.New(os.Stderr, log.WithLevel(10))
//
// [logr.Logger]: https://github.com/go-logr/logr
// [zap]: https://github.com/uber-go/zap
package log
import (
"io"
"github.com/go-logr/logr"
"github.com/go-logr/zapr"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
// New returns a new logger based on the logr interface and the zap logging
// library.
func New(w io.Writer, opts ...option) logr.Logger {
options := defaults()
for _, o := range opts {
o.apply(&options)
}
var encoder zapcore.Encoder
{
var config zapcore.EncoderConfig
if options.debug {
config = zap.NewDevelopmentEncoderConfig()
} else {
config = zap.NewProductionEncoderConfig()
}
config.EncodeName = nameEncoder(options.debug)
config.EncodeTime = timeEncoder(options.debug)
config.EncodeLevel = levelEncoder(options.debug)
config.CallerKey = "caller"
if options.debug {
encoder = zapcore.NewConsoleEncoder(config)
} else {
encoder = zapcore.NewJSONEncoder(config)
}
}
core := zapcore.NewCore(
encoder,
zapcore.Lock(zapcore.AddSync(w)),
zap.NewAtomicLevelAt(zapcore.Level(-options.level)),
)
zapOpts := []zap.Option{
zap.WithCaller(true),
zap.WithClock(options.clock),
}
if options.addStack {
zapOpts = append(zapOpts, zap.AddStacktrace(zap.ErrorLevel))
}
logger := zap.New(core, zapOpts...).Named(options.name)
return zapr.NewLogger(logger)
}
// Sync flushes buffered logs.
func Sync(logger logr.Logger) {
if zl, ok := Underlying(logger); ok {
_ = zl.Core().Sync()
}
}
// Underlying returns the zap logger used as a logr sink.
func Underlying(logger logr.Logger) (*zap.Logger, bool) {
zl, ok := logger.GetSink().(zapr.Underlier)
if !ok {
return nil, false
}
return zl.GetUnderlying(), true
}