-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
WrapError: wrap an error with fields to be logged by zap.Error
Related to uber-go/guide#179 Callsites that receive an error should either log, or return an error. However, if the callsite has additioanl context, the simplest option is to add it to the error, but it's then flattened into a string, losing the benefit of structured logging. This often results in callsites logging with additional fields, and returning an error that is likely to be logged again. `WrapError` provides a way for callsites to return an error that includes fields to be logged, which will be added to an `errorFields` key.
- Loading branch information
Showing
2 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
package zap | ||
|
||
import ( | ||
"go.uber.org/zap/zapcore" | ||
) | ||
|
||
type errorWithFields struct { | ||
err error | ||
fields []Field | ||
} | ||
|
||
// WrapError returns an error that will log the provided fields if the error | ||
// is logged using `Error`. | ||
func WrapError(err error, fields ...Field) error { | ||
return &errorWithFields{ | ||
err: err, | ||
fields: fields, | ||
} | ||
} | ||
|
||
func (e errorWithFields) Unwrap() error { | ||
return e.err | ||
} | ||
|
||
func (e errorWithFields) Error() string { | ||
return e.err.Error() | ||
} | ||
|
||
func (e errorWithFields) MarshalLogObject(oe zapcore.ObjectEncoder) error { | ||
for _, f := range e.fields { | ||
f.AddTo(oe) | ||
} | ||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters