-
Notifications
You must be signed in to change notification settings - Fork 172
/
logging.go
82 lines (67 loc) · 1.91 KB
/
logging.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
package unittest
import (
"flag"
"fmt"
"io"
"io/ioutil"
"os"
"strings"
"sync"
"time"
"github.com/rs/zerolog"
)
var verbose = flag.Bool("vv", false, "print debugging logs")
var globalOnce sync.Once
func LogVerbose() {
*verbose = true
}
// Logger returns a zerolog
// use -vv flag to print debugging logs for tests
func Logger() zerolog.Logger {
writer := ioutil.Discard
if *verbose {
writer = os.Stderr
}
return LoggerWithWriterAndLevel(writer, zerolog.DebugLevel)
}
func LoggerWithWriterAndLevel(writer io.Writer, level zerolog.Level) zerolog.Logger {
globalOnce.Do(func() {
zerolog.TimestampFunc = func() time.Time { return time.Now().UTC() }
})
log := zerolog.New(writer).Level(level).With().Timestamp().Logger()
return log
}
func LoggerWithLevel(level zerolog.Level) zerolog.Logger {
return LoggerWithWriterAndLevel(os.Stderr, level)
}
func LoggerWithName(mod string) zerolog.Logger {
return Logger().With().Str("module", mod).Logger()
}
func NewLoggerHook() LoggerHook {
return LoggerHook{
logs: &strings.Builder{},
}
}
func HookedLogger() (zerolog.Logger, LoggerHook) {
hook := NewLoggerHook()
log := zerolog.New(ioutil.Discard).Hook(hook)
return log, hook
}
// LoggerHook implements the zerolog.Hook interface and can be used to capture
// logs for testing purposes.
type LoggerHook struct {
logs *strings.Builder
}
// Logs returns the logs as a string
func (hook LoggerHook) Logs() string {
return hook.logs.String()
}
// Run implements zerolog.Hook and appends the log message to the log.
func (hook LoggerHook) Run(_ *zerolog.Event, level zerolog.Level, msg string) {
hook.logs.WriteString(msg)
// for tests that need to test logger.Fatal(), this is useful because the parent test process will read from stdout
// to determine if the test sub-process (that generated the logger.Fatal() call) called logger.Fatal() with the expected message
if level == zerolog.FatalLevel {
fmt.Println(msg)
}
}