From 42e3aaff35c6568721d8e2dc21ab6babcc32c20f Mon Sep 17 00:00:00 2001 From: Cytown Date: Sun, 29 Mar 2026 18:22:25 +0800 Subject: [PATCH] make logger more clear with highlight component and use package name for default component --- pkg/logger/logger.go | 45 ++++++++++++++++++++++++++++++++++---------- 1 file changed, 35 insertions(+), 10 deletions(-) diff --git a/pkg/logger/logger.go b/pkg/logger/logger.go index 1244addb2..f88d5ed2b 100644 --- a/pkg/logger/logger.go +++ b/pkg/logger/logger.go @@ -21,6 +21,8 @@ const ( WARN = zerolog.WarnLevel ERROR = zerolog.ErrorLevel FATAL = zerolog.FatalLevel + + Component = "component" ) var ( @@ -50,6 +52,18 @@ func init() { // Custom formatter to handle multiline strings and JSON objects FormatFieldValue: formatFieldValue, + PartsOrder: []string{ + zerolog.TimestampFieldName, + zerolog.LevelFieldName, + Component, + zerolog.CallerFieldName, + zerolog.MessageFieldName, + }, + FieldsExclude: []string{Component}, + FormatPrepare: func(fields map[string]any) error { + fields[Component] = fmt.Sprintf("\x1b[33m%v\x1b[0m", fields[Component]) + return nil + }, } logger = zerolog.New(consoleWriter).With().Timestamp().Caller().Logger() @@ -193,7 +207,19 @@ func ConfigureFromEnv() { } } -func getCallerSkip() int { +func getPackageNameFromFile(filePath string) string { + dir := filepath.Dir(filePath) + importPath := filepath.ToSlash(dir) + + parts := strings.Split(importPath, "/") + if len(parts) == 0 { + return "" + } + + return parts[len(parts)-1] +} + +func getCallerSkip() (int, string) { for i := 2; i < 15; i++ { pc, file, _, ok := runtime.Caller(i) if !ok { @@ -217,10 +243,10 @@ func getCallerSkip() int { continue } - return i - 1 + return i - 1, getPackageNameFromFile(file) } - return 3 + return 3, "" } //nolint:zerologlint @@ -246,14 +272,16 @@ func logMessage(level LogLevel, component string, message string, fields map[str return } - skip := getCallerSkip() + skip, pkg := getCallerSkip() event := getEvent(logger, level) - if component != "" { - event.Str("component", component) + if component == "" { + component = pkg } + event.Str(Component, component) + appendFields(event, fields) event.CallerSkipFrame(skip).Msg(message) @@ -261,10 +289,7 @@ func logMessage(level LogLevel, component string, message string, fields map[str if fileLogger.GetLevel() != zerolog.NoLevel { fileEvent := getEvent(fileLogger, level) - if component != "" { - fileEvent.Str("component", component) - } - // fileEvent.Str("caller", fmt.Sprintf("%s:%d (%s)", callerFile, callerLine, callerFunc)) + fileEvent.Str(Component, component) appendFields(fileEvent, fields) fileEvent.CallerSkipFrame(skip).Msg(message)