-
Notifications
You must be signed in to change notification settings - Fork 13
/
loggerconfig.go
333 lines (295 loc) · 7.76 KB
/
loggerconfig.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
package log
import (
"flag"
"io"
"os"
"path"
"strings"
"time"
"github.com/sirupsen/logrus"
"github.com/snowzach/rotatefilehook"
)
// GlobalLoggerConfig - is the default config of the logger
var GlobalLoggerConfig LoggerConfig
func init() {
GlobalLoggerConfig = LoggerConfig{
output: STDOUT,
path: ".",
cfg: rotatefilehook.RotateFileConfig{
Level: logrus.InfoLevel,
Formatter: &logrus.JSONFormatter{
TimestampFormat: time.RFC3339,
FieldMap: logrus.FieldMap{
logrus.FieldKeyMsg: "message",
},
},
},
metricCfg: rotatefilehook.RotateFileConfig{
Level: logrus.InfoLevel,
Formatter: &logrus.JSONFormatter{
TimestampFormat: time.RFC3339,
FieldMap: logrus.FieldMap{
logrus.FieldKeyMsg: "message",
},
},
},
usageCfg: rotatefilehook.RotateFileConfig{
Level: logrus.InfoLevel,
Formatter: &logrus.JSONFormatter{
TimestampFormat: time.RFC3339,
FieldMap: logrus.FieldMap{
logrus.FieldKeyMsg: "message",
},
},
},
initialized: false,
}
}
// LoggerConfig - is a builder used to setup the logging for an agent
type LoggerConfig struct {
err error
output LoggingOutput
path string
cfg rotatefilehook.RotateFileConfig
metricCfg rotatefilehook.RotateFileConfig
usageCfg rotatefilehook.RotateFileConfig
initialized bool
metricEnabled bool
usageEnabled bool
}
// Apply - applies the config changes to the logger
func (b *LoggerConfig) Apply() error {
if b.err != nil {
return b.err
}
// validate metric fields, if enabled
if b.metricEnabled {
if err := b.validateSize("log.metricfile.rotateeverybytes", b.metricCfg.MaxSize); err != nil {
return err
}
if err := b.validate0orGreater("log.metricfile.keepfiles", b.metricCfg.MaxBackups); err != nil {
return err
}
if err := b.validate0orGreater("log.metricfile.cleanbackupsevery", b.metricCfg.MaxAge); err != nil {
return err
}
}
if b.usageEnabled {
if err := b.validateSize("log.usagefile.rotateeverybytes", b.usageCfg.MaxSize); err != nil {
return err
}
if err := b.validate0orGreater("log.usagefile.keepfiles", b.usageCfg.MaxBackups); err != nil {
return err
}
if err := b.validate0orGreater("log.usagefile.cleanbackupsevery", b.usageCfg.MaxAge); err != nil {
return err
}
}
// update the log logger
log.SetFormatter(b.cfg.Formatter)
log.SetLevel(b.cfg.Level)
// update the logrus logger
logrus.SetFormatter(b.cfg.Formatter)
logrus.SetLevel(b.cfg.Level)
// Set the stdout output for the log and logrus
if b.output == STDOUT || b.output == Both {
writer := io.Writer(os.Stdout)
log.SetOutput(writer)
logrus.SetOutput(writer)
}
if !b.initialized || isLogP {
// Add the rotate file hook for log and logrus
if b.output == File || b.output == Both {
if b.path != "" {
b.cfg.Filename = path.Join(b.path, b.cfg.Filename)
}
rotateFileHook, _ := rotatefilehook.NewRotateFileHook(b.cfg)
log.AddHook(rotateFileHook)
logrus.StandardLogger().AddHook(rotateFileHook)
}
isTest := flag.Lookup("test.v") != nil
// skip metric log setup in unit tests
if !isTest && b.metricEnabled {
b.metricCfg.Filename = path.Join(b.path, "audit", b.metricCfg.Filename)
rotateMetricHook, _ := rotatefilehook.NewRotateFileHook(b.metricCfg)
metric.AddHook(rotateMetricHook)
metric.SetOutput(io.Discard) // discard logging to stderr
}
if !isTest && b.usageEnabled {
b.usageCfg.Filename = path.Join(b.path, "audit", b.usageCfg.Filename)
rotateUsageHook, _ := rotatefilehook.NewRotateFileHook(b.usageCfg)
usage.AddHook(rotateUsageHook)
usage.SetOutput(io.Discard) // discard logging to stderr
}
// Set to initialized if this is not a test
b.initialized = !isTest
}
return nil
}
// Level - sets the logger level
func (b *LoggerConfig) Level(level string) *LoggerConfig {
if b.err == nil {
lvl, err := logrus.ParseLevel(level)
if err != nil {
b.err = ErrInvalidLogConfig.FormatError("log.level", "trace, debug, info, warn, error")
}
b.cfg.Level = lvl
}
return b
}
// GetLevel - returns current log level
func (b *LoggerConfig) GetLevel() string {
return b.cfg.Level.String()
}
// Format - sets the logger formatt
func (b *LoggerConfig) Format(format string) *LoggerConfig {
if b.err == nil {
switch strings.ToLower(format) {
case loggingFormatStringMap[Line]:
b.cfg.Formatter = &logrus.TextFormatter{
TimestampFormat: time.RFC3339,
FullTimestamp: true,
PadLevelText: true,
QuoteEmptyFields: true,
DisableColors: true,
FieldMap: logrus.FieldMap{
logrus.FieldKeyMsg: "message",
},
}
case loggingFormatStringMap[JSON]:
b.cfg.Formatter = &logrus.JSONFormatter{
TimestampFormat: time.RFC3339,
FieldMap: logrus.FieldMap{
logrus.FieldKeyMsg: "message",
},
}
default:
b.err = ErrInvalidLogConfig.FormatError("log.format", "json, line")
}
}
return b
}
// Output - sets how the logs will be tracked
func (b *LoggerConfig) Output(output string) *LoggerConfig {
if b.err == nil {
if _, ok := stringLoggingOutputMap[strings.ToLower(output)]; !ok {
b.err = ErrInvalidLogConfig.FormatError("log.output", "stdout, file, both")
}
b.output = stringLoggingOutputMap[output]
}
return b
}
// Filename -
func (b *LoggerConfig) Filename(filename string) *LoggerConfig {
if b.err == nil {
b.cfg.Filename = filename
}
return b
}
// Path -
func (b *LoggerConfig) Path(path string) *LoggerConfig {
if b.err == nil {
b.path = path
}
return b
}
func (b *LoggerConfig) Metrics(enabled bool) *LoggerConfig {
if b.err == nil {
b.metricEnabled = enabled
}
return b
}
func (b *LoggerConfig) Usage(enabled bool) *LoggerConfig {
if b.err == nil {
b.usageEnabled = enabled
}
return b
}
func (b *LoggerConfig) validateSize(path string, maxSize int) error {
if maxSize < 1048576 {
return ErrInvalidLogConfig.FormatError(path, "minimum of 1048576")
}
return nil
}
func (b *LoggerConfig) validate0orGreater(path string, maxBackups int) error {
if maxBackups < 0 {
return ErrInvalidLogConfig.FormatError(path, "0 or greater")
}
return nil
}
// MaxSize -
func (b *LoggerConfig) MaxSize(maxSize int) *LoggerConfig {
if b.err == nil {
b.err = b.validateSize("log.file.rotateeverybytes", maxSize)
b.cfg.MaxSize = int(float64(maxSize) / 1024 / 1024)
}
return b
}
// MaxBackups -
func (b *LoggerConfig) MaxBackups(maxBackups int) *LoggerConfig {
if b.err == nil {
b.err = b.validate0orGreater("log.file.keepfiles", maxBackups)
b.cfg.MaxBackups = maxBackups
}
return b
}
// MaxAge -
func (b *LoggerConfig) MaxAge(maxAge int) *LoggerConfig {
if b.err == nil {
b.err = b.validate0orGreater("log.file.cleanbackupsevery", maxAge)
b.cfg.MaxAge = maxAge
}
return b
}
// Filename -
func (b *LoggerConfig) MetricFilename(filename string) *LoggerConfig {
if b.err == nil {
b.metricCfg.Filename = filename
}
return b
}
// MaxMetricSize -
func (b *LoggerConfig) MaxMetricSize(maxSize int) *LoggerConfig {
if b.err == nil {
b.metricCfg.MaxSize = maxSize
}
return b
}
// MaxMetricBackups -
func (b *LoggerConfig) MaxMetricBackups(maxBackups int) *LoggerConfig {
if b.err == nil {
b.metricCfg.MaxBackups = maxBackups
}
return b
}
// MaxAge -
func (b *LoggerConfig) MaxMetricAge(maxAge int) *LoggerConfig {
if b.err == nil {
b.metricCfg.MaxAge = maxAge
}
return b
}
func (b *LoggerConfig) UsageFilename(filename string) *LoggerConfig {
if b.err == nil {
b.usageCfg.Filename = filename
}
return b
}
func (b *LoggerConfig) MaxUsageSize(maxSize int) *LoggerConfig {
if b.err == nil {
b.usageCfg.MaxSize = maxSize
}
return b
}
func (b *LoggerConfig) MaxUsageBackups(maxBackups int) *LoggerConfig {
if b.err == nil {
b.usageCfg.MaxBackups = maxBackups
}
return b
}
func (b *LoggerConfig) MaxUsageAge(maxAge int) *LoggerConfig {
if b.err == nil {
b.usageCfg.MaxAge = maxAge
}
return b
}