Skip to content
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

Jump to bottom

[logging] Fix segment logging #2322

Merged
merged 1 commit into from
Oct 4, 2024
Merged

[logging] Fix segment logging #2322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 1 addition & 7 deletions internal/boxcli/midcobra/telemetry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,9 @@ import (
"runtime/trace"
"sort"

"github.com/pkg/errors"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"go.jetpack.io/devbox/internal/boxcli/featureflag"
"go.jetpack.io/devbox/internal/boxcli/usererr"
"go.jetpack.io/devbox/internal/devbox"
"go.jetpack.io/devbox/internal/devbox/devopt"
"go.jetpack.io/devbox/internal/envir"
Expand Down Expand Up @@ -42,11 +40,6 @@ func (m *telemetryMiddleware) postRun(cmd *cobra.Command, args []string, runErr
defer trace.StartRegion(cmd.Context(), "telemetryPostRun").End()
defer telemetry.Stop()

var userExecErr *usererr.ExitError
if errors.As(runErr, &userExecErr) || !usererr.ShouldLogError(runErr) {
return
}

meta := telemetry.Metadata{
FeatureFlags: featureflag.All(),
CloudRegion: os.Getenv(envir.DevboxRegion),
Expand All @@ -68,6 +61,7 @@ func (m *telemetryMiddleware) postRun(cmd *cobra.Command, args []string, runErr

if runErr != nil {
telemetry.Error(runErr, meta)
// TODO: This is skipping event logging of calls that end in error. We probably want to log them.
return
}
telemetry.Event(telemetry.EventCommandSuccess, meta)
Expand Down
7 changes: 6 additions & 1 deletion internal/boxcli/usererr/usererr.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,16 @@ func Extract(err error) (error, bool) { // nolint: revive
return nil, false
}

// ShouldLogError returns true if the it's a logged user error or is a non-user error
// ShouldLogError returns true if the it's a combined error specifically marked to be logged
// or if it's not an ExitError.
func ShouldLogError(err error) bool {
if err == nil {
return false
}
var userExecErr *ExitError
if errors.As(err, &userExecErr) {
return false
}
c := &combined{}
if errors.As(err, &c) {
return c.logged
Expand Down
4 changes: 3 additions & 1 deletion internal/telemetry/telemetry.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import (
"github.com/google/uuid"
"github.com/pkg/errors"
segment "github.com/segmentio/analytics-go"
"go.jetpack.io/devbox/internal/boxcli/usererr"
"go.jetpack.io/devbox/internal/devbox/providers/identity"
"go.jetpack.io/devbox/internal/nix"

Expand Down Expand Up @@ -138,7 +139,8 @@ func commandEvent(meta Metadata) (id string, msg *segment.Track) {
// Error reports an error to the telemetry server.
func Error(err error, meta Metadata) {
errToLog := err // use errToLog to avoid shadowing err later. Use err to keep API clean.
if !started || errToLog == nil {

if !started || !usererr.ShouldLogError(errToLog) {
return
}

Expand Down