feat: Added extra fields for sentry (keploy#1203)

* fix: added extra fields for sentry Signed-off-by: Pranshu Srivastava <[email protected]> * fix: removed unnecessary changes Signed-off-by: Pranshu Srivastava <[email protected]> * fix: fix merge conflicts Signed-off-by: Pranshu Srivastava <[email protected]> * fix: addressed the comments Signed-off-by: Pranshu Srivastava <[email protected]> * fix: removed unnecessary files Signed-off-by: Pranshu Srivastava <[email protected]> * fix: fix indentation Signed-off-by: Pranshu Srivastava <[email protected]> * fix: remove binary Signed-off-by: Pranshu Srivastava <[email protected]> --------- Signed-off-by: Pranshu Srivastava <[email protected]> Former-commit-id: 1dccf36
Mukund-Tandon · Dec 18, 2023 · 96979e0 · 96979e0
1 parent 54a9992
commit 96979e0
Show file tree

Hide file tree

Showing 18 changed files with 101 additions and 26 deletions.
diff --git a/cmd/mockrecord.go b/cmd/mockrecord.go
@@ -65,20 +65,29 @@ func (mr *MockRecord) GetCmd() *cobra.Command {
 				return
 			}
 
+			enableTele, err := cmd.Flags().GetBool("enableTele")
+			if err != nil {
+				mr.logger.Error(Emoji + "failed to read the enableTele flag")
+				return
+			}
+
+
 			proxyPort, err := cmd.Flags().GetUint32("proxyport")
 			if err != nil {
 				mr.logger.Error(Emoji + "failed to read the proxy port")
 				return
 			}
 
-			mr.mockRecorder.MockRecord(path, proxyPort, pid, dir)
+			mr.mockRecorder.MockRecord(path, proxyPort, pid, dir, enableTele)
 		},
 	}
 
 	serveCmd.Flags().Uint32("pid", 0, "Process id of your application.")
 	serveCmd.MarkFlagRequired("pid")
 
 	serveCmd.Flags().Uint32("proxyport", 0, "Choose a port to run Keploy Proxy.")
+	serveCmd.Flags().Bool("enableTele", true, "Switch for telemetry")
+	serveCmd.Flags().MarkHidden("enableTele")
 
 	serveCmd.Flags().StringP("path", "p", "", "Path to local directory where generated testcases/mocks are stored")
 	serveCmd.MarkFlagRequired("path")

diff --git a/cmd/mocktest.go b/cmd/mocktest.go
@@ -65,13 +65,19 @@ func (s *MockTest) GetCmd() *cobra.Command {
 				return
 			}
 
+			enableTele, err := cmd.Flags().GetBool("enableTele")
+			if err != nil {
+				s.logger.Error(Emoji + "failed to read the enableTele flag")
+				return
+			}
+
 			proxyPort, err := cmd.Flags().GetUint32("proxyport")
 			if err != nil {
 				s.logger.Error(Emoji + "failed to read the proxyport")
 				return
 			}
 
-			s.mockTester.MockTest(path, proxyPort, pid, dir)
+			s.mockTester.MockTest(path, proxyPort, pid, dir, enableTele)
 		},
 	}
 
@@ -81,6 +87,8 @@ func (s *MockTest) GetCmd() *cobra.Command {
 	serveCmd.Flags().StringP("path", "p", "", "Path to local directory where generated testcases/mocks are stored")
 	serveCmd.MarkFlagRequired("path")
 	serveCmd.Flags().Uint32("proxyport", 0, "Choose a port to run Keploy Proxy.")
+	serveCmd.Flags().Bool("enableTele", true, "Switch for telemetry")
+	serveCmd.Flags().MarkHidden("enableTele")
 
 	serveCmd.Flags().StringP("mockName", "m", "", "User provided test suite")
 	serveCmd.MarkFlagRequired("mockName")

diff --git a/cmd/record.go b/cmd/record.go
@@ -146,6 +146,12 @@ func (r *Record) GetCmd() *cobra.Command {
 				return err
 			}
 
+			enableTele, err := cmd.Flags().GetBool("enableTele")
+			if err != nil {
+				r.logger.Error("failed to read the disable telemetry flag")
+				return err
+			}
+
 			err = r.GetRecordConfig(&path, &proxyPort, &appCmd, &appContainer, &networkName, &delay, &buildDelay, &ports, configPath)
 			if err != nil {
 				if err == errFileNotFound {
@@ -204,7 +210,7 @@ func (r *Record) GetCmd() *cobra.Command {
 			}
 
 			r.logger.Debug("the ports are", zap.Any("ports", ports))
-			r.recorder.CaptureTraffic(path, proxyPort, appCmd, appContainer, networkName, delay, buildDelay, ports, &filters)
+			r.recorder.CaptureTraffic(path, proxyPort, appCmd, appContainer, networkName, delay, buildDelay, ports, &filters, enableTele)
 			return nil
 		},
 	}
@@ -227,6 +233,9 @@ func (r *Record) GetCmd() *cobra.Command {
 
 	recordCmd.Flags().String("config-path", ".", "Path to the local directory where keploy configuration file is stored")
 
+	recordCmd.Flags().Bool("enableTele", true, "Switch for telemetry")
+	recordCmd.Flags().MarkHidden("enableTele")
+
 	recordCmd.SilenceUsage = true
 	recordCmd.SilenceErrors = true
 

diff --git a/cmd/root.go b/cmd/root.go
@@ -7,11 +7,14 @@ import (
 	"net/http"
 	_ "net/http/pprof"
 	"os"
+	"os/exec"
+	"runtime"
 	"time"
 
 	"github.com/TheZeroSlave/zapsentry"
 	sentry "github.com/getsentry/sentry-go"
 	"github.com/spf13/cobra"
+	"go.keploy.io/server/pkg/platform/fs"
 	"go.keploy.io/server/utils"
 	"go.uber.org/zap"
 	"go.uber.org/zap/buffer"
@@ -124,8 +127,35 @@ func modifyToSentryLogger(log *zap.Logger, client *sentry.Client) *zap.Logger {
 	}
 
 	log = zapsentry.AttachCoreToLogger(core, log)
-
-	return log.With(zapsentry.NewScope())
+	kernelVersion := ""
+	if runtime.GOOS == "linux" {
+		cmd := exec.Command("uname", "-r")
+		kernelBytes, err := cmd.Output()
+		if err != nil {
+			log.Debug("failed to get kernel version", zap.Error(err))
+		} else {
+			kernelVersion = string(kernelBytes)
+		}
+	}
+	arch := runtime.GOARCH
+	installationID, err := fs.NewTeleFS(log).Get(false)
+	if err != nil {
+		log.Debug("failed to get installationID", zap.Error(err))
+	}
+	if installationID == "" {
+		installationID, err = fs.NewTeleFS(log).Get(true)
+		if err != nil {
+			log.Debug("failed to get installationID for new user.", zap.Error(err))
+		}
+	}
+	sentry.ConfigureScope(func(scope *sentry.Scope) {
+		scope.SetTag("Keploy Version", utils.KeployVersion)
+		scope.SetTag("Linux Kernel Version", kernelVersion)
+		scope.SetTag("Architecture", arch)
+		scope.SetTag("Installation ID", installationID)
+		// Add more context as needed
+	})
+	return log
 }
 
 func customTimeEncoder(t time.Time, enc zapcore.PrimitiveArrayEncoder) {

diff --git a/cmd/serve.go b/cmd/serve.go
@@ -100,14 +100,20 @@ func (s *Serve) GetCmd() *cobra.Command {
 				return
 			}
 
+			enableTele, err := cmd.Flags().GetBool("enableTele")
+			if err != nil {
+				s.logger.Error("failed to read the disable telemetry flag")
+				return
+			}
+
 			proxyPort, err := cmd.Flags().GetUint32("proxyport")
 			if err != nil {
 				s.logger.Error("failed to read the proxy port")
 				return
 			}
 			s.logger.Debug("the ports are", zap.Any("ports", ports))
 
-			s.server.Serve(path, proxyPort, testReportPath, delay, pid, port, language, ports, apiTimeout, appCmd)
+			s.server.Serve(path, proxyPort, testReportPath, delay, pid, port, language, ports, apiTimeout, appCmd, enableTele)
 		},
 	}
 
@@ -125,6 +131,8 @@ func (s *Serve) GetCmd() *cobra.Command {
 	serveCmd.Flags().Uint64("apiTimeout", 5, "User provided timeout for calling its application")
 
 	serveCmd.Flags().UintSlice("passThroughPorts", []uint{}, "Ports of Outgoing dependency calls to be ignored as mocks")
+	serveCmd.Flags().Bool("enableTele", true, "Switch for telemetry")
+	serveCmd.Flags().MarkHidden("enableTele")
 
 	serveCmd.Flags().StringP("language", "l", "", "application programming language")
 	serveCmd.Flags().StringP("command", "c", "", "Command to start the user application")

diff --git a/cmd/test.go b/cmd/test.go
@@ -172,6 +172,12 @@ func (t *Test) GetCmd() *cobra.Command {
 				return err
 			}
 
+			enableTele, err := cmd.Flags().GetBool("enableTele")
+			if err != nil {
+				t.logger.Error("failed to read the disable telemetry flag")
+				return err
+			}
+
 			tests := map[string][]string{}
 
 			testsets, err := cmd.Flags().GetStringSlice("testsets")
@@ -278,7 +284,7 @@ func (t *Test) GetCmd() *cobra.Command {
 				TestsetNoise:       testsetNoise,
 				WithCoverage:       withCoverage,
 				CoverageReportPath: coverageReportPath,
-			})
+			}, enableTele)
 
 			return nil
 		},
@@ -309,6 +315,9 @@ func (t *Test) GetCmd() *cobra.Command {
 
 	testCmd.Flags().String("coverageReportPath", "", "Write a go coverage profile to the file in the given directory.")
 
+	testCmd.Flags().Bool("enableTele", true, "Switch for telemetry")
+	testCmd.Flags().MarkHidden("enableTele")
+
 	testCmd.Flags().Bool("withCoverage", false, "Capture the code coverage of the go binary in the command flag.")
 	testCmd.Flags().Lookup("withCoverage").NoOptDefVal = "true"
 	testCmd.SilenceUsage = true

diff --git a/pkg/platform/fs/tele.go b/pkg/platform/fs/tele.go
@@ -21,9 +21,9 @@ type Telemetry struct {
 
 func UserHomeDir(isNewConfigPath bool) string {
 
-	var configFolder = "/keploy-config"
+	var configFolder = "/.keploy-config"
 	if isNewConfigPath {
-		configFolder = "/.keploy-config"
+		configFolder = "/.keploy"
 	}
 
 	if runtime.GOOS == "windows" {

diff --git a/pkg/service/mockrecord/mockrecord.go b/pkg/service/mockrecord/mockrecord.go
@@ -32,11 +32,11 @@ func NewMockRecorder(logger *zap.Logger) MockRecorder {
 	}
 }
 
-func (s *mockRecorder) MockRecord(path string, proxyPort uint32, pid uint32, mockName string) {
+func (s *mockRecorder) MockRecord(path string, proxyPort uint32, pid uint32, mockName string, enableTele bool) {
 
 	models.SetMode(models.MODE_RECORD)
 	teleFS := fs.NewTeleFS(s.logger)
-	tele := telemetry.NewTelemetry(true, false, teleFS, s.logger, "", nil)
+	tele := telemetry.NewTelemetry(enableTele, false, teleFS, s.logger, "", nil)
 	tele.Ping(false)
 	ys := yaml.NewYamlStore(path, path, "", mockName, s.logger, tele)
 	routineId := pkg.GenerateRandomID()

diff --git a/pkg/service/mockrecord/service.go b/pkg/service/mockrecord/service.go
@@ -1,5 +1,5 @@
 package mockrecord
 
 type MockRecorder interface {
-	MockRecord(path string, proxyPort uint32, pid uint32, dir string)
+	MockRecord(path string, proxyPort uint32, pid uint32, dir string, enableTele bool)
 }
diff --git a/pkg/service/mocktest/mocktest.go b/pkg/service/mocktest/mocktest.go
@@ -32,11 +32,11 @@ func NewMockTester(logger *zap.Logger) MockTester {
 	}
 }
 
-func (s *mockTester) MockTest(path string, proxyPort, pid uint32, mockName string) {
+func (s *mockTester) MockTest(path string, proxyPort, pid uint32, mockName string, enableTele bool) {
 
 	models.SetMode(models.MODE_TEST)
 	teleFS := fs.NewTeleFS(s.logger)
-	tele := telemetry.NewTelemetry(true, false, teleFS, s.logger, "", nil)
+	tele := telemetry.NewTelemetry(enableTele, false, teleFS, s.logger, "", nil)
 	tele.Ping(false)
 	ys := yaml.NewYamlStore(path, path, "", mockName, s.logger, tele)
 	s.logger.Debug("path of mocks : " + path)

diff --git a/pkg/service/mocktest/service.go b/pkg/service/mocktest/service.go
@@ -1,5 +1,5 @@
 package mocktest
 
 type MockTester interface {
-	MockTest(path string, proxyPort uint32, pid uint32, dir string)
+	MockTest(path string, proxyPort uint32, pid uint32, dir string, enableTele bool)
 }
diff --git a/pkg/service/record/record.go b/pkg/service/record/record.go
@@ -29,16 +29,15 @@ func NewRecorder(logger *zap.Logger) Recorder {
 	}
 }
 
-func (r *recorder) CaptureTraffic(path string, proxyPort uint32, appCmd, appContainer, appNetwork string, Delay uint64, buildDelay time.Duration, ports []uint, filters *models.Filters) {
+func (r *recorder) CaptureTraffic(path string, proxyPort uint32, appCmd, appContainer, appNetwork string, Delay uint64, buildDelay time.Duration, ports []uint, filters *models.Filters, enableTele bool) {
 
 	var ps *proxy.ProxySet
 	stopper := make(chan os.Signal, 1)
 	signal.Notify(stopper, os.Interrupt, os.Kill, syscall.SIGHUP, syscall.SIGINT, syscall.SIGQUIT, syscall.SIGTERM, syscall.SIGKILL)
 
 	models.SetMode(models.MODE_RECORD)
-
 	teleFS := fs.NewTeleFS(r.Logger)
-	tele := telemetry.NewTelemetry(true, false, teleFS, r.Logger, "", nil)
+	tele := telemetry.NewTelemetry(enableTele, false, teleFS, r.Logger, "", nil)
 	tele.Ping(false)
 
 	dirName, err := yaml.NewSessionIndex(path, r.Logger)

diff --git a/pkg/service/record/service.go b/pkg/service/record/service.go
@@ -1,10 +1,11 @@
 package record
 
 import (
-	"go.keploy.io/server/pkg/models"
 	"time"
+
+	"go.keploy.io/server/pkg/models"
 )
 
 type Recorder interface {
-	CaptureTraffic(path string, proxyPort uint32, appCmd, appContainer, networkName string, Delay uint64, buildDelay time.Duration, ports []uint, filters *models.Filters)
+	CaptureTraffic(path string, proxyPort uint32, appCmd, appContainer, networkName string, Delay uint64, buildDelay time.Duration, ports []uint, filters *models.Filters, enableTele bool)
 }
diff --git a/pkg/service/serve/serve.go b/pkg/service/serve/serve.go
@@ -43,7 +43,7 @@ func NewServer(logger *zap.Logger) Server {
 const defaultPort = 6789
 
 // Serve is called by the serve command and is used to run a graphql server, to run tests separately via apis.
-func (s *server) Serve(path string, proxyPort uint32, testReportPath string, Delay uint64, pid, port uint32, lang string, passThroughPorts []uint, apiTimeout uint64, appCmd string) {
+func (s *server) Serve(path string, proxyPort uint32, testReportPath string, Delay uint64, pid, port uint32, lang string, passThroughPorts []uint, apiTimeout uint64, appCmd string, enableTele bool) {
 	var ps *proxy.ProxySet
 
 	if port == 0 {
@@ -58,7 +58,7 @@ func (s *server) Serve(path string, proxyPort uint32, testReportPath string, Del
 	tester := test.NewTester(s.logger)
 	testReportFS := yaml.NewTestReportFS(s.logger)
 	teleFS := fs.NewTeleFS(s.logger)
-	tele := telemetry.NewTelemetry(true, false, teleFS, s.logger, "", nil)
+	tele := telemetry.NewTelemetry(enableTele, false, teleFS, s.logger, "", nil)
 	tele.Ping(false)
 	ys := yaml.NewYamlStore("", "", "", "", s.logger, tele)
 	routineId := pkg.GenerateRandomID()

diff --git a/pkg/service/serve/service.go b/pkg/service/serve/service.go
@@ -1,5 +1,5 @@
 package serve
 
 type Server interface {
-	Serve(path string, proxyPort uint32, testReportPath string, Delay uint64, pid, port uint32, lang string, passThroughPorts []uint, apiTimeout uint64, appCmd string)
+	Serve(path string, proxyPort uint32, testReportPath string, Delay uint64, pid, port uint32, lang string, passThroughPorts []uint, apiTimeout uint64, appCmd string, enableTele bool)
 }
diff --git a/pkg/service/test/service.go b/pkg/service/test/service.go
@@ -10,7 +10,7 @@ import (
 )
 
 type Tester interface {
-	Test(path string, testReportPath string, appCmd string, options TestOptions) bool
+	Test(path string, testReportPath string, appCmd string, options TestOptions, enableTele bool) bool
 	RunTestSet(testSet, path, testReportPath, appCmd, appContainer, appNetwork string, delay uint64, buildDelay time.Duration, pid uint32, ys platform.TestCaseDB, loadedHook *hooks.Hook, testReportfs platform.TestReportDB, testRunChan chan string, apiTimeout uint64, ctx context.Context, testcases map[string]bool, noiseConfig models.GlobalNoise, serveTest bool) models.TestRunStatus
 	InitialiseTest(cfg *TestConfig) (InitialiseTestReturn, error)
 	InitialiseRunTestSet(cfg *RunTestSetConfig) InitialiseRunTestSetReturn

diff --git a/pkg/service/test/test.go b/pkg/service/test/test.go
@@ -111,7 +111,7 @@ func (t *tester) InitialiseTest(cfg *TestConfig) (InitialiseTestReturn, error) {
 	models.SetMode(models.MODE_TEST)
 
 	teleFS := fs.NewTeleFS(t.logger)
-	tele := telemetry.NewTelemetry(true, false, teleFS, t.logger, "", nil)
+	tele := telemetry.NewTelemetry(cfg.EnableTele, false, teleFS, t.logger, "", nil)
 
 	returnVal.TestReportFS = yaml.NewTestReportFS(t.logger)
 	// fetch the recorded testcases with their mocks
@@ -189,7 +189,7 @@ func (t *tester) InitialiseTest(cfg *TestConfig) (InitialiseTestReturn, error) {
 	return returnVal, nil
 }
 
-func (t *tester) Test(path string, testReportPath string, appCmd string, options TestOptions) bool {
+func (t *tester) Test(path string, testReportPath string, appCmd string, options TestOptions, enableTele bool) bool {
 
 	testRes := false
 	result := true
@@ -209,6 +209,7 @@ func (t *tester) Test(path string, testReportPath string, appCmd string, options
 		MongoPassword:      options.MongoPassword,
 		WithCoverage:       options.WithCoverage,
 		CoverageReportPath: options.CoverageReportPath,
+		EnableTele:         enableTele,
 	}
 	initialisedValues, err := t.InitialiseTest(cfg)
 	// Recover from panic and gracfully shutdown

diff --git a/pkg/service/test/util.go b/pkg/service/test/util.go
@@ -57,6 +57,7 @@ type TestConfig struct {
 	ApiTimeout         uint64
 	WithCoverage       bool
 	CoverageReportPath string
+	EnableTele         bool
 }
 
 type RunTestSetConfig struct {