Consistent and greppable errors makes your logger and error reporting tools happy. This zero-dependency error handling support package for Go helps you achieve just that.
Blog post explaining the problem and the solution in detail.
When creating errors, do not include goroutine-specific or request-specific information as part of the error message itself. Error messages with these specific bits of information often break filtering/grouping algorithms, e.g. as used by error reporting tools like Sentry/Rollbar/etc. (If you use Bugsnag, I recommend kinbiko/bugsnag for an even better experience than this package).
Instead this information should be treated as structured data, akin to structured logging solutions like Logrus and Zap.
In Go, it's conventional to attach this kind of request specific 'diagnostic' metadata to a context.Context type, and that's what this package enables too.
At a high level:
- Attach metadata to your context with
rogerr.WithMetadataorrogerr.WithMetadatum. - When you come across an error, use
err = rogerr.Wrap(ctx, err, msg)to attach the metadata accumulated so far to the wrapped error. - Return the error as you would normally, and at the time of logging/reporting, extract the metadata with
md := rogerr.Metadata(err). - Record the structured metadata alongside the error message.
For more details, see the official docs.