Add unique(ish) ID to error messages for easier Rollbar cross-referencing. #3640
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
github-actions
bot
changed the base branch from
master
to
version/0-48-0-RC1
mitchell-as
force-pushed
the
mitchell/dx-3210
branch
from
5402b44 to
bb4d163
Compare
mitchell-as
commented
Feb 10, 2025
| errorMsg := err.Error() | ||
| if IsReportableError(err) { | ||
| multilog.Critical("Returning error:\n%s\nCreated at:\n%s", errs.JoinMessage(err), stack) | ||
| multilog.Critical("Returning error (ID: %s):\n%s\nCreated at:\n%s", getErrorId(), errs.JoinMessage(err), stack) |
Collaborator
Author
There was a problem hiding this comment.
This will call rollbar.Critical, which forwards our message and error ID to rollbar:
cli/internal/multilog/multilog.go
Line 25 in bb4d163
mitchell-as
commented
Feb 10, 2025
|
|
||
| // Returns a relatively unique ID for error reporting. | ||
| // We report this ID in non-user-facing errors and on Rollbar so we can cross-reference them. | ||
| // Repeated calls return the same ID. |
Collaborator
Author
There was a problem hiding this comment.
This is fine because there can only ever be one error we report to the user that we'd have to lookup on Rollbar.
mitchell-as
commented
Feb 10, 2025
|
|
||
| var errorId string | ||
|
|
||
| // Returns a relatively unique ID for error reporting. |
Collaborator
Author
There was a problem hiding this comment.
We don't need a totally unique ID, just something to search for in Rollbar to find the user's log.
SkyLeite
approved these changes
Feb 12, 2025
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.
Sample:
Note the last line of output.