forked from benthosdev/benthos
/
modular.go
396 lines (348 loc) · 10.5 KB
/
modular.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
// Copyright (c) 2014 Ashley Jeffs
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, sub to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package log
import (
"encoding/json"
"fmt"
"io"
"io/ioutil"
"strconv"
"strings"
"time"
)
//------------------------------------------------------------------------------
// Logger level constants
const (
LogOff int = 0
LogFatal int = 1
LogError int = 2
LogWarn int = 3
LogInfo int = 4
LogDebug int = 5
LogTrace int = 6
LogAll int = 7
)
// intToLogLevel converts an integer into a human readable log level.
func intToLogLevel(i int) string {
switch i {
case LogOff:
return "OFF"
case LogFatal:
return "FATAL"
case LogError:
return "ERROR"
case LogWarn:
return "WARN"
case LogInfo:
return "INFO"
case LogDebug:
return "DEBUG"
case LogTrace:
return "TRACE"
case LogAll:
return "ALL"
}
return "ALL"
}
// logLevelToInt converts a human readable log level into an integer value.
func logLevelToInt(level string) int {
levelUpper := strings.ToUpper(level)
switch levelUpper {
case "OFF":
return LogOff
case "FATAL":
return LogFatal
case "ERROR":
return LogError
case "WARN":
return LogWarn
case "INFO":
return LogInfo
case "DEBUG":
return LogDebug
case "TRACE":
return LogTrace
case "ALL":
return LogAll
}
return -1
}
//------------------------------------------------------------------------------
// Config holds configuration options for a logger object.
type Config struct {
Prefix string `json:"prefix" yaml:"prefix"`
LogLevel string `json:"level" yaml:"level"`
AddTimeStamp bool `json:"add_timestamp" yaml:"add_timestamp"`
JSONFormat bool `json:"json_format" yaml:"json_format"`
StaticFields map[string]string `json:"static_fields" yaml:"static_fields"`
}
// NewConfig returns a config struct with the default values for each field.
func NewConfig() Config {
return Config{
Prefix: "benthos",
LogLevel: "INFO",
AddTimeStamp: true,
JSONFormat: true,
StaticFields: map[string]string{
"@service": "benthos",
},
}
}
//------------------------------------------------------------------------------
// UnmarshalJSON ensures that when parsing configs that are in a slice the
// default values are still applied.
func (l *Config) UnmarshalJSON(bytes []byte) error {
type confAlias Config
aliased := confAlias(NewConfig())
defaultFields := aliased.StaticFields
aliased.StaticFields = nil
if err := json.Unmarshal(bytes, &aliased); err != nil {
return err
}
if aliased.StaticFields == nil {
aliased.StaticFields = defaultFields
}
*l = Config(aliased)
return nil
}
// UnmarshalYAML ensures that when parsing configs that are in a slice the
// default values are still applied.
func (l *Config) UnmarshalYAML(unmarshal func(interface{}) error) error {
type confAlias Config
aliased := confAlias(NewConfig())
defaultFields := aliased.StaticFields
aliased.StaticFields = nil
if err := unmarshal(&aliased); err != nil {
return err
}
if aliased.StaticFields == nil {
aliased.StaticFields = defaultFields
}
*l = Config(aliased)
return nil
}
//------------------------------------------------------------------------------
// Logger is an object with support for levelled logging and modular components.
type Logger struct {
stream io.Writer
config Config
level int
staticFieldsRaw string
}
// New creates and returns a new logger object.
func New(stream io.Writer, config Config) Modular {
logger := Logger{
stream: stream,
config: config,
level: logLevelToInt(config.LogLevel),
}
if len(config.StaticFields) > 0 {
jBytes, _ := json.Marshal(config.StaticFields)
if len(jBytes) > 2 {
logger.staticFieldsRaw = string(jBytes[1:len(jBytes)-1]) + ","
}
}
return &logger
}
//------------------------------------------------------------------------------
// Noop creates and returns a new logger object that writes nothing.
func Noop() Modular {
return &Logger{
stream: ioutil.Discard,
config: NewConfig(),
level: LogOff,
}
}
// NewModule creates a new logger object from the previous, using the same
// configuration, but adds an extra prefix to represent a submodule.
func (l *Logger) NewModule(prefix string) Modular {
config := l.config
config.Prefix = fmt.Sprintf("%v%v", config.Prefix, prefix)
return &Logger{
stream: l.stream,
config: config,
level: l.level,
staticFieldsRaw: l.staticFieldsRaw,
}
}
// WithFields returns a logger with new fields added to the JSON formatted
// output.
func (l *Logger) WithFields(fields map[string]string) Modular {
newConfig := l.config
newConfig.StaticFields = fields
for k, v := range l.config.StaticFields {
if _, exists := fields[k]; !exists {
newConfig.StaticFields[k] = v
}
}
var staticFieldsRaw string
if len(newConfig.StaticFields) > 0 {
jBytes, _ := json.Marshal(newConfig.StaticFields)
if len(jBytes) > 2 {
staticFieldsRaw = string(jBytes[1:len(jBytes)-1]) + ","
}
}
return &Logger{
stream: l.stream,
config: newConfig,
level: l.level,
staticFieldsRaw: staticFieldsRaw,
}
}
// WithFields attempts to cast the Modular implementation into an interface that
// implements WithFields, and if successful returns the result.
func WithFields(l Modular, fields map[string]string) Modular {
return l.WithFields(fields)
}
//------------------------------------------------------------------------------
// writeFormatted prints a log message with any configured extras prepended.
func (l *Logger) writeFormatted(message string, level string, other ...interface{}) {
if l.config.JSONFormat {
message = strings.TrimSuffix(message, "\n")
if l.config.AddTimeStamp {
fmt.Fprintf(
l.stream,
"{\"@timestamp\":\"%v\",%v\"level\":\"%v\",\"component\":\"%v\",\"message\":%v}\n",
time.Now().Format(time.RFC3339), l.staticFieldsRaw, level, l.config.Prefix,
strconv.QuoteToASCII(fmt.Sprintf(message, other...)),
)
} else {
fmt.Fprintf(
l.stream,
"{%v\"level\":\"%v\",\"component\":\"%v\",\"message\":%v}\n",
l.staticFieldsRaw, level, l.config.Prefix,
strconv.QuoteToASCII(fmt.Sprintf(message, other...)),
)
}
} else {
if l.config.AddTimeStamp {
fmt.Fprintf(l.stream, fmt.Sprintf(
"%v | %v | %v | %v",
time.Now().Format(time.RFC3339), level, l.config.Prefix, message,
), other...)
} else {
fmt.Fprintf(l.stream, fmt.Sprintf(
"%v | %v | %v", level, l.config.Prefix, message,
), other...)
}
}
}
// writeLine prints a log message with any configured extras prepended.
func (l *Logger) writeLine(message string, level string) {
if l.config.JSONFormat {
if l.config.AddTimeStamp {
fmt.Fprintf(l.stream,
"{\"@timestamp\":\"%v\",%v\"level\":\"%v\",\"component\":\"%v\",\"message\":%v}\n",
time.Now().Format(time.RFC3339), l.staticFieldsRaw, level,
l.config.Prefix, strconv.QuoteToASCII(message),
)
} else {
fmt.Fprintf(l.stream,
"{%v\"level\":\"%v\",\"component\":\"%v\",\"message\":%v}\n",
l.staticFieldsRaw, level, l.config.Prefix,
strconv.QuoteToASCII(message),
)
}
} else {
if l.config.AddTimeStamp {
fmt.Fprintf(
l.stream, "%v | %v | %v | %v\n",
time.Now().Format(time.RFC3339), level, l.config.Prefix, message,
)
} else {
fmt.Fprintf(l.stream, "%v | %v | %v\n", level, l.config.Prefix, message)
}
}
}
//------------------------------------------------------------------------------
// Fatalf prints a fatal message to the console. Does NOT cause panic.
func (l *Logger) Fatalf(format string, v ...interface{}) {
if LogFatal <= l.level {
l.writeFormatted(format, "FATAL", v...)
}
}
// Errorf prints an error message to the console.
func (l *Logger) Errorf(format string, v ...interface{}) {
if LogError <= l.level {
l.writeFormatted(format, "ERROR", v...)
}
}
// Warnf prints a warning message to the console.
func (l *Logger) Warnf(format string, v ...interface{}) {
if LogWarn <= l.level {
l.writeFormatted(format, "WARN", v...)
}
}
// Infof prints an information message to the console.
func (l *Logger) Infof(format string, v ...interface{}) {
if LogInfo <= l.level {
l.writeFormatted(format, "INFO", v...)
}
}
// Debugf prints a debug message to the console.
func (l *Logger) Debugf(format string, v ...interface{}) {
if LogDebug <= l.level {
l.writeFormatted(format, "DEBUG", v...)
}
}
// Tracef prints a trace message to the console.
func (l *Logger) Tracef(format string, v ...interface{}) {
if LogTrace <= l.level {
l.writeFormatted(format, "TRACE", v...)
}
}
//------------------------------------------------------------------------------
// Fatalln prints a fatal message to the console. Does NOT cause panic.
func (l *Logger) Fatalln(message string) {
if LogFatal <= l.level {
l.writeLine(message, "FATAL")
}
}
// Errorln prints an error message to the console.
func (l *Logger) Errorln(message string) {
if LogError <= l.level {
l.writeLine(message, "ERROR")
}
}
// Warnln prints a warning message to the console.
func (l *Logger) Warnln(message string) {
if LogWarn <= l.level {
l.writeLine(message, "WARN")
}
}
// Infoln prints an information message to the console.
func (l *Logger) Infoln(message string) {
if LogInfo <= l.level {
l.writeLine(message, "INFO")
}
}
// Debugln prints a debug message to the console.
func (l *Logger) Debugln(message string) {
if LogDebug <= l.level {
l.writeLine(message, "DEBUG")
}
}
// Traceln prints a trace message to the console.
func (l *Logger) Traceln(message string) {
if LogTrace <= l.level {
l.writeLine(message, "TRACE")
}
}
//------------------------------------------------------------------------------