-
-
Notifications
You must be signed in to change notification settings - Fork 778
/
logger.go
347 lines (292 loc) · 7.72 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
// Package log provides an implementation of [logger.LoggerImpl], using logrus.
package log
import (
"fmt"
"os"
"strings"
"sync"
"time"
"github.com/sirupsen/logrus"
)
type LogItem struct {
Time time.Time `json:"time"`
Type string `json:"type"`
Message string `json:"message"`
}
type Logger struct {
logger *logrus.Logger
progressLogger *logrus.Logger
mutex sync.Mutex
logCache []LogItem
logSubs []chan []LogItem
waiting bool
lastBroadcast time.Time
logBuffer []LogItem
}
func NewLogger() *Logger {
ret := &Logger{
logger: logrus.New(),
progressLogger: logrus.New(),
lastBroadcast: time.Now(),
}
ret.progressLogger.SetFormatter(new(ProgressFormatter))
return ret
}
// Init initialises the logger based on a logging configuration
func (log *Logger) Init(logFile string, logOut bool, logLevel string) {
var file *os.File
customFormatter := new(logrus.TextFormatter)
customFormatter.TimestampFormat = "2006-01-02 15:04:05"
customFormatter.ForceColors = true
customFormatter.FullTimestamp = true
log.logger.SetOutput(os.Stderr)
log.logger.SetFormatter(customFormatter)
// #1837 - trigger the console to use color-mode since it won't be
// otherwise triggered until the first log entry
// this is covers the situation where the logger is only logging to file
// and therefore does not trigger the console color-mode - resulting in
// the access log colouring not being applied
_, _ = customFormatter.Format(logrus.NewEntry(log.logger))
if logFile != "" {
var err error
file, err = os.OpenFile(logFile, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644)
if err != nil {
fmt.Printf("Could not open '%s' for log output due to error: %s\n", logFile, err.Error())
}
}
if file != nil {
if logOut {
// log to file separately disabling colours
fileFormatter := new(logrus.TextFormatter)
fileFormatter.TimestampFormat = customFormatter.TimestampFormat
fileFormatter.FullTimestamp = customFormatter.FullTimestamp
log.logger.AddHook(&fileLogHook{
Writer: file,
Formatter: fileFormatter,
})
} else {
// logging to file only
// turn off the colouring for the file
customFormatter.ForceColors = false
log.logger.Out = file
}
}
// otherwise, output to StdErr
log.SetLogLevel(logLevel)
}
func (log *Logger) SetLogLevel(level string) {
log.logger.Level = logLevelFromString(level)
}
func logLevelFromString(level string) logrus.Level {
ret := logrus.InfoLevel
switch strings.ToLower(level) {
case "debug":
ret = logrus.DebugLevel
case "warning":
ret = logrus.WarnLevel
case "error":
ret = logrus.ErrorLevel
case "trace":
ret = logrus.TraceLevel
}
return ret
}
func (log *Logger) addToCache(l *LogItem) {
// assumes mutex held
// only add to cache if meets minimum log level
level := logLevelFromString(l.Type)
if level <= log.logger.Level {
log.logCache = append([]LogItem{*l}, log.logCache...)
if len(log.logCache) > 30 {
log.logCache = log.logCache[:len(log.logCache)-1]
}
}
}
func (log *Logger) addLogItem(l *LogItem) {
log.mutex.Lock()
l.Time = time.Now()
log.addToCache(l)
log.mutex.Unlock()
go log.broadcastLogItem(l)
}
func (log *Logger) GetLogCache() []LogItem {
log.mutex.Lock()
ret := make([]LogItem, len(log.logCache))
copy(ret, log.logCache)
log.mutex.Unlock()
return ret
}
func (log *Logger) SubscribeToLog(stop chan int) <-chan []LogItem {
ret := make(chan []LogItem, 100)
go func() {
<-stop
log.unsubscribeFromLog(ret)
}()
log.mutex.Lock()
log.logSubs = append(log.logSubs, ret)
log.mutex.Unlock()
return ret
}
func (log *Logger) unsubscribeFromLog(toRemove chan []LogItem) {
log.mutex.Lock()
for i, c := range log.logSubs {
if c == toRemove {
log.logSubs = append(log.logSubs[:i], log.logSubs[i+1:]...)
}
}
close(toRemove)
log.mutex.Unlock()
}
func (log *Logger) doBroadcastLogItems() {
// assumes mutex held
for _, c := range log.logSubs {
// don't block waiting to broadcast
select {
case c <- log.logBuffer:
default:
}
}
log.logBuffer = nil
log.waiting = false
log.lastBroadcast = time.Now()
}
func (log *Logger) broadcastLogItem(l *LogItem) {
log.mutex.Lock()
log.logBuffer = append(log.logBuffer, *l)
// don't send more than once per second
if !log.waiting {
// if last broadcast was under a second ago, wait until a second has
// passed
timeSinceBroadcast := time.Since(log.lastBroadcast)
if timeSinceBroadcast.Seconds() < 1 {
log.waiting = true
time.AfterFunc(time.Second-timeSinceBroadcast, func() {
log.mutex.Lock()
log.doBroadcastLogItems()
log.mutex.Unlock()
})
} else {
log.doBroadcastLogItems()
}
}
// if waiting then adding it to the buffer is sufficient
log.mutex.Unlock()
}
func (log *Logger) Progressf(format string, args ...interface{}) {
log.progressLogger.Infof(format, args...)
l := &LogItem{
Type: "progress",
Message: fmt.Sprintf(format, args...),
}
log.addLogItem(l)
}
func (log *Logger) Trace(args ...interface{}) {
log.logger.Trace(args...)
l := &LogItem{
Type: "trace",
Message: fmt.Sprint(args...),
}
log.addLogItem(l)
}
func (log *Logger) Tracef(format string, args ...interface{}) {
log.logger.Tracef(format, args...)
l := &LogItem{
Type: "trace",
Message: fmt.Sprintf(format, args...),
}
log.addLogItem(l)
}
func (log *Logger) TraceFunc(fn func() (string, []interface{})) {
if log.logger.Level >= logrus.TraceLevel {
msg, args := fn()
log.Tracef(msg, args...)
}
}
func (log *Logger) Debug(args ...interface{}) {
log.logger.Debug(args...)
l := &LogItem{
Type: "debug",
Message: fmt.Sprint(args...),
}
log.addLogItem(l)
}
func (log *Logger) Debugf(format string, args ...interface{}) {
log.logger.Debugf(format, args...)
l := &LogItem{
Type: "debug",
Message: fmt.Sprintf(format, args...),
}
log.addLogItem(l)
}
func (log *Logger) logFunc(level logrus.Level, logFn func(format string, args ...interface{}), fn func() (string, []interface{})) {
if log.logger.Level >= level {
msg, args := fn()
logFn(msg, args...)
}
}
func (log *Logger) DebugFunc(fn func() (string, []interface{})) {
log.logFunc(logrus.DebugLevel, log.logger.Debugf, fn)
}
func (log *Logger) Info(args ...interface{}) {
log.logger.Info(args...)
l := &LogItem{
Type: "info",
Message: fmt.Sprint(args...),
}
log.addLogItem(l)
}
func (log *Logger) Infof(format string, args ...interface{}) {
log.logger.Infof(format, args...)
l := &LogItem{
Type: "info",
Message: fmt.Sprintf(format, args...),
}
log.addLogItem(l)
}
func (log *Logger) InfoFunc(fn func() (string, []interface{})) {
log.logFunc(logrus.InfoLevel, log.logger.Infof, fn)
}
func (log *Logger) Warn(args ...interface{}) {
log.logger.Warn(args...)
l := &LogItem{
Type: "warn",
Message: fmt.Sprint(args...),
}
log.addLogItem(l)
}
func (log *Logger) Warnf(format string, args ...interface{}) {
log.logger.Warnf(format, args...)
l := &LogItem{
Type: "warn",
Message: fmt.Sprintf(format, args...),
}
log.addLogItem(l)
}
func (log *Logger) WarnFunc(fn func() (string, []interface{})) {
log.logFunc(logrus.WarnLevel, log.logger.Warnf, fn)
}
func (log *Logger) Error(args ...interface{}) {
log.logger.Error(args...)
l := &LogItem{
Type: "error",
Message: fmt.Sprint(args...),
}
log.addLogItem(l)
}
func (log *Logger) Errorf(format string, args ...interface{}) {
log.logger.Errorf(format, args...)
l := &LogItem{
Type: "error",
Message: fmt.Sprintf(format, args...),
}
log.addLogItem(l)
}
func (log *Logger) ErrorFunc(fn func() (string, []interface{})) {
log.logFunc(logrus.ErrorLevel, log.logger.Errorf, fn)
}
func (log *Logger) Fatal(args ...interface{}) {
log.logger.Fatal(args...)
}
func (log *Logger) Fatalf(format string, args ...interface{}) {
log.logger.Fatalf(format, args...)
}