Changed reporting to a single table (#223)

Author: danielm-codefresh

Makefile

@@ -1,4 +1,4 @@
-VERSION=v0.0.203
+VERSION=v0.0.204
 
 OUT_DIR=dist
 YEAR?=$(shell date +"%Y")

cmd/commands/runtime.go

@@ -175,7 +175,7 @@ func NewRuntimeInstallCommand() *cobra.Command {
 				installationOpts.RuntimeName = args[0]
 			}
 
-			createAnalyticsReporter(cmd.Context())
+			createAnalyticsReporter(cmd.Context(), reporter.InstallFlow)
 
 			if err := runtimeInstallCommandPreRunHandler(cmd, &installationOpts); err != nil {
 				return fmt.Errorf("Pre installation error: %w", err)
@@ -798,7 +798,7 @@ func NewRuntimeUninstallCommand() *cobra.Command {
 			var err error
 			ctx := cmd.Context()
 
-			createAnalyticsReporter(ctx)
+			createAnalyticsReporter(ctx, reporter.UninstallFlow)
 
 			err = getKubeContextNameFromUserSelect(cmd, &kubeContextName)
 			if err != nil {
@@ -1562,15 +1562,15 @@ func postInstallationHandler(ctx context.Context, opts *RuntimeInstallOptions, e
 	printSummaryToUser()
 }
 
-func handleCliStep(event reporter.CliEventType, message string, err error) {
+func handleCliStep(step reporter.CliStep, message string, err error) {
 	r := reporter.G()
 	status := reporter.SUCCESS
 	if err != nil {
 		status = reporter.FAILURE
 	}
 
 	r.ReportStep(reporter.CliStepData{
-		Event:       event,
+		Step:        step,
 		Status:      status,
 		Description: message,
 		Err:         err,
@@ -1601,12 +1601,12 @@ func printSummaryToUser() {
 	summaryArr = []summaryLog{}
 }
 
-func createAnalyticsReporter(ctx context.Context) {
+func createAnalyticsReporter(ctx context.Context, flow reporter.FlowType) {
 	user, err := cfConfig.GetCurrentContext().GetUser(ctx)
 	// If error, it will default to noop reporter
 	if err != nil {
 		log.G().Debug("Failed to get user from context")
 		return
 	}
-	reporter.Init(user)
+	reporter.Init(user, flow)
 }

docs/releases/release_notes.md

@@ -23,7 +23,7 @@ cf version
 
 ```bash
 # download and extract the binary
-curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.203/cf-linux-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.204/cf-linux-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-linux-amd64 /usr/local/bin/cf
@@ -36,7 +36,7 @@ cf version
 
 ```bash
 # download and extract the binary
-curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.203/cf-darwin-amd64.tar.gz | tar zx
+curl -L --output - https://github.com/codefresh-io/cli-v2/releases/download/v0.0.204/cf-darwin-amd64.tar.gz | tar zx
 
 # move the binary to your $PATH
 mv ./cf-darwin-amd64 /usr/local/bin/cf

manifests/runtime.yaml

@@ -5,7 +5,7 @@ metadata:
   namespace: "{{ namespace }}"
 spec:
   defVersion: 1.0.0
-  version: 0.0.203
+  version: 0.0.204
   bootstrapSpecifier: github.com/codefresh-io/cli-v2/manifests/argo-cd
   components:
     - name: events

pkg/reporter/reporter.go

@@ -31,17 +31,19 @@ type (
 	}
 
 	CliStepData struct {
-		Event       CliEventType
+		Step        CliStep
 		Status      CliStepStatus
 		Description string
 		Err         error
 	}
 
-	CliEventType  string
+	CliStep       string
 	CliStepStatus string
+	FlowType      string
 
 	segmentAnalyticsReporter struct {
 		client      analytics.Client
+		flowType    FlowType
 		flowId      string
 		userId      string
 		userName    string
@@ -53,41 +55,46 @@ type (
 )
 
 const (
+	cliEvent string = "cli-runtime-operations"
+
 	// Install
-	InstallStepPreChecks                   CliEventType = "install.pre-installation-checks"
-	InstallStepDownloadRuntimeDefinitions  CliEventType = "install.download-runtime-definitions"
-	InstallStepGetServerAddress            CliEventType = "install.get-server-address"
-	InstallStepCreateRuntimeOnPlatform     CliEventType = "install.create-runtime-on-platform"
-	InstallStepBootstrapRepo               CliEventType = "install.bootstrap-repo"
-	InstallStepCreateProject               CliEventType = "install.create-project"
-	InstallStepCreateConfigMap             CliEventType = "install.create-codefresh-cm"
-	InstallStepCreateComponent             CliEventType = "install.create-component"
-	InstallStepInstallComponenets          CliEventType = "install.install-components"
-	InstallStepCreateGitsource             CliEventType = "install.create-gitsource"
-	InstallStepCreateMarketplaceGitsource  CliEventType = "install.create-marketplace-gitsource"
-	InstallStepCompleteRuntimeInstallation CliEventType = "install.complete-runtime-installation"
-	InstallStepCreateDefaultGitIntegration CliEventType = "install.create-default-git-integration"
+	InstallStepPreChecks                   CliStep = "install.pre-installation-checks"
+	InstallStepDownloadRuntimeDefinitions  CliStep = "install.download-runtime-definitions"
+	InstallStepGetServerAddress            CliStep = "install.get-server-address"
+	InstallStepCreateRuntimeOnPlatform     CliStep = "install.create-runtime-on-platform"
+	InstallStepBootstrapRepo               CliStep = "install.bootstrap-repo"
+	InstallStepCreateProject               CliStep = "install.create-project"
+	InstallStepCreateConfigMap             CliStep = "install.create-codefresh-cm"
+	InstallStepCreateComponent             CliStep = "install.create-component"
+	InstallStepInstallComponenets          CliStep = "install.install-components"
+	InstallStepCreateGitsource             CliStep = "install.create-gitsource"
+	InstallStepCreateMarketplaceGitsource  CliStep = "install.create-marketplace-gitsource"
+	InstallStepCompleteRuntimeInstallation CliStep = "install.complete-runtime-installation"
+	InstallStepCreateDefaultGitIntegration CliStep = "install.create-default-git-integration"
 
 	// Uninstall
-	UninstallStepCheckRuntimeExists            CliEventType = "uninstall.check-runtime-exists"
-	UninstallStepUninstallRepo                 CliEventType = "uninstall.uninstall-repo"
-	UninstallStepDeleteRuntimeFromPlatform     CliEventType = "uninstall.delete-runtime-from-platform"
-	UninstallStepCompleteRuntimeUninstallation CliEventType = "uninstall.complete-runtime-uninstall"
+	UninstallStepCheckRuntimeExists            CliStep = "uninstall.check-runtime-exists"
+	UninstallStepUninstallRepo                 CliStep = "uninstall.uninstall-repo"
+	UninstallStepDeleteRuntimeFromPlatform     CliStep = "uninstall.delete-runtime-from-platform"
+	UninstallStepCompleteRuntimeUninstallation CliStep = "uninstall.complete-runtime-uninstall"
 
 	// General
-	SIGNAL_TERMINATION CliEventType = "signal-termination"
+	SIGNAL_TERMINATION CliStep = "signal-termination"
 
 	SUCCESS  CliStepStatus = "SUCCESS"
 	FAILURE  CliStepStatus = "FAILURE"
 	CANCELED CliStepStatus = "CANCELED"
+
+	InstallFlow   FlowType = "installation"
+	UninstallFlow FlowType = "uninstallation"
 )
 
 // G returns the global reporter
 func G() AnalyticsReporter {
 	return ar
 }
 
-func Init(user *codefresh.User) {
+func Init(user *codefresh.User, flow FlowType) {
 	writeKey := store.Get().SegmentWriteKey
 	if writeKey == "" {
 		log.G().Debug("No segment write key was provided. Using the noop reporter.")
@@ -99,29 +106,32 @@ func Init(user *codefresh.User) {
 	ar = &segmentAnalyticsReporter{
 		client:      analytics.New(writeKey),
 		flowId:      uuid.New().String(),
+		flowType:    flow,
 		userId:      user.ID,
 		userName:    user.Name,
 		accountId:   account.ID,
 		accountName: account.Name,
 	}
 }
 
-func (r *segmentAnalyticsReporter) ReportStep(step CliStepData) {
+func (r *segmentAnalyticsReporter) ReportStep(data CliStepData) {
 	properties := analytics.NewProperties().
 		Set("accountId", r.accountId).
 		Set("accountName", r.accountName).
 		Set("userName", r.userName).
 		Set("flowId", r.flowId).
-		Set("description", step.Description).
-		Set("status", step.Status)
+		Set("flowType", r.flowType).
+		Set("description", data.Description).
+		Set("step", data.Step).
+		Set("status", data.Status)
 
-	if step.Err != nil {
-		properties = properties.Set("error", step.Err.Error())
+	if data.Err != nil {
+		properties = properties.Set("error", data.Err.Error())
 	}
 
 	err := r.client.Enqueue(analytics.Track{
 		UserId:     r.userId,
-		Event:      string(step.Event),
+		Event:      cliEvent,
 		Properties: properties,
 	})
 

pkg/util/util.go

@@ -55,7 +55,7 @@ func ContextWithCancelOnSignals(ctx context.Context, sigs ...os.Signal) context.
 			s := <-sig
 			cancels++
 			reporter.G().ReportStep(reporter.CliStepData{
-				Event:       reporter.SIGNAL_TERMINATION,
+				Step:        reporter.SIGNAL_TERMINATION,
 				Status:      reporter.CANCELED,
 				Description: "Cancelled by an external signal",
 				Err:         nil,