-
Notifications
You must be signed in to change notification settings - Fork 89
/
log.go
213 lines (168 loc) · 5.63 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
/*
Copyright 2022 The Katalyst Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package general
import (
"fmt"
"runtime"
"strconv"
"strings"
"sync"
"k8s.io/klog/v2"
)
type LoggingPKG int
func (l *LoggingPKG) Type() string {
return "LoggingPKG"
}
func (l *LoggingPKG) String() string {
return fmt.Sprintf("logging-level: %v", *l)
}
func (l *LoggingPKG) Set(value string) error {
level, err := strconv.Atoi(value)
if err != nil {
return err
}
*l = LoggingPKG(level)
return nil
}
const (
LoggingPKGNone LoggingPKG = iota
LoggingPKGShort
LoggingPKGFull
)
var (
defaultLoggingPackage = LoggingPKGFull
defaultLoggingMtx sync.RWMutex
)
// SetDefaultLoggingPackage should only be called by flags,
// and should not be alerted dynamically.
func SetDefaultLoggingPackage(l LoggingPKG) {
defaultLoggingMtx.Lock()
defer defaultLoggingMtx.Unlock()
defaultLoggingPackage = l
}
func getDefaultLoggingPackage() LoggingPKG {
defaultLoggingMtx.RLock()
defer defaultLoggingMtx.RUnlock()
return defaultLoggingPackage
}
const callDepth = 3
const skippedPackagePrefix = "github.com/kubewharf/"
// loggingWithDepth returns the logging-prefix for caller.
// it will help to avoid hardcode function names in logging
// message especially for cases that function names are changed.
func loggingWithDepth(pkg LoggingPKG) string {
pc, _, _, ok := runtime.Caller(callDepth)
if !ok {
return ""
}
callPath := runtime.FuncForPC(pc).Name()
callerNames := strings.Split(callPath, "/")
if len(callerNames) == 0 {
return ""
}
switch pkg {
case LoggingPKGNone:
funcNames := strings.Split(callerNames[len(callerNames)-1], ".")
if len(funcNames) == 0 {
return ""
}
return funcNames[len(funcNames)-1]
case LoggingPKGShort:
return callerNames[len(callerNames)-1]
case LoggingPKGFull:
return strings.TrimPrefix(callPath, skippedPackagePrefix)
}
return ""
}
func logging(message string, params ...interface{}) string {
return "[" + loggingWithDepth(getDefaultLoggingPackage()) + "] " + fmt.Sprintf(message, params...)
}
func loggingPath(pkg LoggingPKG, message string, params ...interface{}) string {
return "[" + loggingWithDepth(pkg) + "] " + fmt.Sprintf(message, params...)
}
func InfoS(message string, params ...interface{}) {
klog.InfoSDepth(1, logging(message), params...)
}
func InfoSPath(pkg LoggingPKG, message string, params ...interface{}) {
klog.InfoSDepth(1, loggingPath(pkg, message), params...)
}
func Infof(message string, params ...interface{}) {
klog.InfofDepth(1, logging(message, params...))
}
func InfofPath(pkg LoggingPKG, message string, params ...interface{}) {
klog.InfofDepth(1, loggingPath(pkg, message, params...))
}
func InfofV(level int, message string, params ...interface{}) {
klog.V(klog.Level(level)).InfofDepth(1, logging(message, params...))
}
func InfofVPath(pkg LoggingPKG, level int, message string, params ...interface{}) {
klog.V(klog.Level(level)).InfofDepth(1, loggingPath(pkg, message, params...))
}
func Warningf(message string, params ...interface{}) {
klog.WarningfDepth(1, logging(message, params...))
}
func WarningfPath(pkg LoggingPKG, message string, params ...interface{}) {
klog.WarningfDepth(1, loggingPath(pkg, message, params...))
}
func Errorf(message string, params ...interface{}) {
klog.ErrorfDepth(1, logging(message, params...))
}
func ErrorfPath(pkg LoggingPKG, message string, params ...interface{}) {
klog.ErrorfDepth(1, loggingPath(pkg, message, params...))
}
func ErrorS(err error, message string, params ...interface{}) {
klog.ErrorSDepth(1, err, logging(message), params...)
}
func ErrorSPath(pkg LoggingPKG, err error, message string, params ...interface{}) {
klog.ErrorSDepth(1, err, loggingPath(pkg, message), params...)
}
func Fatalf(message string, params ...interface{}) {
klog.FatalfDepth(1, logging(message, params...))
}
func FatalfPath(pkg LoggingPKG, message string, params ...interface{}) {
klog.FatalfDepth(1, loggingPath(pkg, message, params...))
}
type Logger struct {
pkg LoggingPKG
prefix string
}
func LoggerWithPrefix(prefix string, pkg LoggingPKG) Logger {
if len(prefix) > 0 {
prefix = fmt.Sprintf("%v: ", prefix)
}
return Logger{pkg: pkg, prefix: prefix}
}
func (l Logger) logging(message string, params ...interface{}) string {
return "[" + l.prefix + loggingWithDepth(l.pkg) + "] " + fmt.Sprintf(message, params...)
}
func (l Logger) InfoS(message string, params ...interface{}) {
klog.InfoSDepth(1, l.logging(message), params...)
}
func (l Logger) Infof(message string, params ...interface{}) {
klog.InfofDepth(1, l.logging(message, params...))
}
func (l Logger) InfofV(level int, message string, params ...interface{}) {
klog.V(klog.Level(level)).InfofDepth(1, l.logging(message, params...))
}
func (l Logger) Warningf(message string, params ...interface{}) {
klog.WarningfDepth(1, l.logging(message, params...))
}
func (l Logger) Errorf(message string, params ...interface{}) {
klog.ErrorfDepth(1, l.logging(message, params...))
}
func (l Logger) ErrorS(err error, message string, params ...interface{}) {
klog.ErrorSDepth(1, err, l.logging(message), params...)
}
func (l Logger) Fatalf(message string, params ...interface{}) {
klog.FatalfDepth(1, l.logging(message, params...))
}