-
Notifications
You must be signed in to change notification settings - Fork 275
add AddCallerSkip(1) so we aren't having the logger log itself #2182
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -101,20 +101,27 @@ type TracedLogger struct { | |
| innerLogger *zap.Logger | ||
| } | ||
|
|
||
| func withTraceLoggerOptions(innerLogger *zap.Logger) *zap.Logger { | ||
| return innerLogger.WithOptions( | ||
| zap.AddCaller(), | ||
| zap.AddCallerSkip(1), | ||
| ) | ||
| } | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| func NewTracedLoggerFromCore(core zapcore.Core) Logger { | ||
| return &TracedLogger{innerLogger: zap.New(core)} //nolint:forbidigo // zap.New is used to create a new logger from a core | ||
| return &TracedLogger{innerLogger: withTraceLoggerOptions(zap.New(core))} //nolint:forbidigo // zap.New is used to create a new logger from a core | ||
| } | ||
|
|
||
| func NewTracedLogger(innerLogger *zap.Logger) Logger { | ||
| return &TracedLogger{innerLogger: innerLogger} | ||
| return &TracedLogger{innerLogger: withTraceLoggerOptions(innerLogger)} | ||
| } | ||
|
|
||
| func L() *TracedLogger { | ||
| return &TracedLogger{innerLogger: zap.L()} //nolint:forbidigo // zap.L is used to get the global logger | ||
| } | ||
|
|
||
| func NewNopLogger() *TracedLogger { | ||
| return &TracedLogger{innerLogger: zap.NewNop()} //nolint:forbidigo // zap.NewNop is used to create a new nop logger | ||
| return &TracedLogger{innerLogger: withTraceLoggerOptions(zap.NewNop())} //nolint:forbidigo // zap.NewNop is used to create a new nop logger | ||
| } | ||
|
|
||
| func NewDevelopmentLogger() (Logger, error) { | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| "path/filepath" | ||
| "testing" | ||
|
|
||
| "go.uber.org/zap" | ||
| "go.uber.org/zap/zaptest/observer" | ||
| ) | ||
|
|
||
| func TestTracedLoggerCallerSkipsWrapper(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| core, logs := observer.New(zap.InfoLevel) | ||
| logger := NewTracedLogger(zap.New(core)) //nolint:forbidigo // test needs a raw zap.Logger with observable core | ||
|
|
||
| logger.Warn(t.Context(), "wrapper skip test") | ||
|
|
||
| entries := logs.All() | ||
| if len(entries) != 1 { | ||
| t.Fatalf("expected 1 log entry, got %d", len(entries)) | ||
| } | ||
|
|
||
| entry := entries[0] | ||
| if got := filepath.Base(entry.Caller.File); got != "logger_test.go" { | ||
| t.Fatalf("expected caller file logger_test.go, got %q", entry.Caller.File) | ||
| } | ||
| if entry.Caller.Line == 0 { | ||
| t.Fatal("expected caller line to be set") | ||
| } | ||
| } | ||
|
|
||
| func TestLAfterReplaceGlobalsCallerIsCorrect(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| core, logs := observer.New(zap.InfoLevel) | ||
| logger := NewTracedLogger(zap.New(core)) //nolint:forbidigo // test needs a raw zap.Logger with observable core | ||
|
|
||
| undo := ReplaceGlobals(t.Context(), logger) | ||
| defer undo() | ||
|
|
||
| // L() wraps zap.L() which already has AddCallerSkip(1) from ReplaceGlobals. | ||
| // This test verifies L() does not double-apply the skip. | ||
| L().Info(t.Context(), "global logger test") | ||
|
|
||
| entries := logs.All() | ||
| if len(entries) != 1 { | ||
| t.Fatalf("expected 1 log entry, got %d", len(entries)) | ||
| } | ||
|
|
||
| entry := entries[0] | ||
| if got := filepath.Base(entry.Caller.File); got != "logger_test.go" { | ||
| t.Fatalf("expected caller file logger_test.go, got %q (double AddCallerSkip?)", entry.Caller.File) | ||
| } | ||
| if entry.Caller.Line == 0 { | ||
| t.Fatal("expected caller line to be set") | ||
| } | ||
| } |


Uh oh!
There was an error while loading. Please reload this page.