-
Notifications
You must be signed in to change notification settings - Fork 1
/
logger.go
408 lines (355 loc) · 11.3 KB
/
logger.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
397
398
399
400
401
402
403
404
405
406
407
408
package go_logger
import (
"bytes"
"fmt"
"io"
"log"
"os"
"path"
"runtime"
"strings"
"sync/atomic"
"time"
)
func init() {
//initColors(&defaultColors)
initFormatPlaceholders()
}
// Returns a proper string to be outputted for a particular info
func (r *Info) Output(format string) string {
msg := fmt.Sprintf(format,
r.Id, // %[1] // %{id}
r.Time, // %[2] // %{time[:fmt]}
r.Module, // %[3] // %{module}
r.Filename, // %[4] // %{filename}
r.Line, // %[5] // %{line}
r.logLevelString(), // %[6] // %{level}
r.Message, // %[7] // %{message}
)
// Ignore printf errors if len(args) > len(verbs)
if i := strings.LastIndex(msg, "%!(EXTRA"); i != -1 {
return msg[:i]
}
return msg
}
// Analyze and represent format string as printf format string and time format
func parseFormat(format string) (msgfmt, timefmt string) {
if len(format) < 10 /* (len of "%{message} */ {
return defFmt, defTimeFmt
}
timefmt = defTimeFmt
idx := strings.IndexRune(format, '%')
for idx != -1 {
msgfmt += format[:idx]
format = format[idx:]
if len(format) > 2 {
if format[1] == '{' {
// end of curr verb pos
if jdx := strings.IndexRune(format, '}'); jdx != -1 {
// next verb pos
idx = strings.Index(format[1:], "%{")
// incorrect verb found ("...%{wefwef ...") but after
// this, new verb (maybe) exists ("...%{inv %{verb}...")
if idx != -1 && idx < jdx {
msgfmt += "%%"
format = format[1:]
continue
}
// get verb and arg
verb, arg := ph2verb(format[:jdx+1])
msgfmt += verb
// check if verb is time
// here you can handle args for other verbs
if verb == `%[2]s` && arg != "" /* %{time} */ {
timefmt = arg
}
format = format[jdx+1:]
} else {
format = format[1:]
}
} else {
msgfmt += "%%"
format = format[1:]
}
}
idx = strings.IndexRune(format, '%')
}
msgfmt += format
return
}
// translate format placeholder to printf verb and some argument of placeholder
// (now used only as time format)
func ph2verb(ph string) (verb string, arg string) {
n := len(ph)
if n < 4 {
return ``, ``
}
if ph[0] != '%' || ph[1] != '{' || ph[n-1] != '}' {
return ``, ``
}
idx := strings.IndexRune(ph, ':')
if idx == -1 {
return phfs[ph], ``
}
verb = phfs[ph[:idx]+"}"]
arg = ph[idx+1 : n-1]
return
}
// Returns an instance of worker class, prefix is the string attached to every log,
// flag determine the log params, color parameters verifies whether we need colored outputs or not
func NewWorker(prefix string, flag int, isColor int, out io.Writer) *Worker {
return &Worker{Minion: log.New(out, prefix, flag), isColor: isColor, format: defFmt, timeFormat: defTimeFmt}
}
func SetDefaultFormat(format string) {
defFmt, defTimeFmt = parseFormat(format)
}
func (w *Worker) SetFormat(format string) {
w.format, w.timeFormat = parseFormat(format)
}
/*
Available Formats:
"%{id}"
"%{time}"
"%{module}"
"%{filename}"
"%{file}"
"%{line}"
"%{level}"
"%{lvl}"
"%{message}"
Example usage: SetFormat("[%{level}-%{id}] %{module} %{filename} %{file}:%{line} %{message}")
*/
func (l *Logger) SetFormat(format string) {
l.worker.SetFormat(format)
}
func (w *Worker) SetLogLevel(level LogLevel) {
w.level = level
}
func (l *Logger) SetLogLevel(level LogLevel) {
l.worker.level = level
}
// Function of Worker class to log a string based on level
func (w *Worker) Log(level LogLevel, calldepth int, info *Info) error {
if w.level < level {
return nil
}
if w.isColor != 0 {
buf := &bytes.Buffer{}
buf.Write([]byte(colors[level]))
buf.Write([]byte(info.Output(w.format)))
buf.Write([]byte("\033[0m"))
return w.Minion.Output(calldepth+1, buf.String())
} else {
return w.Minion.Output(calldepth+1, info.Output(w.format))
}
}
// Returns a proper string to output for colored logging
func ColorString(color int) string {
return fmt.Sprintf("\033[%dm", int(color))
}
// Initializes the map of colors
func setColors(userColor *map[LogLevel]string) {
colors = *userColor
}
// Initializes the map of placeholders
func initFormatPlaceholders() {
phfs = map[string]string{
"%{id}": "%[1]d",
"%{time}": "%[2]s",
"%{module}": "%[3]s",
"%{filename}": "%[4]s",
"%{file}": "%[4]s",
"%{line}": "%[5]d",
"%{level}": "%[6]s",
"%{lvl}": "%.3[6]s",
"%{message}": "%[7]s",
}
}
// Returns a new instance of logger class, module is the specific module for which we are logging
// , isColor defines whether the output is to be colored or not, Color defines type of color, out is instance of type io.Writer defaults
// to os.Stderr
func New(args ...interface{}) (*Logger, error) {
//initColors()
var module string = "DEFAULT"
var isColor int = 1
var out io.Writer = os.Stderr
var level LogLevel = InfoLevel
var color map[LogLevel]string = defaultColors
for _, arg := range args {
switch t := arg.(type) {
case string:
module = t
case int:
isColor = t
case io.Writer:
out = t
case LogLevel:
level = t
case map[LogLevel]string:
color = t
default:
panic("logger: Unknown argument")
}
}
setColors(&color)
newWorker := NewWorker("", 0, isColor, out)
newWorker.SetLogLevel(level)
return &Logger{Module: module, worker: newWorker}, nil
}
// The log command is the function available to user to log message, lvl specifies
// the degree of the message the user wants to log, message is the info user wants to log
func (l *Logger) Log(lvl LogLevel, message string) {
l.log_internal(lvl, message, 2)
}
func (l *Logger) log_internal(lvl LogLevel, message string, pos int) {
//var formatString string = "#%d %s [%s] %s:%d ▶ %.3s %s"
_, filename, line, _ := runtime.Caller(pos)
filename = path.Base(filename)
info := &Info{
Id: atomic.AddUint64(&logNo, 1),
Time: time.Now().Format(l.worker.timeFormat),
Module: l.Module,
Level: lvl,
Message: message,
Filename: filename,
Line: line,
//format: formatString,
}
l.worker.Log(lvl, 2, info)
}
// Fatal is just like func l.Critical logger except that it is followed by exit to program
func (l *Logger) Fatal(message string) {
l.log_internal(CriticalLevel, message, 2)
os.Exit(1)
}
// FatalF is just like func l.CriticalF logger except that it is followed by exit to program
func (l *Logger) FatalF(format string, a ...interface{}) {
l.log_internal(CriticalLevel, fmt.Sprintf(format, a...), 2)
os.Exit(1)
}
// FatalF is just like func l.CriticalF logger except that it is followed by exit to program
func (l *Logger) Fatalf(format string, a ...interface{}) {
l.log_internal(CriticalLevel, fmt.Sprintf(format, a...), 2)
os.Exit(1)
}
// Panic is just like func l.Critical except that it is followed by a call to panic
func (l *Logger) Panic(message string) {
l.log_internal(CriticalLevel, message, 2)
panic(message)
}
// PanicF is just like func l.CriticalF except that it is followed by a call to panic
func (l *Logger) PanicF(format string, a ...interface{}) {
l.log_internal(CriticalLevel, fmt.Sprintf(format, a...), 2)
panic(fmt.Sprintf(format, a...))
}
// PanicF is just like func l.CriticalF except that it is followed by a call to panic
func (l *Logger) Panicf(format string, a ...interface{}) {
l.log_internal(CriticalLevel, fmt.Sprintf(format, a...), 2)
panic(fmt.Sprintf(format, a...))
}
// Critical logs a message at a Critical Level
func (l *Logger) Critical(message string) {
l.log_internal(CriticalLevel, message, 2)
}
// CriticalF logs a message at Critical level using the same syntax and options as fmt.Printf
func (l *Logger) CriticalF(format string, a ...interface{}) {
l.log_internal(CriticalLevel, fmt.Sprintf(format, a...), 2)
}
// CriticalF logs a message at Critical level using the same syntax and options as fmt.Printf
func (l *Logger) Criticalf(format string, a ...interface{}) {
l.log_internal(CriticalLevel, fmt.Sprintf(format, a...), 2)
}
// Error logs a message at Error level
func (l *Logger) Error(message string) {
l.log_internal(ErrorLevel, message, 2)
}
// ErrorF logs a message at Error level using the same syntax and options as fmt.Printf
func (l *Logger) ErrorF(format string, a ...interface{}) {
l.log_internal(ErrorLevel, fmt.Sprintf(format, a...), 2)
}
// ErrorF logs a message at Error level using the same syntax and options as fmt.Printf
func (l *Logger) Errorf(format string, a ...interface{}) {
l.log_internal(ErrorLevel, fmt.Sprintf(format, a...), 2)
}
// Warning logs a message at Warning level
func (l *Logger) Warning(message string) {
l.log_internal(WarningLevel, message, 2)
}
// WarningF logs a message at Warning level using the same syntax and options as fmt.Printf
func (l *Logger) WarningF(format string, a ...interface{}) {
l.log_internal(WarningLevel, fmt.Sprintf(format, a...), 2)
}
// WarningF logs a message at Warning level using the same syntax and options as fmt.Printf
func (l *Logger) Warningf(format string, a ...interface{}) {
l.log_internal(WarningLevel, fmt.Sprintf(format, a...), 2)
}
// Notice logs a message at Notice level
func (l *Logger) Notice(message string) {
l.log_internal(NoticeLevel, message, 2)
}
// NoticeF logs a message at Notice level using the same syntax and options as fmt.Printf
func (l *Logger) NoticeF(format string, a ...interface{}) {
l.log_internal(NoticeLevel, fmt.Sprintf(format, a...), 2)
}
// NoticeF logs a message at Notice level using the same syntax and options as fmt.Printf
func (l *Logger) Noticef(format string, a ...interface{}) {
l.log_internal(NoticeLevel, fmt.Sprintf(format, a...), 2)
}
// Info logs a message at Info level
func (l *Logger) Info(message string) {
l.log_internal(InfoLevel, message, 2)
}
// InfoF logs a message at Info level using the same syntax and options as fmt.Printf
func (l *Logger) InfoF(format string, a ...interface{}) {
l.log_internal(InfoLevel, fmt.Sprintf(format, a...), 2)
}
// InfoF logs a message at Info level using the same syntax and options as fmt.Printf
func (l *Logger) Infof(format string, a ...interface{}) {
l.log_internal(InfoLevel, fmt.Sprintf(format, a...), 2)
}
// Debug logs a message at Debug level
func (l *Logger) Debug(message string) {
l.log_internal(DebugLevel, message, 2)
}
// DebugF logs a message at Debug level using the same syntax and options as fmt.Printf
func (l *Logger) DebugF(format string, a ...interface{}) {
l.log_internal(DebugLevel, fmt.Sprintf(format, a...), 2)
}
// DebugF logs a message at Debug level using the same syntax and options as fmt.Printf
func (l *Logger) Debugf(format string, a ...interface{}) {
l.log_internal(DebugLevel, fmt.Sprintf(format, a...), 2)
}
// Prints this goroutine's execution stack as an error with an optional message at the begining
func (l *Logger) StackAsError(message string) {
if message == "" {
message = "Stack info"
}
message += "\n"
l.log_internal(ErrorLevel, message+Stack(), 2)
}
// Prints this goroutine's execution stack as critical with an optional message at the begining
func (l *Logger) StackAsCritical(message string) {
if message == "" {
message = "Stack info"
}
message += "\n"
l.log_internal(CriticalLevel, message+Stack(), 2)
}
// Returns a string with the execution stack for this goroutine
func Stack() string {
buf := make([]byte, 1000000)
runtime.Stack(buf, false)
return string(buf)
}
// Returns the loglevel as string
func (info *Info) logLevelString() string {
logLevels := [...]string{
"CRITICAL",
"ERROR",
"WARNING",
"NOTICE",
"INFO",
"DEBUG",
}
return logLevels[info.Level-1]
}