-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
zap.go
196 lines (161 loc) · 4.39 KB
/
zap.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
package logger
import (
"fmt"
"io"
"os"
"sync"
"github.com/smartcontractkit/chainlink/core/utils"
"github.com/pkg/errors"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
var _ Logger = &zapLogger{}
// zapLoggerConfig defines the struct that serves as config when spinning up a the zap logger
type zapLoggerConfig struct {
zap.Config
local Config
diskLogLevel zap.AtomicLevel
diskStats utils.DiskStatsProvider
diskPollConfig zapDiskPollConfig
// This is for tests only
testDiskLogLvlChan chan zapcore.Level
}
type zapLogger struct {
*zap.SugaredLogger
config zapLoggerConfig
name string
fields []interface{}
callerSkip int
pollDiskSpaceStop chan struct{}
pollDiskSpaceDone chan struct{}
}
func (cfg zapLoggerConfig) newLogger(cores ...zapcore.Core) (Logger, func() error, error) {
cfg.diskLogLevel = zap.NewAtomicLevelAt(zapcore.DebugLevel)
newCore, errWriter, err := cfg.newCore()
if err != nil {
return nil, nil, err
}
cores = append(cores, newCore)
if cfg.local.DebugLogsToDisk() {
diskCore, diskErr := cfg.newDiskCore()
if diskErr != nil {
return nil, nil, diskErr
}
cores = append(cores, diskCore)
}
core := zapcore.NewTee(cores...)
lggr := &zapLogger{
config: cfg,
pollDiskSpaceStop: make(chan struct{}),
pollDiskSpaceDone: make(chan struct{}),
SugaredLogger: zap.New(core, zap.ErrorOutput(errWriter)).Sugar(),
}
if cfg.local.DebugLogsToDisk() {
go lggr.pollDiskSpace()
}
var once sync.Once
close := func() error {
once.Do(func() {
if cfg.local.DebugLogsToDisk() {
close(lggr.pollDiskSpaceStop)
<-lggr.pollDiskSpaceDone
}
})
return lggr.Sync()
}
return lggr, close, err
}
func (cfg zapLoggerConfig) newCore() (zapcore.Core, zapcore.WriteSyncer, error) {
encoder := zapcore.NewJSONEncoder(makeEncoderConfig(cfg.local))
sink, closeOut, err := zap.Open(cfg.OutputPaths...)
if err != nil {
return nil, nil, err
}
errSink, _, err := zap.Open(cfg.ErrorOutputPaths...)
if err != nil {
closeOut()
return nil, nil, err
}
if cfg.Level == (zap.AtomicLevel{}) {
return nil, nil, errors.New("missing Level")
}
filteredLogLevels := zap.LevelEnablerFunc(cfg.Level.Enabled)
return zapcore.NewCore(encoder, sink, filteredLogLevels), errSink, nil
}
func makeEncoderConfig(cfg Config) zapcore.EncoderConfig {
encoderConfig := zap.NewProductionEncoderConfig()
if !cfg.UnixTS {
encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
}
encoderConfig.EncodeLevel = encodeLevel
return encoderConfig
}
func (l *zapLogger) SetLogLevel(lvl zapcore.Level) {
l.config.Level.SetLevel(lvl)
}
func (l *zapLogger) With(args ...interface{}) Logger {
newLogger := *l
newLogger.SugaredLogger = l.SugaredLogger.With(args...)
newLogger.fields = copyFields(l.fields, args...)
return &newLogger
}
// copyFields returns a copy of fields with add appended.
func copyFields(fields []interface{}, add ...interface{}) []interface{} {
f := make([]interface{}, 0, len(fields)+len(add))
f = append(f, fields...)
f = append(f, add...)
return f
}
func joinName(old, new string) string {
if old == "" {
return new
}
return old + "." + new
}
func (l *zapLogger) Named(name string) Logger {
newLogger := *l
newLogger.name = joinName(l.name, name)
newLogger.SugaredLogger = l.SugaredLogger.Named(name)
newLogger.Trace("Named logger created")
return &newLogger
}
func (l *zapLogger) Helper(skip int) Logger {
newLogger := *l
newLogger.SugaredLogger = l.sugaredHelper(skip)
newLogger.callerSkip += skip
return &newLogger
}
func (l *zapLogger) sugaredHelper(skip int) *zap.SugaredLogger {
return l.SugaredLogger.Desugar().WithOptions(zap.AddCallerSkip(skip)).Sugar()
}
func (l *zapLogger) ErrorIf(err error, msg string) {
if err != nil {
l.Helper(1).Errorw(msg, "err", err)
}
}
func (l *zapLogger) ErrorIfClosing(c io.Closer, name string) {
if err := c.Close(); err != nil {
l.Helper(1).Errorw(fmt.Sprintf("Error closing %s", name), "err", err)
}
}
func (l *zapLogger) Sync() error {
err := l.SugaredLogger.Sync()
if err == nil {
return nil
}
var msg string
if uw := errors.Unwrap(err); uw != nil {
msg = uw.Error()
} else {
msg = err.Error()
}
switch msg {
case os.ErrInvalid.Error(), "bad file descriptor",
"inappropriate ioctl for device":
return nil
}
return err
}
func (l *zapLogger) Recover(panicErr interface{}) {
l.Criticalw("Recovered goroutine panic", "panic", panicErr)
}