fix: Report usage error including stack trace #189
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
rhcarvalho
commented
Apr 3, 2020
| event.Level = level | ||
| event.Message = fmt.Sprintf("Called %s with nil value", callerFunctionName()) | ||
| return event | ||
| exception = usageError{fmt.Errorf("%s called with nil error", callerFunctionName())} |
There was a problem hiding this comment.
Moved the function name to the very beginning because it is the most relevant information.
Prior to this, calling CaptureException, Recover or RecoverWithContext with a nil error would send a message event to Sentry without a stack trace. Looking at the Sentry issues list, and issue detail, all you see is "Called CaptureException with nil value" without a clue of what caused it. This commit turns that message into a sentry.usageError with a stack trace, making it easier to understand what is wrong and fix user code.
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.
Prior to this, calling
CaptureException,RecoverorRecoverWithContextwith anilerror would send a message event to Sentry without a stack trace.Looking at the Sentry issues list, and issue detail, all you see is "Called CaptureException with nil value" without a clue of what caused it.
This change turns that message into a
sentry.usageError(new type) with a stack trace, making it easier to understand what is wrong and fix user code.BEFORE
No stacktrace nor any clue where the incorrect call to
CaptureExceptionis.AFTER
Usage error with description and file name and line number information, plus source code context when available.
Without source context: