Telemetry should send the failure message #78
Closed
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
gcurtis
reviewed
Sep 7, 2022
| } | ||
| if runErr != nil { | ||
| evt.Failed = true | ||
| evt.FailedMsg = runErr.Error() |
There was a problem hiding this comment.
It might be a good idea to only track a distinct error type so that we can redact errors for analytics. Otherwise I worry that we might return an error with sensitive info somewhere else in the code and accidentally log it.
Maybe something like this?
type RedactedError interface {
Redact() string
}
func (m *telemetryMiddleware) postRun(cmd *cobra.Command, args []string, runErr error) {
// ...
if runErr != nil {
evt.Failed = true
if redactErr, ok := runErr.(RedactedError); ok {
evt.FailedMsg = redactErr.Redact()
}
}
}There was a problem hiding this comment.
I like the idea, but I'm also worried this means we will not capture a bunch of errors as a result. I'm trying to think if there's an in-between.
There was a problem hiding this comment.
Another option is to do redacted format strings.
// Not sure on the naming or if it should go in a new package.
type SafeError struct {
format string
args []any
}
func (e *SafeError) Redacted() string {
// This is ugly. You could probably do something fancier by substituting
// the args with something else of the same type. Or use a template string
// instead of fmt.
return format
}
func (e *SafeError) Error() string {
return fmt.Sprintf(e.format, e.args...)
}
|
Abandoning in favor of Lucille's Sentry implementation. |
LucilleH
added a commit
that referenced
this pull request
Dec 3, 2022
## Summary This replaces #78 This PR does the following: 1. logs error to sentry. Sentry has built in support for removing sensitive data. 2. link the telemetry event to the sentry error event id TODO: update github action environment variables ## How was it tested? go build devbox plan (on an invalid project config)
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.
Summary
Telemetry should send the failure message whenever there's an error. That will allow us to understand what the errors are and how to fix them.
How was it tested?
Development version of segment.