docs(errors): add MADR modern error handling strategy #15112
Conversation
This file contains hidden or 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
Automaat
added
the
ci/skip-test
Automaat
changed the title
Automaat
force-pushed
the
madr-094-modern-error-handling
branch
from
d34379e to
8c94c51
Compare
Contributor
Reviewer Checklist🔍 Each of these sections need to be checked by the reviewer of the PR 🔍:
|
Automaat
force-pushed
the
madr-094-modern-error-handling
branch
from
8c94c51 to
eca37b9
Compare
bartsmykla
reviewed
Nov 27, 2025
Automaat
force-pushed
the
madr-094-modern-error-handling
branch
from
eca37b9 to
19e841d
Compare
Addresses inconsistency between MADR 073 (stdlib) and codebase (pkg/errors). Recommends migrating to cockroachdb/errors for stack traces + performance. Co-authored-by: Bart Smykla <[email protected]> Signed-off-by: Marcin Skalski <[email protected]>
Automaat
force-pushed
the
madr-094-modern-error-handling
branch
from
42ada10 to
eb2d91c
Compare
bartsmykla
approved these changes
Nov 28, 2025
Automaat
changed the title
Automaat
changed the title
lukidzi
reviewed
Nov 28, 2025
Comment on lines
+36
to
+46
| ### Option 3: Migrate to `github.com/cockroachdb/errors` | ||
|
|
||
| Drop-in replacement, actively maintained. | ||
|
|
||
| ```go | ||
| import "github.com/cockroachdb/errors" | ||
| return errors.Wrapf(err, "sync failed: zone=%s", zone) | ||
| ``` | ||
|
|
||
| **Pros:** Stack traces, better perf, drop-in replacement, maintained, stdlib compatible | ||
| **Cons:** External dep, migration effort |
Contributor
There was a problem hiding this comment.
I’m not fully convinced we should use a new library for this. It seems to include many features we don’t need, which would introduce indirect dependencies and potentially increase our security surface. I do like the stack traces—since fmt doesn’t provide them—but given the migration effort and the lack of clear performance benefits, I’m not sure it’s worth adopting.
Contributor
Author
There was a problem hiding this comment.
there is not much stuff to migrate actually, it would be similar if we would like to move to fmt in the future
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Kuma has inconsistent error handling:
fmt.Errorf+%wgithub.com/pkg/errors(30+ usages)Requirements: stack traces, best performance, no timeline.
Implementation information
Created MADR 094 analyzing 4 options:
Decision: Gradual migration to cockroachdb/errors.
Supporting documentation