-
Notifications
You must be signed in to change notification settings - Fork 16
/
logx.go
217 lines (188 loc) · 4.5 KB
/
logx.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
// Package logx is a logging package inspired by Sirupsen/logrus and
// uber-common/zap that follows these guidelines:
// https://dave.cheney.net/2015/11/05/lets-talk-about-logging
package logx
import (
"fmt"
"io"
"os"
"runtime"
"strings"
"time"
)
// Field is a key/value pair associated to a log.
type Field struct {
Key string
Value interface{}
}
// F returns a new log field with the provided key and value
func F(key string, value interface{}) Field {
return Field{Key: key, Value: value}
}
// Logging levels
const (
// Deprecated: use InfoLevel instead
DebugLevel Level = iota + 1
InfoLevel
ErrorLevel
)
// Level type
type Level uint8
func (l Level) String() string {
switch l {
case DebugLevel:
return "DEBU"
case InfoLevel:
return "INFO"
case ErrorLevel:
return "ERRO"
default:
return "????"
}
}
// DefaultMinLevel is the minimum debug level for which the logs will appear.
var DefaultMinLevel = InfoLevel
// defaultFileSkipLevel is the number of stack frames to ascend to get the calling file
var defaultFileSkipLevel = 3
// a log entry has a message, some fields (optional) and a log level
type entry struct {
message string
fields []Field
level Level
time *time.Time
file string
}
// Logger defines the log methods Info and Error
type Logger interface {
// Deprecated: use Info instead
Debug(string, ...Field)
Info(string, ...Field)
Error(string, ...Field)
}
// A Log implements Logger and has a marshaler, a writer and a minimum log level.
type Log struct {
marshaler Marshaler
writer io.Writer
level Level
withoutTime bool
withoutFileInfo bool
fileSkipLevel int
}
// Debug logs a message at level Debug
// Deprecated: use Info instead
func (l *Log) Debug(message string, fields ...Field) {
if DebugLevel >= l.level {
l.log(DebugLevel, message, fields...)
}
}
// Info logs a message at level Info
func (l *Log) Info(message string, fields ...Field) {
if InfoLevel >= l.level {
l.log(InfoLevel, message, fields...)
}
}
// Error logs a message at level Error
func (l *Log) Error(message string, fields ...Field) {
if ErrorLevel >= l.level {
l.log(ErrorLevel, message, fields...)
}
}
func (l *Log) log(level Level, message string, fields ...Field) {
var t *time.Time
if !l.withoutTime {
now := time.Now()
t = &now
}
var fi string
if !l.withoutFileInfo {
fi = fileInfo(l.fileSkipLevel)
}
entry := &entry{
message: message,
fields: fields,
level: level,
time: t,
file: fi,
}
data, err := l.marshaler.Marshal(entry)
if err == nil {
_, _ = l.writer.Write(data)
}
// @TODO log the marshaling has failed?
}
// DefaultWriter is the writer default to all loggers
var DefaultWriter = os.Stdout
// NewLogstash creates a new logstash compatible logger
func NewLogstash(channel, product, application string, opts ...Option) *Log {
options := &options{}
for _, opt := range opts {
opt(options)
}
if options.marshaler == nil {
options.marshaler = NewLogstashMarshaler(channel, product, application)
}
if options.writer == nil {
options.writer = DefaultWriter
}
if options.level == 0 {
options.level = DefaultMinLevel
}
return loggerFromOptions(options)
}
// New creates a basic logger with the default values.
func New(opts ...Option) *Log {
options := &options{}
for _, opt := range opts {
opt(options)
}
if options.marshaler == nil {
options.marshaler = new(HumanMarshaler)
}
if options.writer == nil {
options.writer = DefaultWriter
}
if options.level == 0 {
options.level = DefaultMinLevel
}
return loggerFromOptions(options)
}
// NewDummy creates a logger for testing purposes.
func NewDummy(opts ...Option) *Log {
options := &options{}
for _, opt := range opts {
opt(options)
}
if options.marshaler == nil {
options.marshaler = new(DummyMarshaler)
}
if options.writer == nil {
options.writer = io.Discard
}
if options.level == 0 {
options.level = DefaultMinLevel
}
return loggerFromOptions(options)
}
func loggerFromOptions(opts *options) *Log {
return &Log{
marshaler: opts.marshaler,
writer: opts.writer,
level: opts.level,
withoutTime: opts.withoutTime,
withoutFileInfo: opts.withoutFileInfo,
fileSkipLevel: defaultFileSkipLevel + opts.additionalFileSkipLevel,
}
}
func fileInfo(fileSkipLevel int) string {
_, file, line, ok := runtime.Caller(fileSkipLevel)
if !ok {
file = "<???>"
line = 1
} else {
slash := strings.LastIndex(file, "/")
if slash >= 0 {
file = file[slash+1:]
}
}
return fmt.Sprintf("%s:%d", file, line)
}