-
Notifications
You must be signed in to change notification settings - Fork 1
/
logger.go
296 lines (245 loc) · 6.86 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
/*
Package logger is a wrapper for the Logrus logger package.
Logger is used by most Brickchain software to enable context based logging with details needed by each component.
Installation
# How to install logger
$ go get github.com/Brickchain/go-logger.v1
Example
logger.SetOutput(os.Stdout)
logger.SetFormatter("text")
logger.SetLevel("debug")
logger.AddContext("service", path.Base(os.Args[0]))
logger.AddContext("version", constant.Version)
logger.Infof("Running version %s", version)
logger.Error(err)
*/
package logger
import (
"context"
"io"
"os"
"runtime"
"strings"
"sync"
"github.com/sirupsen/logrus"
)
var (
ctxlogger *logrus.Entry
mu *sync.Mutex
)
type devFormatter struct {
logrus.Formatter
}
func (f *devFormatter) Format(entry *logrus.Entry) ([]byte, error) {
b, err := f.Formatter.Format(entry)
s := strings.Replace(string(b), "\\n", "\n\t", -1)
s = strings.Replace(s, "\\t", "\t", -1)
s = strings.Replace(s, "\\\"", "\"", -1)
return []byte(s), err
}
// Entry contains a Logrus entry
type Entry struct {
entry *logrus.Entry
}
// Fields is a map of fields used by the logger
type Fields map[string]interface{}
func init() {
mu = &sync.Mutex{}
mu.Lock()
defer mu.Unlock()
logrus.SetOutput(os.Stdout)
hostname, _ := os.Hostname()
ctxlogger = logrus.WithField("pid", os.Getpid()).WithField("hostname", hostname)
}
// GetLogger returns the context logger
func GetLogger() *logrus.Entry {
return ctxlogger
}
// AddContext adds another context to the logger
func AddContext(key string, value interface{}) {
mu.Lock()
defer mu.Unlock()
ctxlogger = ctxlogger.WithField(key, value)
}
// SetFormatter sets the formatter to be used, either "json" or "text"
func SetFormatter(formatter string) {
var _formatter logrus.Formatter
switch formatter {
case "json":
_formatter = &logrus.JSONFormatter{}
case "dev":
_formatter = &devFormatter{&logrus.JSONFormatter{PrettyPrint: true}}
default:
_formatter = &logrus.TextFormatter{}
}
SetLogrusFormatter(_formatter)
}
// SetLogrusFormatter sets the logrus formatter to be used
func SetLogrusFormatter(formatter logrus.Formatter) {
mu.Lock()
defer mu.Unlock()
data := ctxlogger.Data
logrus.SetFormatter(formatter)
ctxlogger = logrus.WithFields(data)
}
// SetOutput sets the io.Writer to use
func SetOutput(out io.Writer) {
mu.Lock()
defer mu.Unlock()
data := ctxlogger.Data
logrus.SetOutput(out)
ctxlogger = logrus.WithFields(data)
}
// SetLevel sets the lowest level to log
func SetLevel(level string) {
_level, err := logrus.ParseLevel(level)
if err != nil {
_level = logrus.InfoLevel
}
mu.Lock()
defer mu.Unlock()
data := ctxlogger.Data
logrus.SetLevel(_level)
ctxlogger = logrus.WithFields(data)
}
// GetLoglevel returns the current log level
func GetLoglevel() string {
return logrus.GetLevel().String()
}
// AddField adds a field to the current context
func (e *Entry) AddField(key string, value interface{}) {
mu.Lock()
defer mu.Unlock()
e.entry = e.entry.WithField(key, value)
}
// WithField adds another field to the logger entry context
func WithField(key string, value interface{}) *Entry {
return &Entry{
entry: ctxlogger.WithField(key, value),
}
}
// WithFields adds more Fields to the logger entry context
func WithFields(fields Fields) *Entry {
_fields := logrus.Fields{}
for k, v := range fields {
_fields[k] = v
}
return &Entry{
entry: ctxlogger.WithFields(_fields),
}
}
// Debug is the wrapper for Logrus Debug()
func Debug(args ...interface{}) {
loggerWithCaller().Debug(args...)
}
// Info is the wrapper for Logrus Info()
func Info(args ...interface{}) {
loggerWithCaller().Info(args...)
}
// Warn is the wrapper for Logrus Warn()
func Warn(args ...interface{}) {
loggerWithCaller().Warn(args...)
}
// Error is the wrapper for Logrus Error()
func Error(args ...interface{}) {
loggerWithCaller().Error(args...)
}
// Fatal is the wrapper for Logrus Fatal()
func Fatal(args ...interface{}) {
loggerWithCaller().Fatal(args...)
}
// Fatalf is the wrapper for Logris Fatalf()
func Fatalf(format string, args ...interface{}) {
loggerWithCaller().Fatalf(format, args...)
}
// Errorf is the wrapper for Logrus Errorf()
func Errorf(format string, args ...interface{}) {
loggerWithCaller().Errorf(format, args...)
}
// Infof is the wrapper for Logrus Infof()
func Infof(format string, args ...interface{}) {
loggerWithCaller().Infof(format, args...)
}
// Warningf is the wrapper for Logrus Warningf()
func Warningf(format string, args ...interface{}) {
loggerWithCaller().Warningf(format, args...)
}
// Debugf is the wrapper for Logrus Debugf()
func Debugf(format string, args ...interface{}) {
loggerWithCaller().Debugf(format, args...)
}
func loggerWithCaller() *logrus.Entry {
_, file, line, _ := runtime.Caller(2)
fields := logrus.Fields{
"file": file,
"line": line,
}
return ctxlogger.WithFields(fields)
}
// ForContext TODO docs
func ForContext(ctx context.Context) *Entry {
reqID, _ := ctx.Value(0).(string)
return &Entry{
entry: ctxlogger.WithField("request-id", reqID),
}
}
// WithField adds another field to the Logrus entry context
func (e *Entry) WithField(key string, value interface{}) *Entry {
e.entry = e.entry.WithField(key, value)
return e
}
// WithFields adds more Fields to the Logrus entry context
func (e *Entry) WithFields(fields Fields) *Entry {
_fields := logrus.Fields{}
for k, v := range fields {
_fields[k] = v
}
e.entry = e.entry.WithFields(_fields)
return e
}
// Debug is the wrapper for Logrus Debug()
func (e *Entry) Debug(args ...interface{}) {
e.loggerWithCaller().entry.Debug(args...)
}
// Info is the wrapper for Logrus Info()
func (e *Entry) Info(args ...interface{}) {
e.loggerWithCaller().entry.Info(args...)
}
// Warn is the wrapper for Logrus Warn()
func (e *Entry) Warn(args ...interface{}) {
e.loggerWithCaller().entry.Warn(args...)
}
// Error is the wrapper for Logrus Error()
func (e *Entry) Error(args ...interface{}) {
e.loggerWithCaller().entry.Error(args...)
}
// Fatal is the wrapper for Logrus Fatal()
func (e *Entry) Fatal(args ...interface{}) {
e.loggerWithCaller().entry.Fatal(args...)
}
// Errorf is the wrapper for Logrus Errorf()
func (e *Entry) Errorf(format string, args ...interface{}) {
e.loggerWithCaller().entry.Errorf(format, args...)
}
// Infof is the wrapper for Logrus Infof()
func (e *Entry) Infof(format string, args ...interface{}) {
e.loggerWithCaller().entry.Infof(format, args...)
}
// Warningf is the wrapper for Logrus Warninf()
func (e *Entry) Warningf(format string, args ...interface{}) {
e.loggerWithCaller().entry.Warningf(format, args...)
}
// Debugf is the wrapper for Logrus Debugf()
func (e *Entry) Debugf(format string, args ...interface{}) {
e.loggerWithCaller().entry.Debugf(format, args...)
}
func (e *Entry) loggerWithCaller() *Entry {
_, file, line, _ := runtime.Caller(2)
fields := logrus.Fields{
"file": file,
"line": line,
}
n := &*e
n.entry = n.entry.WithFields(fields)
return n
}