Small improvements to telemetry (#379)

## Summary
- Add subcommand, args and pkgs information to Sentry (it's already in
Amplitude)
- Assign an anonymized user id for Sentry
- Add shell info.
- Detect WSL

## How was it tested?
Built locally.

Author: loreto

internal/boxcli/midcobra/telemetry.go

@@ -8,10 +8,8 @@ import (
 	"io"
 	"log"
 	"os"
-	"runtime"
 	"time"
 
-	"github.com/denisbrodbeck/machineid"
 	"github.com/getsentry/sentry-go"
 	segment "github.com/segmentio/analytics-go"
 	"github.com/spf13/cobra"
@@ -83,6 +81,16 @@ func (m *telemetryMiddleware) postRun(cmd *cobra.Command, args []string, runErr
 		return // Ignore invalid commands
 	}
 
+	pkgs := getPackages(cmd)
+
+	sentry.ConfigureScope(func(scope *sentry.Scope) {
+		scope.SetTag("command", subcmd.CommandPath())
+		scope.SetContext("command", map[string]interface{}{
+			"subcommand": subcmd.CommandPath(),
+			"args":       subargs,
+			"packages":   pkgs,
+		})
+	})
 	// verified with manual testing that the sentryID returned by CaptureException
 	// is the same as m.ExecutionID, since we set EventID = m.ExecutionID in sentry.Init
 	sentry.CaptureException(runErr)
@@ -96,11 +104,12 @@ func (m *telemetryMiddleware) postRun(cmd *cobra.Command, args []string, runErr
 		AppVersion:    m.opts.AppVersion,
 		Command:       subcmd.CommandPath(),
 		CommandArgs:   subargs,
-		DeviceID:      deviceID(),
+		DeviceID:      telemetry.DeviceID(),
 		Duration:      time.Since(m.startTime),
 		Failed:        runErr != nil,
-		Packages:      getPackages(cmd),
+		Packages:      pkgs,
 		SentryEventID: sentryEventID,
+		Shell:         os.Getenv("SHELL"),
 	})
 }
 
@@ -109,12 +118,6 @@ func (m *telemetryMiddleware) withExecutionID(execID string) Middleware {
 	return m
 }
 
-func deviceID() string {
-	salt := "64ee464f-9450-4b14-8d9c-014c0012ac1a"
-	hashedID, _ := machineid.ProtectedID(salt) // Ensure machine id is hashed and non-identifiable
-	return hashedID
-}
-
 func getSubcommand(c *cobra.Command, args []string) (subcmd *cobra.Command, subargs []string, err error) {
 	if c.TraverseChildren {
 		subcmd, subargs, err = c.Traverse(args)
@@ -154,6 +157,7 @@ type event struct {
 	Failed        bool
 	Packages      []string
 	SentryEventID string
+	Shell         string
 }
 
 func trackEvent(client segment.Client, evt *event) {
@@ -169,7 +173,7 @@ func trackEvent(client segment.Client, evt *event) {
 				Version: evt.AppVersion,
 			},
 			OS: segment.OSInfo{
-				Name: runtime.GOOS,
+				Name: telemetry.OS(),
 			},
 		},
 		Properties: segment.NewProperties().
@@ -178,6 +182,7 @@ func trackEvent(client segment.Client, evt *event) {
 			Set("failed", evt.Failed).
 			Set("duration", evt.Duration.Milliseconds()).
 			Set("packages", evt.Packages).
-			Set("sentry_event_id", evt.SentryEventID),
+			Set("sentry_event_id", evt.SentryEventID).
+			Set("shell", evt.Shell),
 	})
 }

internal/cloud/mutagen/install.go

@@ -8,10 +8,11 @@ import (
 
 	"github.com/cavaliergopher/grab/v3"
 	"go.jetpack.io/devbox/internal/debug"
+	"go.jetpack.io/devbox/internal/fileutil"
 )
 
 func InstallMutagenOnce(binPath string) error {
-	if IsFile(binPath) {
+	if fileutil.IsFile(binPath) {
 		// Already installed, do nothing
 		// TODO: ideally we would check that the right version
 		//   is installed, and maybe we should also validate
@@ -43,7 +44,7 @@ func Install(url string, installDir string) error {
 	if err != nil {
 		return err
 	}
-	err = Untar(tarReader, installDir)
+	err = fileutil.Untar(tarReader, installDir)
 	if err != nil {
 		return err
 	}

internal/cloud/mutagen/fileutil.go renamed to internal/fileutil/fileutil.go

@@ -1,4 +1,4 @@
-package mutagen
+package fileutil
 
 import (
 	"os"
@@ -54,7 +54,12 @@ func IsSymlink(path string) bool {
 	return (info.Mode().Type() & os.ModeSymlink) == os.ModeSymlink
 }
 
-func ExistsOrErr(path string) error {
+func Exists(path string) bool {
+	err := TryExists(path)
+	return err == nil
+}
+
+func TryExists(path string) error {
 	_, err := os.Stat(path)
 	return err
 }

internal/cloud/mutagen/untar.go renamed to internal/fileutil/untar.go

@@ -1,4 +1,4 @@
-package mutagen
+package fileutil
 
 // TODO: publish as it's own shared package that other binaries
 // can use.
@@ -15,7 +15,7 @@ import (
 )
 
 func Untar(archive io.Reader, destPath string) error {
-	err := ExistsOrErr(destPath)
+	err := TryExists(destPath)
 	if err != nil {
 		return err
 	}

internal/telemetry/sentry.go

@@ -48,6 +48,12 @@ func (s *Sentry) Init(appName, appVersion, executionID string) {
 			return event
 		},
 	})
+	sentry.ConfigureScope(func(scope *sentry.Scope) {
+		scope.SetUser(sentry.User{ID: DeviceID()})
+		scope.SetContext("os", map[string]interface{}{
+			"name": OS(),
+		})
+	})
 }
 
 // CaptureException

internal/telemetry/telemetry.go

@@ -2,14 +2,34 @@ package telemetry
 
 import (
 	"os"
+	"runtime"
 	"strconv"
+
+	"github.com/denisbrodbeck/machineid"
+	"go.jetpack.io/devbox/internal/fileutil"
 )
 
 func DoNotTrack() bool {
 	// https://consoledonottrack.com/
-	doNotTrack_, err := strconv.ParseBool(os.Getenv("DO_NOT_TRACK"))
+	doNotTrack, err := strconv.ParseBool(os.Getenv("DO_NOT_TRACK"))
 	if err != nil {
-		doNotTrack_ = false
+		doNotTrack = false
 	}
-	return doNotTrack_
+	return doNotTrack
+}
+
+func DeviceID() string {
+	salt := "64ee464f-9450-4b14-8d9c-014c0012ac1a"
+	hashedID, _ := machineid.ProtectedID(salt) // Ensure machine id is hashed and non-identifiable
+	return hashedID
+}
+
+func OS() string {
+	os := runtime.GOOS
+	// Special case for WSL, which is reported as 'linux' otherwise.
+	if fileutil.Exists("/proc/sys/fs/binfmt_misc/WSLInterop") || fileutil.Exists("/run/WSL") {
+		os = "wsl"
+	}
+
+	return os
 }