/
zap_disk_logging.go
186 lines (152 loc) · 4.73 KB
/
zap_disk_logging.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
package logger
import (
"errors"
"sync"
"time"
"github.com/smartcontractkit/chainlink/core/utils"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"gopkg.in/natefinch/lumberjack.v2"
)
const (
// `Fatal` is the max log level allowed, so log levels like `Panic` or `Critical` won't be logged to disk if this is set.
disabledLevel = zapcore.FatalLevel + 1
diskPollInterval = 1 * time.Minute
)
type zapDiskPollConfig struct {
stop func()
pollChan <-chan time.Time
}
func newDiskPollConfig(interval time.Duration) zapDiskPollConfig {
ticker := time.NewTicker(utils.WithJitter(interval))
return zapDiskPollConfig{
pollChan: ticker.C,
stop: ticker.Stop,
}
}
var _ Logger = &zapDiskLogger{}
// zapDiskLoggerConfig defines the struct that serves as config when spinning up a the zap logger
type zapDiskLoggerConfig struct {
local Config
diskStats utils.DiskStatsProvider
diskPollConfig zapDiskPollConfig
// This is for tests only
testDiskLogLvlChan chan zapcore.Level
}
func (cfg zapDiskLoggerConfig) newDiskCore(diskLogLevel zap.AtomicLevel) (zapcore.Core, error) {
availableSpace, err := cfg.diskStats.AvailableSpace(cfg.local.Dir)
if err != nil || availableSpace < cfg.local.RequiredDiskSpace() {
// Won't log to disk if the directory is not found or there's not enough disk space
diskLogLevel.SetLevel(disabledLevel)
}
var (
encoder = zapcore.NewConsoleEncoder(makeEncoderConfig(cfg.local))
sink = zapcore.AddSync(&lumberjack.Logger{
Filename: cfg.local.logFileURI(),
MaxSize: cfg.local.FileMaxSizeMB,
MaxAge: cfg.local.FileMaxAgeDays,
MaxBackups: cfg.local.FileMaxBackups,
Compress: true,
})
allLogLevels = zap.LevelEnablerFunc(diskLogLevel.Enabled)
)
return zapcore.NewCore(encoder, sink, allLogLevels), nil
}
type zapDiskLogger struct {
zapLogger
config zapDiskLoggerConfig
diskLogLevel zap.AtomicLevel
pollDiskSpaceStop chan struct{}
pollDiskSpaceDone chan struct{}
}
func (cfg zapDiskLoggerConfig) newLogger(zcfg zap.Config, cores ...zapcore.Core) (Logger, func() error, error) {
newCore, errWriter, err := cfg.newCore(zcfg)
if err != nil {
return nil, nil, err
}
cores = append(cores, newCore)
diskLogLevel := zap.NewAtomicLevelAt(zapcore.DebugLevel)
if cfg.local.DebugLogsToDisk() {
diskCore, diskErr := cfg.newDiskCore(diskLogLevel)
if diskErr != nil {
return nil, nil, diskErr
}
cores = append(cores, diskCore)
}
core := zapcore.NewTee(cores...)
lggr := &zapDiskLogger{
config: cfg,
pollDiskSpaceStop: make(chan struct{}),
pollDiskSpaceDone: make(chan struct{}),
zapLogger: zapLogger{
level: zcfg.Level,
SugaredLogger: zap.New(core, zap.ErrorOutput(errWriter), zap.AddCaller(), zap.AddStacktrace(zapcore.ErrorLevel)).Sugar(),
},
diskLogLevel: diskLogLevel,
}
if cfg.local.DebugLogsToDisk() {
go lggr.pollDiskSpace()
}
var once sync.Once
closeLogger := func() error {
once.Do(func() {
if cfg.local.DebugLogsToDisk() {
close(lggr.pollDiskSpaceStop)
<-lggr.pollDiskSpaceDone
}
})
return lggr.Sync()
}
return lggr, closeLogger, err
}
func (cfg zapDiskLoggerConfig) newCore(zcfg zap.Config) (zapcore.Core, zapcore.WriteSyncer, error) {
encoder := zapcore.NewJSONEncoder(makeEncoderConfig(cfg.local))
sink, closeOut, err := zap.Open(zcfg.OutputPaths...)
if err != nil {
return nil, nil, err
}
errSink, _, err := zap.Open(zcfg.ErrorOutputPaths...)
if err != nil {
closeOut()
return nil, nil, err
}
if zcfg.Level == (zap.AtomicLevel{}) {
return nil, nil, errors.New("missing Level")
}
filteredLogLevels := zap.LevelEnablerFunc(zcfg.Level.Enabled)
return zapcore.NewCore(encoder, sink, filteredLogLevels), errSink, nil
}
func (l *zapDiskLogger) pollDiskSpace() {
defer l.config.diskPollConfig.stop()
defer close(l.pollDiskSpaceDone)
for {
select {
case <-l.pollDiskSpaceStop:
return
case <-l.config.diskPollConfig.pollChan:
lvl := zapcore.DebugLevel
diskUsage, err := l.config.diskStats.AvailableSpace(l.config.local.Dir)
if err != nil {
// Will no longer log to disk
lvl = disabledLevel
l.Warnw("Error getting disk space available for logging", "err", err)
} else if diskUsage < l.config.local.RequiredDiskSpace() {
// Will no longer log to disk
lvl = disabledLevel
l.Warnf(
"Disk space is not enough to log into disk any longer, required disk space: %s, Available disk space: %s",
l.config.local.RequiredDiskSpace(),
diskUsage,
)
}
lvlBefore := l.diskLogLevel.Level()
l.diskLogLevel.SetLevel(lvl)
if lvlBefore == disabledLevel && lvl == zapcore.DebugLevel {
l.Info("Resuming disk logs, disk has enough space")
}
if l.config.testDiskLogLvlChan != nil {
l.config.testDiskLogLvlChan <- lvl
}
}
}
}