Improve handler panic reporting #145
Merged
Conversation
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
Stack traces for handler panics were lost, making it hard to determine where the panic actually happened. Now, stack traces are captured by a special error type so that handlers can print them. By default, nothing actually changes, but I plan to extend the default configuration of go-baseapp so that these errors are formatted with stack traces in logs. I copied the error code from my implementation in `bluekeyes/hatpear` so that they'll share the same interface. The `pkg/errors` package has a similar interface, but uses package-specific types. Using standard library types seemed preferrable, even though we have a dependency on `pkg/errors` already.
jamestoyer
approved these changes
Mar 14, 2022
| var ( | ||
| // HandlerRecoverStackDepth is the max depth of stack trace to recover on a | ||
| // handler panic. | ||
| HandlerRecoverStackDepth = 32 |
There was a problem hiding this comment.
Is there a reason this is 32? Or is that just a reasonable best guess?
There was a problem hiding this comment.
It's a guess. A limit is required because of how the standard library reads stack frames and 32 seems like a good balance between not being too big but having enough context to understand where the panic came from. For this, I copied the value from hatpear and when I wrote that, I probably copied what pkg/errors used, but I don't remember.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Stack traces for handler panics were lost, making it hard to determine where the panic actually happened. Now, stack traces are captured by a special error type so that handlers can print them. By default, nothing actually changes, but I plan to extend the default configuration of go-baseapp so that these errors are formatted with stack traces in logs.
I copied the error code from my implementation in
bluekeyes/hatpearso that they'll share the same interface. Thepkg/errorspackage has a similar interface, but uses package-specific types. Using standard library types seemed preferrable, even though we have a dependency onpkg/errorsalready.Closes #47. Requires apps to use palantir/go-baseapp#87 or implement their own error handlers to get the benefits.