Skip to content

Commit af1dc80

Browse files
ivanmatmatiivanmatmati
committed
BUG: fix log message origin
1 parent dde29e6 commit af1dc80

File tree

2 files changed

+111
-49
lines changed

2 files changed

+111
-49
lines changed

‎pkg/haproxy/instance/configuration.go

+22-17
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ package instance
22

33
import (
44
"fmt"
5-
"runtime/debug"
5+
"runtime"
66

77
"github.com/haproxytech/kubernetes-ingress/pkg/utils"
88
)
@@ -54,22 +54,18 @@ func NewConfigurationManager() *configurationManagerImpl {
5454

5555
func (cmi *configurationManagerImpl) SetReload(reason string, args ...any) {
5656
cmi.reload = true
57-
if reason == "" {
58-
cmi.logger.Error("empty reason for reload")
59-
cmi.logger.Debug(debug.Stack())
57+
if !cmi.validReason(reason) {
6058
return
6159
}
62-
cmi.logger.Info("reload required : " + fmt.Sprintf(reason, args...))
60+
cmi.logger.InfoSkipCallerf("reload required : "+reason, args...)
6361
}
6462

6563
func (cmi *configurationManagerImpl) SetRestart(reason string, args ...any) {
6664
cmi.restart = true
67-
if reason == "" {
68-
cmi.logger.Error("empty reason for restart")
69-
cmi.logger.Debug(debug.Stack())
65+
if !cmi.validReason(reason) {
7066
return
7167
}
72-
cmi.logger.Info("restart required : " + fmt.Sprintf(reason, args...))
68+
cmi.logger.InfoSkipCallerf("restart required : "+reason, args...)
7369
}
7470

7571
func (cmi *configurationManagerImpl) Reset() {
@@ -90,27 +86,36 @@ func (cmi *configurationManagerImpl) SetReloadIf(reload bool, reason string, arg
9086
return
9187
}
9288
cmi.reload = true
93-
if reason == "" {
94-
cmi.logger.Error("empty reason for reload")
95-
cmi.logger.Debug(debug.Stack())
89+
if !cmi.validReason(reason) {
9690
return
9791
}
98-
cmi.logger.Info("reload required : " + fmt.Sprintf(reason, args...))
92+
cmi.logger.InfoSkipCallerf("reload required : "+reason, args...)
9993
}
10094

10195
func (cmi *configurationManagerImpl) SetRestartIf(restart bool, reason string, args ...any) {
10296
if !restart {
10397
return
10498
}
10599
cmi.restart = true
106-
if reason == "" {
107-
cmi.logger.Error("empty reason for restart")
108-
cmi.logger.Debug(debug.Stack())
100+
if !cmi.validReason(reason) {
109101
return
110102
}
111-
cmi.logger.Info("restart required : " + fmt.Sprintf(reason, args...))
103+
cmi.logger.InfoSkipCallerf("restart required : "+reason, args...)
112104
}
113105

114106
func (cmi *configurationManagerImpl) NeedAction() bool {
115107
return cmi.NeedReload() || cmi.NeedRestart()
116108
}
109+
110+
func (cmi *configurationManagerImpl) validReason(reason string) bool {
111+
if reason == "" {
112+
errMsg := "empty reason for reload"
113+
_, file, line, ok := runtime.Caller(3)
114+
if ok {
115+
errMsg += fmt.Sprintf(" from %s:%d", file, line)
116+
}
117+
cmi.logger.Error(errMsg)
118+
return false
119+
}
120+
return true
121+
}

‎pkg/utils/logging.go

+89-32
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,14 @@ import (
2222
"sync"
2323
)
2424

25+
//nolint:stylecheck
2526
const (
26-
LogTypeShort = log.LstdFlags
27-
LogType = log.LstdFlags | log.Lshortfile
27+
LogTypeShort = log.LstdFlags
28+
LogType = log.LstdFlags | log.Lshortfile
29+
PKG_SUBPATH = "/pkg/"
30+
CONTROLLER_SUBPATH = "/controller"
31+
IC_REPO = "kubernetes-ingress/"
32+
IC_EE_REPO = "kubernetes-ingress-ee/"
2833
)
2934

3035
type LogLevel int8
@@ -65,18 +70,20 @@ type Logger interface { //nolint:interfacebloat
6570
Trace(args ...interface{}) // used for heavy duty output everything, not recommended for production
6671
Debug(args ...interface{}) // used to have detailed output of application flow
6772
Info(args ...interface{})
73+
InfoSkipCaller(args ...interface{})
6874
Warning(args ...interface{})
6975
Error(args ...interface{})
7076
Err(args ...interface{}) []error
7177
Panic(args ...interface{})
7278

73-
Printf(format string, args ...interface{}) // similar to fmt.SPrintf function
74-
Tracef(format string, args ...interface{}) // similar to fmt.SPrintf function
75-
Debugf(format string, args ...interface{}) // similar to fmt.SPrintf function
76-
Infof(format string, args ...interface{}) // similar to fmt.SPrintf function
77-
Warningf(format string, args ...interface{}) // similar to fmt.SPrintf function
78-
Errorf(format string, args ...interface{}) // similar to fmt.SPrintf function
79-
Panicf(format string, args ...interface{}) // similar to fmt.SPrintf function
79+
Printf(format string, args ...interface{}) // similar to fmt.SPrintf function
80+
Tracef(format string, args ...interface{}) // similar to fmt.SPrintf function
81+
Debugf(format string, args ...interface{}) // similar to fmt.SPrintf function
82+
Infof(format string, args ...interface{}) // similar to fmt.SPrintf function
83+
InfoSkipCallerf(format string, args ...interface{}) // similar to fmt.SPrintf function
84+
Warningf(format string, args ...interface{}) // similar to fmt.SPrintf function
85+
Errorf(format string, args ...interface{}) // similar to fmt.SPrintf function
86+
Panicf(format string, args ...interface{}) // similar to fmt.SPrintf function
8087

8188
SetLevel(level LogLevel)
8289
ShowFilename(show bool)
@@ -157,7 +164,15 @@ func (l *logger) fieldsAsString() string {
157164
return fields.String()
158165
}
159166

167+
func (l *logger) logSkipCaller(logType string, data ...interface{}) {
168+
l.logImp(logType, 2, data...)
169+
}
170+
160171
func (l *logger) log(logType string, data ...interface{}) {
172+
l.logImp(logType, 0, data...)
173+
}
174+
175+
func (l *logger) logImp(logType string, skipMore int, data ...interface{}) {
161176
if !l.FileName {
162177
for _, d := range data {
163178
if d == nil {
@@ -167,50 +182,46 @@ func (l *logger) log(logType string, data ...interface{}) {
167182
}
168183
return
169184
}
170-
_, file, no, ok := runtime.Caller(3)
185+
_, file, no, ok := runtime.Caller(3 + skipMore)
171186
if ok {
172-
f := strings.Split(file, "/")
173-
var file1 string
174-
if f[len(f)-2] == "controller" || f[len(f)-2] == "kubernetes-ingress" {
175-
file1 = f[len(f)-1]
176-
} else {
177-
file1 = fmt.Sprintf("%s/%s", f[len(f)-2], f[len(f)-1])
178-
}
179-
// file1 := strings.Replace(file, "/src/", "", 1)
180-
for _, d := range data {
187+
origin := getFileCaller(file)
188+
189+
for _, d := range data { //nolint:varnamelen
181190
if d == nil {
182191
continue
183192
}
184193

185194
if logType == "" {
186-
log.Printf("%s:%d %s %s\n", file1, no, l.fieldsAsString(), d)
195+
log.Printf("%s:%d %s %s\n", origin, no, l.fieldsAsString(), d)
187196
} else {
188-
log.Printf("%s%s:%d %s %s\n", logType, file1, no, l.fieldsAsString(), d)
197+
log.Printf("%s%s:%d %s %s\n", logType, origin, no, l.fieldsAsString(), d)
189198
}
190199
}
191200
}
192201
}
193202

203+
func (l *logger) logfSkipCallerf(logType string, format string, data ...interface{}) {
204+
l.logfImpl(logType, format, 2, data...)
205+
}
206+
194207
func (l *logger) logf(logType string, format string, data ...interface{}) {
208+
l.logfImpl(logType, format, 0, data...)
209+
}
210+
211+
func (l *logger) logfImpl(logType string, format string, skipMore int, data ...interface{}) {
195212
line := fmt.Sprintf(format, data...)
196213
if !l.FileName {
197214
log.Printf("%s%s\n", logType, line)
198215
return
199216
}
200-
_, file, no, ok := runtime.Caller(2)
217+
_, file, no, ok := runtime.Caller(3 + skipMore)
218+
201219
if ok {
202-
f := strings.Split(file, "/")
203-
var file1 string
204-
if f[len(f)-2] == "controller" || f[len(f)-2] == "kubernetes-ingress" {
205-
file1 = f[len(f)-1]
206-
} else {
207-
file1 = fmt.Sprintf("%s/%s", f[len(f)-2], f[len(f)-1])
208-
}
209-
// file1 := strings.Replace(file, "/src/", "", 1)
220+
origin := getFileCaller(file)
210221
if logType == "" {
211-
log.Printf("%s:%d %s %s\n", file1, no, l.fieldsAsString(), line)
222+
log.Printf("%s:%d %s %s\n", origin, no, l.fieldsAsString(), line)
212223
} else {
213-
log.Printf("%s%s:%d %s %s\n", logType, file1, no, l.fieldsAsString(), line)
224+
log.Printf("%s%s:%d %s %s\n", logType, origin, no, l.fieldsAsString(), line)
214225
}
215226
}
216227
}
@@ -253,12 +264,24 @@ func (l *logger) Info(args ...interface{}) {
253264
}
254265
}
255266

267+
func (l *logger) InfoSkipCaller(args ...interface{}) {
268+
if l.Level >= Info {
269+
l.logSkipCaller("INFO ", args...)
270+
}
271+
}
272+
256273
func (l *logger) Infof(format string, args ...interface{}) {
257274
if l.Level >= Info {
258275
l.logf("INFO ", format, args...)
259276
}
260277
}
261278

279+
func (l *logger) InfoSkipCallerf(format string, args ...interface{}) {
280+
if l.Level >= Info {
281+
l.logfSkipCallerf("INFO ", format, args...)
282+
}
283+
}
284+
262285
func (l *logger) Warning(args ...interface{}) {
263286
if l.Level >= Warning {
264287
l.log("WARNING ", args...)
@@ -329,3 +352,37 @@ func (l *logger) HandleWarningHeader(code int, agent string, text string) {
329352
}
330353
l.logf("K8s API ", " %d %s %s", code, agent, text)
331354
}
355+
356+
func getFileCaller(path string) string {
357+
pkgIndex := strings.Index(path, PKG_SUBPATH)
358+
icIndex := strings.Index(path, CONTROLLER_SUBPATH)
359+
360+
var origin string
361+
switch {
362+
case pkgIndex != -1:
363+
origin = path[pkgIndex+len(PKG_SUBPATH):]
364+
case icIndex != -1:
365+
origin = path[icIndex+len(CONTROLLER_SUBPATH):]
366+
default:
367+
offset := 0
368+
// do we have IC repo in path ?
369+
repoIndex := strings.Index(path, IC_REPO)
370+
if repoIndex == -1 {
371+
// if not do we have IC EE repo in path ?
372+
repoIndex = strings.Index(path, IC_EE_REPO)
373+
if repoIndex == -1 {
374+
// if not start reset the repo index to 0
375+
repoIndex = 0
376+
} else {
377+
// we have IC EE repo in path
378+
offset = len(IC_EE_REPO)
379+
}
380+
} else {
381+
// we have IC repo in path.
382+
offset = len(IC_REPO)
383+
}
384+
idx := repoIndex + offset
385+
origin = path[idx:]
386+
}
387+
return origin
388+
}

0 commit comments

Comments
 (0)