-
Notifications
You must be signed in to change notification settings - Fork 176
/
logger.go
287 lines (250 loc) · 7.87 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
// Copyright (c) 2017 Daniel Oaks <daniel@danieloaks.net>
// released under the MIT license
package logger
import (
"bufio"
"fmt"
"os"
"time"
"strings"
"sync"
colorable "github.com/mattn/go-colorable"
"github.com/mgutz/ansi"
)
// Level represents the level to log messages at.
type Level int
const (
// LogDebug represents debug messages.
LogDebug Level = iota
// LogInfo represents informational messages.
LogInfo
// LogWarning represents warnings.
LogWarning
// LogError represents errors.
LogError
)
var (
// LogLevelNames takes a config name and gives the real log level.
LogLevelNames = map[string]Level{
"debug": LogDebug,
"info": LogInfo,
"warn": LogWarning,
"warning": LogWarning,
"warnings": LogWarning,
"error": LogError,
"errors": LogError,
}
// LogLevelDisplayNames gives the display name to use for our log levels.
LogLevelDisplayNames = map[Level]string{
LogDebug: "debug",
LogInfo: "info",
LogWarning: "warning",
LogError: "error",
}
)
// Manager is the main interface used to log debug/info/error messages.
type Manager struct {
configMutex sync.RWMutex
loggers []singleLogger
stdoutWriteLock sync.Mutex // use one lock for both stdout and stderr
fileWriteLock sync.Mutex
loggingRawIO bool
}
// LoggingConfig represents the configuration of a single logger.
type LoggingConfig struct {
Method string
MethodStdout bool
MethodStderr bool
MethodFile bool
Filename string
TypeString string `yaml:"type"`
Types []string `yaml:"real-types"`
ExcludedTypes []string `yaml:"real-excluded-types"`
LevelString string `yaml:"level"`
Level Level `yaml:"level-real"`
}
// NewManager returns a new log manager.
func NewManager(config []LoggingConfig) (*Manager, error) {
var logger Manager
if err := logger.ApplyConfig(config); err != nil {
return nil, err
}
return &logger, nil
}
// ApplyConfig applies the given config to this logger (rehashes the config, in other words).
func (logger *Manager) ApplyConfig(config []LoggingConfig) error {
logger.configMutex.Lock()
defer logger.configMutex.Unlock()
for _, logger := range logger.loggers {
logger.Close()
}
logger.loggers = nil
logger.loggingRawIO = false
// for safety, this deep-copies all mutable data in `config`
// XXX let's keep it that way
var lastErr error
for _, logConfig := range config {
typeMap := make(map[string]bool)
for _, name := range logConfig.Types {
typeMap[name] = true
}
excludedTypeMap := make(map[string]bool)
for _, name := range logConfig.ExcludedTypes {
excludedTypeMap[name] = true
}
sLogger := singleLogger{
MethodSTDOUT: logConfig.MethodStdout,
MethodSTDERR: logConfig.MethodStderr,
MethodFile: fileMethod{
Enabled: logConfig.MethodFile,
Filename: logConfig.Filename,
},
Level: logConfig.Level,
Types: typeMap,
ExcludedTypes: excludedTypeMap,
stdoutWriteLock: &logger.stdoutWriteLock,
fileWriteLock: &logger.fileWriteLock,
}
if typeMap["userinput"] || typeMap["useroutput"] || (typeMap["*"] && !(excludedTypeMap["userinput"] && excludedTypeMap["useroutput"])) {
logger.loggingRawIO = true
}
if sLogger.MethodFile.Enabled {
file, err := os.OpenFile(sLogger.MethodFile.Filename, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0666)
if err != nil {
lastErr = fmt.Errorf("Could not open log file %s [%s]", sLogger.MethodFile.Filename, err.Error())
}
writer := bufio.NewWriter(file)
sLogger.MethodFile.File = file
sLogger.MethodFile.Writer = writer
}
logger.loggers = append(logger.loggers, sLogger)
}
return lastErr
}
// IsLoggingRawIO returns true if raw user input and output is being logged.
func (logger *Manager) IsLoggingRawIO() bool {
logger.configMutex.RLock()
defer logger.configMutex.RUnlock()
return logger.loggingRawIO
}
// Log logs the given message with the given details.
func (logger *Manager) Log(level Level, logType string, messageParts ...string) {
logger.configMutex.RLock()
defer logger.configMutex.RUnlock()
for _, singleLogger := range logger.loggers {
singleLogger.Log(level, logType, messageParts...)
}
}
// Debug logs the given message as a debug message.
func (logger *Manager) Debug(logType string, messageParts ...string) {
logger.Log(LogDebug, logType, messageParts...)
}
// Info logs the given message as an info message.
func (logger *Manager) Info(logType string, messageParts ...string) {
logger.Log(LogInfo, logType, messageParts...)
}
// Warning logs the given message as a warning message.
func (logger *Manager) Warning(logType string, messageParts ...string) {
logger.Log(LogWarning, logType, messageParts...)
}
// Error logs the given message as an error message.
func (logger *Manager) Error(logType string, messageParts ...string) {
logger.Log(LogError, logType, messageParts...)
}
// Fatal logs the given message as an error message, then exits.
func (logger *Manager) Fatal(logType string, messageParts ...string) {
logger.Error(logType, messageParts...)
logger.Error("FATAL", "Fatal error encountered, application exiting")
os.Exit(1)
}
type fileMethod struct {
Enabled bool
Filename string
File *os.File
Writer *bufio.Writer
}
// singleLogger represents a single logger instance.
type singleLogger struct {
stdoutWriteLock *sync.Mutex
fileWriteLock *sync.Mutex
MethodSTDOUT bool
MethodSTDERR bool
MethodFile fileMethod
Level Level
Types map[string]bool
ExcludedTypes map[string]bool
}
func (logger *singleLogger) Close() error {
if logger.MethodFile.Enabled {
flushErr := logger.MethodFile.Writer.Flush()
closeErr := logger.MethodFile.File.Close()
if flushErr != nil {
return flushErr
}
return closeErr
}
return nil
}
// Log logs the given message with the given details.
func (logger *singleLogger) Log(level Level, logType string, messageParts ...string) {
// no logging enabled
if !(logger.MethodSTDOUT || logger.MethodSTDERR || logger.MethodFile.Enabled) {
return
}
// ensure we're logging to the given level
if level < logger.Level {
return
}
// ensure we're capturing this logType
logTypeCleaned := strings.ToLower(strings.TrimSpace(logType))
capturing := (logger.Types["*"] || logger.Types[logTypeCleaned]) && !logger.ExcludedTypes["*"] && !logger.ExcludedTypes[logTypeCleaned]
if !capturing {
return
}
// assemble full line
timeGrey := ansi.ColorFunc("243")
grey := ansi.ColorFunc("8")
alert := ansi.ColorFunc("232+b:red")
warn := ansi.ColorFunc("black:214")
info := ansi.ColorFunc("117")
debug := ansi.ColorFunc("78")
section := ansi.ColorFunc("229")
levelDisplay := LogLevelDisplayNames[level]
if level == LogError {
levelDisplay = alert(levelDisplay)
} else if level == LogWarning {
levelDisplay = warn(levelDisplay)
} else if level == LogInfo {
levelDisplay = info(levelDisplay)
} else if level == LogDebug {
levelDisplay = debug(levelDisplay)
}
sep := grey(":")
fullStringFormatted := fmt.Sprintf("%s %s %s %s %s %s ", timeGrey(time.Now().UTC().Format("2006-01-02T15:04:05Z")), sep, levelDisplay, sep, section(logType), sep)
fullStringRaw := fmt.Sprintf("%s : %s : %s : ", time.Now().UTC().Format("2006-01-02T15:04:05Z"), LogLevelDisplayNames[level], logType)
for i, p := range messageParts {
fullStringFormatted += p
fullStringRaw += p
if i != len(messageParts)-1 {
fullStringFormatted += " " + sep + " "
fullStringRaw += " : "
}
}
// output
if logger.MethodSTDOUT {
logger.stdoutWriteLock.Lock()
fmt.Fprintln(colorable.NewColorableStdout(), fullStringFormatted)
logger.stdoutWriteLock.Unlock()
}
if logger.MethodSTDERR {
logger.stdoutWriteLock.Lock()
fmt.Fprintln(colorable.NewColorableStderr(), fullStringFormatted)
logger.stdoutWriteLock.Unlock()
}
if logger.MethodFile.Enabled {
logger.fileWriteLock.Lock()
logger.MethodFile.Writer.WriteString(fullStringRaw + "\n")
logger.MethodFile.Writer.Flush()
logger.fileWriteLock.Unlock()
}
}