Skip to content

Add unique(ish) ID to error messages for easier Rollbar cross-referencing. #3640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mitchell-as merged 2 commits into from
Feb 12, 2025
Merged

Add unique(ish) ID to error messages for easier Rollbar cross-referencing. #3640

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb4d163
Add unique(ish) ID to error messages for easier Rollbar cross-referen…
mitchell-as Feb 10, 2025
3e8a5cb
Merge branch 'version/0-48-0-RC1' into mitchell/dx-3210
mitchell-as Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions internal/runbits/errors/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"os"
"strings"

"github.com/google/uuid"
"github.com/thoas/go-funk"

"github.com/ActiveState/cli/internal/analytics"
Expand All @@ -32,6 +33,19 @@ type OutputError struct {
error
}

var errorId string

// Returns a relatively unique ID for error reporting.
Copy link
Collaborator Author

@mitchell-as mitchell-as Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need a totally unique ID, just something to search for in Rollbar to find the user's log.

// We report this ID in non-user-facing errors and on Rollbar so we can cross-reference them.
// Repeated calls return the same ID.
Copy link
Collaborator Author

@mitchell-as mitchell-as Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine because there can only ever be one error we report to the user that we'd have to lookup on Rollbar.

func getErrorId() string {
if errorId == "" {
errorId = uuid.New().String()[:8]
}

return errorId
}

func (o *OutputError) MarshalOutput(f output.Format) interface{} {
var outLines []string
isInputError := locale.IsInputError(o.error)
Expand Down Expand Up @@ -68,7 +82,11 @@ func (o *OutputError) MarshalOutput(f output.Format) interface{} {

// Concatenate error tips
errorTips := getErrorTips(o.error)
errorTips = append(errorTips, locale.Tl("err_help_forum", "Ask For Help → [ACTIONABLE]{{.V0}}[/RESET]", constants.ForumsURL))
helpMsg := locale.Tl("err_help_forum", "Ask For Help → [ACTIONABLE]{{.V0}}[/RESET]", constants.ForumsURL)
if IsReportableError(o.error) {
helpMsg += "\n " + locale.Tl("err_help_error_id", "When doing so, please reference the following error ID: {{.V0}}", getErrorId())
}
errorTips = append(errorTips, helpMsg)

// Print tips
enableTips := os.Getenv(constants.DisableErrorTipsEnvVarName) != "true" && f == output.PlainFormatName
Expand Down Expand Up @@ -197,7 +215,7 @@ func ReportError(err error, cmd *captain.Command, an analytics.Dispatcher) {
var action string
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)
Copy link
Collaborator Author

@mitchell-as mitchell-as Feb 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will call rollbar.Critical, which forwards our message and error ID to rollbar:

cli/internal/multilog/multilog.go

Line 25 in bb4d163

rollbar.Critical(format, args...)

action = anaConst.ActCommandError
} else {
logging.Debug("Returning input error:\n%s\nCreated at:\n%s", errs.JoinMessage(err), stack)
Expand Down
Loading