-
Notifications
You must be signed in to change notification settings - Fork 14
/
sugared.go
137 lines (116 loc) · 3.57 KB
/
sugared.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
package logger
// SugaredLogger extends the base Logger interface with syntactic sugar, similar to zap.SugaredLogger.
type SugaredLogger interface {
Logger
// AssumptionViolation variants log at error level with the message prefix "AssumptionViolation: ".
AssumptionViolation(args ...interface{})
AssumptionViolationf(format string, vals ...interface{})
AssumptionViolationw(msg string, keysAndVals ...interface{})
// ErrorIf logs the error if present.
ErrorIf(err error, msg string)
// ErrorIfFn calls fn() and logs any returned error along with msg.
// Unlike ErrorIf, this can be deffered inline, since the function call is delayed:
//
// defer lggr.ErrorIfFn(resource.Close, "Failed to close resource")
ErrorIfFn(fn func() error, msg string)
// Critical emits critical level logs (a remapping of [zap.DPanicLevel]) or falls back to error level with a '[crit]' prefix.
Critical(args ...interface{})
Criticalf(format string, vals ...interface{})
Criticalw(msg string, keysAndVals ...interface{})
// Trace emits logs only when built with the 'trace' tag.
//
// go test -tags trace ./foo -run TestBar
Trace(args ...interface{})
Tracef(format string, vals ...interface{})
Tracew(msg string, keysAndVals ...interface{})
Named(string) SugaredLogger
With(keyvals ...any) SugaredLogger
Helper(skip int) SugaredLogger
}
// Sugared returns a new SugaredLogger wrapping the given Logger.
// Prefer to store the SugaredLogger for reuse, instead of recreating it as needed.
func Sugared(l Logger) SugaredLogger {
return &sugared{
Logger: l,
h: Helper(l, 1),
}
}
type sugared struct {
Logger
h Logger // helper with stack trace skip level
}
func (s *sugared) ErrorIf(err error, msg string) {
if err != nil {
s.h.Errorw(msg, "err", err)
}
}
func (s *sugared) ErrorIfFn(fn func() error, msg string) {
if err := fn(); err != nil {
s.h.Errorw(msg, "err", err)
}
}
const assumptionViolationPrefix = "AssumptionViolation: "
func (s *sugared) AssumptionViolation(args ...interface{}) {
s.h.Error(append([]interface{}{assumptionViolationPrefix}, args...))
}
func (s *sugared) AssumptionViolationf(format string, vals ...interface{}) {
s.h.Errorf(assumptionViolationPrefix+format, vals...)
}
func (s *sugared) AssumptionViolationw(msg string, keyvals ...interface{}) {
s.h.Errorw(assumptionViolationPrefix+msg, keyvals...)
}
const critPrefix = "[crit] "
func (s *sugared) Critical(args ...interface{}) {
switch t := s.h.(type) {
case *logger:
t.DPanic(args...)
return
}
c, ok := s.h.(interface {
Critical(args ...interface{})
})
if ok {
c.Critical(args...)
return
}
s.h.Error(append([]any{critPrefix}, args...)...)
}
func (s *sugared) Criticalf(format string, values ...interface{}) {
switch t := s.h.(type) {
case *logger:
t.DPanicf(format, values...)
return
}
c, ok := s.h.(interface {
Criticalf(format string, values ...interface{})
})
if ok {
c.Criticalf(format, values...)
return
}
s.h.Errorf(critPrefix+format, values...)
}
func (s *sugared) Criticalw(msg string, keysAndValues ...interface{}) {
switch t := s.h.(type) {
case *logger:
t.DPanicw(msg, keysAndValues...)
return
}
c, ok := s.h.(interface {
Criticalw(msg string, keysAndValues ...interface{})
})
if ok {
c.Criticalw(msg, keysAndValues...)
return
}
s.h.Errorw(critPrefix+msg, keysAndValues...)
}
func (s *sugared) Named(n string) SugaredLogger {
return Sugared(Named(s.Logger, n))
}
func (s *sugared) With(keyvals ...interface{}) SugaredLogger {
return Sugared(With(s.Logger, keyvals...))
}
func (s *sugared) Helper(skip int) SugaredLogger {
return Sugared(Helper(s.Logger, skip))
}