-
Notifications
You must be signed in to change notification settings - Fork 154
/
log.go
308 lines (259 loc) · 6.7 KB
/
log.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
package log
import (
"context"
"encoding/json"
"io"
"net/url"
"os"
"strings"
"time"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/kanisterio/kanister/pkg/caller"
"github.com/kanisterio/kanister/pkg/config"
"github.com/kanisterio/kanister/pkg/field"
)
// Level describes the current log level.
type Level uint32
const (
// DebugLevel log level.
DebugLevel Level = Level(logrus.DebugLevel)
// InfoLevel log level.
InfoLevel Level = Level(logrus.InfoLevel)
// ErrorLevel log level.
ErrorLevel Level = Level(logrus.ErrorLevel)
// LevelVarName is the environment variable that controls
// init log levels
LevelEnvName = "LOG_LEVEL"
)
var (
ErrEndpointNotSet = errors.New("fluentbit endpoint not set")
ErrNonTCPEndpoint = errors.New("fluentbit endpoint scheme must be tcp")
ErrPathSet = errors.New("fluentbit endpoint path is set")
)
// OutputSink describes the current output sink.
type OutputSink uint8
// Valid log sinks: stderr or fluentbit
const (
StderrSink OutputSink = iota
FluentbitSink
)
// Names of environment variables to configure the logging sink
const (
LoggingServiceHostEnv = "LOGGING_SVC_SERVICE_HOST"
LoggingServicePortEnv = "LOGGING_SVC_SERVICE_PORT_LOGGING"
)
type logger struct {
level Level
ctx context.Context
err error
}
// common logger implementation used in the library
var log = logrus.New()
// SetOutput sets the output destination.
func SetOutput(sink OutputSink) error {
switch sink {
case StderrSink:
log.SetOutput(os.Stderr)
return nil
case FluentbitSink:
fbitAddr, ok := os.LookupEnv(LoggingServiceHostEnv)
if !ok {
return errors.New("Unable to find Fluentbit host address")
}
fbitPort, ok := os.LookupEnv(LoggingServicePortEnv)
if !ok {
return errors.New("Unable to find Fluentbit logging port")
}
hook := NewFluentbitHook(fbitAddr + ":" + fbitPort)
log.AddHook(hook)
return nil
default:
return errors.New("not implemented")
}
}
// SetFluentbitOutput sets the fluentbit output
func SetFluentbitOutput(url *url.URL) error {
if url == nil || url.Host == "" {
return ErrEndpointNotSet
}
if url.Scheme != "tcp" {
return ErrNonTCPEndpoint
}
if url.Path != "" {
return ErrPathSet
}
hook := NewFluentbitHook(url.Host)
log.AddHook(hook)
return nil
}
var envVarFields field.Fields
// initEnvVarFields populates envVarFields with values from the host's environment.
func initEnvVarFields() {
envVars := []string{
"HOSTNAME",
"SERVICE_NAME",
"VERSION",
}
for _, e := range envVars {
if ev, ok := os.LookupEnv(e); ok {
envVarFields = field.Add(envVarFields, strings.ToLower(e), ev)
}
}
}
// SetupClusterNameInLogVars sets up the `cluster_name` field in `envVarFields`
// so that it can be printed with the logs.
func SetupClusterNameInLogVars() {
if clsName, err := config.GetClusterName(nil); err == nil {
envVarFields = field.Add(envVarFields, "cluster_name", clsName)
}
}
// OutputFormat sets the output data format.
type OutputFormat uint8
const (
// TextFormat creates a plain text format log entry (not CEE).
TextFormat OutputFormat = iota
// JSONFormat create a JSON format log entry.
JSONFormat
)
// SetFormatter sets the output formatter.
func SetFormatter(format OutputFormat) {
switch format {
case TextFormat:
log.SetFormatter(&logrus.TextFormatter{
FullTimestamp: true,
TimestampFormat: time.RFC3339Nano})
case JSONFormat:
log.SetFormatter(&logrus.JSONFormatter{TimestampFormat: time.RFC3339Nano})
default:
panic("not implemented")
}
}
func init() {
SetFormatter(JSONFormat)
initEnvVarFields()
initLogLevel()
}
func initLogLevel() {
level, err := logrus.ParseLevel(os.Getenv(LevelEnvName))
if err != nil {
level = logrus.InfoLevel
}
SetLevel(Level(level))
}
// SetLevel sets the current log level.
func SetLevel(level Level) {
log.SetLevel(logrus.Level(level))
}
func Info() Logger {
return &logger{
level: InfoLevel,
}
}
func Error() Logger {
return &logger{
level: ErrorLevel,
}
}
func Debug() Logger {
return &logger{
level: DebugLevel,
}
}
// Print adds `msg` to the log at `InfoLevel`. It is a wrapper for `Info().Print(msg)`, since this is the most common use case.
func Print(msg string, fields ...field.M) {
Info().Print(msg, fields...)
}
// PrintTo works just like Print. It allows caller to specify the writer to use
// to output the log.
func PrintTo(w io.Writer, msg string, fields ...field.M) {
Info().PrintTo(w, msg, fields...)
}
func WithContext(ctx context.Context) Logger {
return Info().WithContext(ctx)
}
func WithError(err error) Logger {
return Info().WithError(err)
}
func (l *logger) Print(msg string, fields ...field.M) {
entry := l.entry(fields...)
entry.Logln(logrus.Level(l.level), msg)
}
func (l *logger) PrintTo(w io.Writer, msg string, fields ...field.M) {
entry := l.entry(fields...)
entry.Logger.SetOutput(w)
entry.Logln(logrus.Level(l.level), msg)
}
func (l *logger) entry(fields ...field.M) *logrus.Entry {
logFields := make(logrus.Fields)
if envVarFields != nil {
for _, f := range envVarFields.Fields() {
logFields[f.Key()] = f.Value()
}
}
frame := caller.GetFrame(4)
logFields["Function"] = frame.Function
logFields["File"] = frame.File
logFields["Line"] = frame.Line
if ctxFields := field.FromContext(l.ctx); ctxFields != nil {
for _, cf := range ctxFields.Fields() {
logFields[cf.Key()] = cf.Value()
}
}
for _, f := range fields {
for k, v := range f {
logFields[k] = v
}
}
// use a cloned logger for this entry, so that any changes to this clone
// (e.g., via SetOutput()) will not affect the global logger.
cloned := cloneGlobalLogger()
entry := cloned.WithFields(logFields)
if l.err != nil {
entry = entry.WithError(l.err)
}
return entry
}
func (l *logger) WithContext(ctx context.Context) Logger {
l.ctx = ctx
return l
}
func (l *logger) WithError(err error) Logger {
l.err = err
return l
}
// Scrapes fields of interest from the logrus.Entry and converts then into a JSON []byte.
func entryToJSON(entry *logrus.Entry) []byte {
data := make(logrus.Fields, len(entry.Data)+3)
data["Message"] = entry.Message
data["Level"] = entry.Level.String()
data["Time"] = entry.Time
for k, v := range entry.Data {
data[k] = v
}
bytes, err := json.Marshal(data)
if err != nil {
return nil
}
n := []byte("\n")
bytes = append(bytes, n...)
return bytes
}
func cloneGlobalLogger() *logrus.Logger {
cloned := logrus.New()
cloned.SetFormatter(log.Formatter)
cloned.SetReportCaller(log.ReportCaller)
cloned.SetLevel(log.Level)
cloned.SetOutput(log.Out)
cloned.ExitFunc = log.ExitFunc
globalHooks := make(map[logrus.Hook]bool)
for _, hooks := range log.Hooks {
for _, hook := range hooks {
globalHooks[hook] = true
}
}
for hook := range globalHooks {
cloned.Hooks.Add(hook)
}
return cloned
}