chore: Improve telemetry handling for config commands

CircleCI-Public · Aug 1, 2023 · 7f0184b · 7f0184b
1 parent 4837c99
commit 7f0184b
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/cmd/config.go b/cmd/config.go
@@ -56,7 +56,7 @@ func newConfigCommand(globalConfig *settings.Config) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			defer closeTelemetryClient()
 			err := packConfig(args)
-			telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true)))
+			_ = telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true), err))
 			return err
 		},
 		Args:        cobra.ExactArgs(1),
@@ -89,7 +89,7 @@ func newConfigCommand(globalConfig *settings.Config) *cobra.Command {
 				IgnoreDeprecatedImages: ignoreDeprecatedImages,
 				VerboseOutput:          verboseOutput,
 			})
-			telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true)))
+			telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true), err))
 
 			return err
 		},
@@ -124,15 +124,14 @@ func newConfigCommand(globalConfig *settings.Config) *cobra.Command {
 			if len(args) == 1 {
 				path = args[0]
 			}
-			telemetryClient.Track(telemetry.CreateConfigEvent(getCommandInformation(cmd, true)))
 			response, err := compiler.ProcessConfig(config.ProcessConfigOpts{
 				ConfigPath:             path,
 				OrgID:                  orgID,
 				OrgSlug:                orgSlug,
 				PipelineParamsFilePath: pipelineParamsFilePath,
 				VerboseOutput:          verboseOutput,
 			})
-			telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true)))
+			telemetryClient.Track(telemetry.CreateConfigEvent(create_telemetry.GetCommandInformation(cmd, true), err))
 			if err != nil {
 				return err
 			}

diff --git a/cmd/config_test.go b/cmd/config_test.go
@@ -61,7 +61,7 @@ var _ = Describe("Config", func() {
 					telemetry.CreateConfigEvent(telemetry.CommandInfo{
 						Name:      "pack",
 						LocalArgs: map[string]string{"help": "false"},
-					}),
+					}, nil),
 				})
 			})
 		})

diff --git a/telemetry/events.go b/telemetry/events.go
@@ -76,8 +76,12 @@ func CreateCompletionCommand(cmdInfo CommandInfo) Event {
 	return createEventFromCommandInfo("completion", cmdInfo)
 }
 
-func CreateConfigEvent(cmdInfo CommandInfo) Event {
-	return createEventFromCommandInfo("config", cmdInfo)
+func CreateConfigEvent(cmdInfo CommandInfo, err error) Event {
+	event := createEventFromCommandInfo("config", cmdInfo)
+	if err != nil {
+		event.Properties["error"] = err.Error()
+	}
+	return event
 }
 
 func CreateLocalExecuteEvent(cmdInfo CommandInfo) Event {