feat: enhance init command telemetry (#5026)

kubeshop · Feb 27, 2024 · c54567b · c54567b
1 parent 668909c
commit c54567b
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 22 deletions.
diff --git a/cmd/kubectl-testkube/commands/cloud/init.go b/cmd/kubectl-testkube/commands/cloud/init.go
@@ -1,6 +1,8 @@
 package cloud
 
 import (
+	"fmt"
+
 	"github.com/spf13/cobra"
 
 	"github.com/kubeshop/testkube/cmd/kubectl-testkube/commands/common"
@@ -43,23 +45,27 @@ func NewInitCmd() *cobra.Command {
 				ui.NL()
 
 				currentContext, err := common.GetCurrentKubernetesContext()
-				sendErrTelemetry(cmd, cfg, "k8s_context")
-				ui.ExitOnError("getting current context", err)
+				if err != nil {
+					sendErrTelemetry(cmd, cfg, "k8s_context", err)
+					ui.ExitOnError("getting current context", err)
+				}
 				ui.Alert("Current kubectl context:", currentContext)
 				ui.NL()
 
 				ok := ui.Confirm("Do you want to continue?")
 				if !ok {
 					ui.Errf("Testkube installation cancelled")
-					sendErrTelemetry(cmd, cfg, "user_cancel")
+					sendErrTelemetry(cmd, cfg, "user_cancel", err)
 					return
 				}
 			}
 
 			spinner := ui.NewSpinner("Installing Testkube")
 			err = common.HelmUpgradeOrInstallTestkubeCloud(options, cfg, false)
-			sendErrTelemetry(cmd, cfg, "helm_install")
-			ui.ExitOnError("Installing Testkube", err)
+			if err != nil {
+				sendErrTelemetry(cmd, cfg, "helm_install", err)
+				ui.ExitOnError("Installing Testkube", err)
+			}
 			spinner.Success()
 
 			ui.NL()
@@ -68,11 +74,11 @@ func NewInitCmd() *cobra.Command {
 			var token, refreshToken string
 			if !common.IsUserLoggedIn(cfg, options) {
 				token, refreshToken, err = common.LoginUser(options.Master.URIs.Auth)
-				sendErrTelemetry(cmd, cfg, "login")
+				sendErrTelemetry(cmd, cfg, "login", err)
 				ui.ExitOnError("user login", err)
 			}
 			err = common.PopulateLoginDataToContext(options.Master.OrgId, options.Master.EnvId, token, refreshToken, options, cfg)
-			sendErrTelemetry(cmd, cfg, "setting_context")
+			sendErrTelemetry(cmd, cfg, "setting_context", err)
 			ui.ExitOnError("Setting cloud environment context", err)
 
 			ui.Info(" Happy Testing! 🚀")
@@ -88,10 +94,12 @@ func NewInitCmd() *cobra.Command {
 	return cmd
 }
 
-func sendErrTelemetry(cmd *cobra.Command, clientCfg config.Data, errType string) {
+func sendErrTelemetry(cmd *cobra.Command, clientCfg config.Data, errType string, errorLogs error) {
+	var errorStackTrace string
+	errorStackTrace = fmt.Sprintf("%+v", errorLogs)
 	if clientCfg.TelemetryEnabled {
 		ui.Debug("collecting anonymous telemetry data, you can disable it by calling `kubectl testkube disable telemetry`")
-		out, err := telemetry.SendCmdErrorEvent(cmd, common.Version, errType)
+		out, err := telemetry.SendCmdErrorEvent(cmd, common.Version, errType, errorStackTrace)
 		if ui.Verbose && err != nil {
 			ui.Err(err)
 		}

diff --git a/cmd/kubectl-testkube/commands/pro/init.go b/cmd/kubectl-testkube/commands/pro/init.go
@@ -1,6 +1,8 @@
 package pro
 
 import (
+	"fmt"
+
 	"github.com/spf13/cobra"
 
 	"github.com/kubeshop/testkube/cmd/kubectl-testkube/commands/common"
@@ -38,23 +40,28 @@ func NewInitCmd() *cobra.Command {
 				ui.NL()
 
 				currentContext, err := common.GetCurrentKubernetesContext()
-				sendErrTelemetry(cmd, cfg, "k8s_context")
-				ui.ExitOnError("getting current context", err)
+
+				if err != nil {
+					sendErrTelemetry(cmd, cfg, "k8s_context", err)
+					ui.ExitOnError("getting current context", err)
+				}
 				ui.Alert("Current kubectl context:", currentContext)
 				ui.NL()
 
 				ok := ui.Confirm("Do you want to continue?")
 				if !ok {
 					ui.Errf("Testkube installation cancelled")
-					sendErrTelemetry(cmd, cfg, "user_cancel")
+					sendErrTelemetry(cmd, cfg, "user_cancel", err)
 					return
 				}
 			}
 
 			spinner := ui.NewSpinner("Installing Testkube")
 			err = common.HelmUpgradeOrInstallTestkubeCloud(options, cfg, false)
-			sendErrTelemetry(cmd, cfg, "helm_install")
-			ui.ExitOnError("Installing Testkube", err)
+			if err != nil {
+				sendErrTelemetry(cmd, cfg, "helm_install", err)
+				ui.ExitOnError("Installing Testkube", err)
+			}
 			spinner.Success()
 
 			ui.NL()
@@ -63,13 +70,14 @@ func NewInitCmd() *cobra.Command {
 			var token, refreshToken string
 			if !common.IsUserLoggedIn(cfg, options) {
 				token, refreshToken, err = common.LoginUser(options.Master.URIs.Auth)
-				sendErrTelemetry(cmd, cfg, "login")
+				sendErrTelemetry(cmd, cfg, "login", err)
 				ui.ExitOnError("user login", err)
 			}
 			err = common.PopulateLoginDataToContext(options.Master.OrgId, options.Master.EnvId, token, refreshToken, options, cfg)
-			sendErrTelemetry(cmd, cfg, "setting_context")
-			ui.ExitOnError("Setting Pro environment context", err)
-
+			if err != nil {
+				sendErrTelemetry(cmd, cfg, "setting_context", err)
+				ui.ExitOnError("Setting Pro environment context", err)
+			}
 			ui.Info(" Happy Testing! 🚀")
 			ui.NL()
 		},
@@ -84,13 +92,16 @@ func NewInitCmd() *cobra.Command {
 	return cmd
 }
 
-func sendErrTelemetry(cmd *cobra.Command, clientCfg config.Data, errType string) {
+func sendErrTelemetry(cmd *cobra.Command, clientCfg config.Data, errType string, errorLogs error) {
+	var errorStackTrace string
+	errorStackTrace = fmt.Sprintf("%+v", errorLogs)
 	if clientCfg.TelemetryEnabled {
 		ui.Debug("collecting anonymous telemetry data, you can disable it by calling `kubectl testkube disable telemetry`")
-		out, err := telemetry.SendCmdErrorEvent(cmd, common.Version, errType)
+		out, err := telemetry.SendCmdErrorEvent(cmd, common.Version, errType, errorStackTrace)
 		if ui.Verbose && err != nil {
 			ui.Err(err)
 		}
+
 		ui.Debug("telemetry send event response", out)
 	}
 }

diff --git a/pkg/telemetry/payload.go b/pkg/telemetry/payload.go
@@ -31,6 +31,7 @@ type Params struct {
 	ClusterType      string     `json:"cluster_type,omitempty"`
 	Error            string     `json:"error,omitempty"`
 	ErrorType        string     `json:"error_type,omitempty"`
+	ErrorStackTrace  string     `json:"error_stacktrace,omitempty"`
 }
 
 type Event struct {

diff --git a/pkg/telemetry/sender_sio.go b/pkg/telemetry/sender_sio.go
@@ -86,7 +86,8 @@ func mapProperties(params Params) analytics.Properties {
 		Set("cloudEnvironmentId", params.Context.EnvironmentId).
 		Set("machineId", params.MachineID).
 		Set("clusterType", params.ClusterType).
-		Set("errorType", params.ErrorType)
+		Set("errorType", params.ErrorType).
+		Set("errorStackTrace", params.ErrorStackTrace)
 
 	if params.DataSource != "" {
 		properties = properties.Set("dataSource", params.DataSource)

diff --git a/pkg/telemetry/telemetry.go b/pkg/telemetry/telemetry.go
@@ -46,7 +46,7 @@ func SendCmdEvent(cmd *cobra.Command, version string) (string, error) {
 	return sendData(senders, payload)
 }
 
-func SendCmdErrorEvent(cmd *cobra.Command, version, errType string) (string, error) {
+func SendCmdErrorEvent(cmd *cobra.Command, version, errType string, errorStackTrace string) (string, error) {
 	// get all sub-commands passed to cli
 	command := strings.TrimPrefix(cmd.CommandPath(), "kubectl-testkube ")
 	if command == "" {
@@ -72,6 +72,7 @@ func SendCmdErrorEvent(cmd *cobra.Command, version, errType string) (string, err
 					Context:         getCurrentContext(),
 					ClusterType:     GetClusterType(),
 					ErrorType:       errType,
+					ErrorStackTrace: errorStackTrace,
 				},
 			}},
 	}