Fix Context.Stack() (#303)

This commit is contained in:
Ben Visness 2021-03-23 17:01:01 -05:00 committed by GitHub
parent 72b5b1ea58
commit f2cc3cf8b7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 21 additions and 9 deletions

View File

@ -406,17 +406,9 @@ func (c Context) CallerWithSkipFrameCount(skipFrameCount int) Context {
return c return c
} }
type stackTraceHook struct{}
func (sh stackTraceHook) Run(e *Event, level Level, msg string) {
e.Stack()
}
var sh = stackTraceHook{}
// Stack enables stack trace printing for the error passed to Err(). // Stack enables stack trace printing for the error passed to Err().
func (c Context) Stack() Context { func (c Context) Stack() Context {
c.l = c.l.Hook(sh) c.l.stack = true
return c return c
} }

4
log.go
View File

@ -188,6 +188,7 @@ type Logger struct {
sampler Sampler sampler Sampler
context []byte context []byte
hooks []Hook hooks []Hook
stack bool
} }
// New creates a root logger with given output writer. If the output writer implements // New creates a root logger with given output writer. If the output writer implements
@ -425,6 +426,9 @@ func (l *Logger) newEvent(level Level, done func(string)) *Event {
if l.context != nil && len(l.context) > 1 { if l.context != nil && len(l.context) > 1 {
e.buf = enc.AppendObjectData(e.buf, l.context) e.buf = enc.AppendObjectData(e.buf, l.context)
} }
if l.stack {
e.Stack()
}
return e return e
} }

View File

@ -27,6 +27,22 @@ func TestLogStack(t *testing.T) {
} }
} }
func TestLogStackFromContext(t *testing.T) {
zerolog.ErrorStackMarshaler = MarshalStack
out := &bytes.Buffer{}
log := zerolog.New(out).With().Stack().Logger() // calling Stack() on log context instead of event
err := errors.Wrap(errors.New("error message"), "from error")
log.Log().Err(err).Msg("") // not explicitly calling Stack()
got := out.String()
want := `\{"stack":\[\{"func":"TestLogStackFromContext","line":"36","source":"stacktrace_test.go"\},.*\],"error":"from error: error message"\}\n`
if ok, _ := regexp.MatchString(want, got); !ok {
t.Errorf("invalid log output:\ngot: %v\nwant: %v", got, want)
}
}
func BenchmarkLogStack(b *testing.B) { func BenchmarkLogStack(b *testing.B) {
zerolog.ErrorStackMarshaler = MarshalStack zerolog.ErrorStackMarshaler = MarshalStack
out := &bytes.Buffer{} out := &bytes.Buffer{}