[Telemetry] Add support to collect Toolkit installation mode (#5598)

Author: kadupoornima

Makefile

@@ -16,6 +16,7 @@ TERRAFORM_FOLDERS=$(shell find ./modules ./community/modules ./tools -type f -na
 PACKER_FOLDERS=$(shell find ./modules ./community/modules ./tools -type f -name "*.pkr.hcl" -not -path '*/\.*' -exec dirname "{}" \; | sort -u)
 BINARY_TARGETS := ghpc gcluster
 INSTALL_DIRS := . ~/bin /usr/local/bin
+INSTALLATION_MODE = SOURCE
 
 ifneq (, $(shell which git))
 ## GIT IS PRESENT
@@ -33,7 +34,7 @@ endif
 
 gcluster: warn-go-version warn-terraform-version warn-packer-version $(shell find ./cmd ./pkg gcluster.go -type f)
 	$(info **************** building gcluster ************************)
-	@go build -ldflags="-X 'main.gitTagVersion=$(GIT_TAG_VERSION)' -X 'main.gitBranch=$(GIT_BRANCH)' -X 'main.gitCommitInfo=$(GIT_COMMIT_INFO)' -X 'main.gitCommitHash=$(GIT_COMMIT_HASH)' -X 'main.gitInitialHash=$(GIT_INITIAL_HASH)' -X 'main.gitIsOfficial=$(GIT_IS_OFFICIAL)'" gcluster.go
+	@go build -ldflags="-X 'main.gitTagVersion=$(GIT_TAG_VERSION)' -X 'main.gitBranch=$(GIT_BRANCH)' -X 'main.gitCommitInfo=$(GIT_COMMIT_INFO)' -X 'main.gitCommitHash=$(GIT_COMMIT_HASH)' -X 'main.gitInitialHash=$(GIT_INITIAL_HASH)' -X 'main.gitIsOfficial=$(GIT_IS_OFFICIAL)' -X 'main.installationMode=$(INSTALLATION_MODE)'" gcluster.go
 	@ln -sf gcluster ghpc
 
 ghpc: gcluster

cmd/root.go

@@ -45,6 +45,10 @@ var (
 	GitIsOfficial  string
 )
 
+var (
+	InstallationMode string // Toolkit installation mode like "SOURCE", "BINARY", etc.
+)
+
 var (
 	annotation = make(map[string]string)
 	rootCmd    = &cobra.Command{

gcluster.go

@@ -35,6 +35,9 @@ var gitCommitHash string
 var gitInitialHash string
 var gitIsOfficial string
 
+// Whether the Toolkit is installed from source, binary, etc.
+var installationMode string
+
 func main() {
 	if err := dependencies.PatchPath(); err != nil {
 		logging.Fatal("Failed to patch PATH with custom binaries directories: %v", err)
@@ -47,6 +50,7 @@ func main() {
 	cmd.GitCommitHash = gitCommitHash
 	cmd.GitInitialHash = gitInitialHash
 	cmd.GitIsOfficial = gitIsOfficial
+	cmd.InstallationMode = installationMode
 	if err := cmd.Execute(); err != nil {
 		os.Exit(1)
 	}

pkg/telemetry/collector.go

@@ -41,13 +41,14 @@ var (
 )
 
 // NewCollector creates and initializes a new Telemetry Collector.
-func NewCollector(cmd *cobra.Command, args []string) *Collector {
+func NewCollector(cmd *cobra.Command, args []string, installationMode string) *Collector {
 	return &Collector{
-		eventCmd:       cmd,
-		eventArgs:      args,
-		eventStartTime: time.Now(),
-		blueprint:      getBlueprint(args),
-		metadata:       make(map[string]string),
+		eventCmd:         cmd,
+		eventArgs:        args,
+		eventStartTime:   time.Now(),
+		blueprint:        getBlueprint(args),
+		installationMode: installationMode,
+		metadata:         make(map[string]string),
 	}
 }
 
@@ -70,6 +71,7 @@ func (c *Collector) CollectMetrics(errorCode int) {
 	c.metadata[OS_VERSION] = getOSVersion()
 	c.metadata[TERRAFORM_VERSION] = getTerraformVersion()
 	c.metadata[BILLING_ACCOUNT_ID] = getBillingAccountId(c.blueprint)
+	c.metadata[INSTALLATION_MODE] = c.installationMode
 	c.metadata[IS_TEST_DATA] = getIsTestData()
 	c.metadata[EXIT_CODE] = strconv.Itoa(errorCode)
 }

pkg/telemetry/collector_test.go

@@ -34,7 +34,7 @@ import (
 func TestNewCollector(t *testing.T) {
 	cmd := &cobra.Command{Use: "test"}
 	// Passing nil for args prevents getBlueprint from attempting to read a file
-	c := NewCollector(cmd, nil)
+	c := NewCollector(cmd, nil, SOURCE)
 
 	if c == nil {
 		t.Fatal("Expected NewCollector to return a valid Collector, got nil")
@@ -61,20 +61,23 @@ func TestCollectMetrics_Extensible(t *testing.T) {
 		OS_VERSION,
 		TERRAFORM_VERSION,
 		BILLING_ACCOUNT_ID,
+		INSTALLATION_MODE,
 		IS_TEST_DATA,
 		EXIT_CODE,
 	}
 
 	tests := []struct {
-		name           string
-		errorCode      int
-		setupCmd       func(cmd *cobra.Command) // Hook to configure the command
-		setupCollector func(c *Collector)       // Hook to mock internal collector state
-		expectedValues map[string]string
+		name             string
+		errorCode        int
+		installationMode string
+		setupCmd         func(cmd *cobra.Command) // Hook to configure the command
+		setupCollector   func(c *Collector)       // Hook to mock internal collector state
+		expectedValues   map[string]string
 	}{
 		{
-			name:      "Success exit code",
-			errorCode: 0,
+			name:             "Success exit code",
+			errorCode:        0,
+			installationMode: SOURCE,
 			setupCmd: func(cmd *cobra.Command) {
 				// Define dummy flags for the mock command
 				cmd.Flags().Bool("force", false, "Force execution")
@@ -119,11 +122,13 @@ func TestCollectMetrics_Extensible(t *testing.T) {
 				OS_VERSION:         getOSVersion(),        // Dynamically expect the current OS version
 				TERRAFORM_VERSION:  getTerraformVersion(), // Dynamically expect the current Terraform version
 				BILLING_ACCOUNT_ID: "",
+				INSTALLATION_MODE:  SOURCE,
 			},
 		},
 		{
-			name:      "Failure exit code with missing region, zone, and machine type",
-			errorCode: 1,
+			name:             "Failure exit code with missing region, zone, and machine type",
+			errorCode:        1,
+			installationMode: BINARY,
 			setupCmd: func(cmd *cobra.Command) {
 				// No flags set
 			},
@@ -145,6 +150,7 @@ func TestCollectMetrics_Extensible(t *testing.T) {
 				TERRAFORM_VERSION:  getTerraformVersion(), // Verify Terraform version is still collected on failure
 				MACHINE_TYPE:       "",                    // Verify empty machine type when no matching modules exist
 				BILLING_ACCOUNT_ID: "",
+				INSTALLATION_MODE:  BINARY,
 			},
 		},
 	}
@@ -159,7 +165,7 @@ func TestCollectMetrics_Extensible(t *testing.T) {
 			}
 
 			// Initialize the collector
-			c := NewCollector(cmd, []string{})
+			c := NewCollector(cmd, []string{}, tt.installationMode)
 
 			// Execute the setup function to apply the blueprint state to the collector
 			if tt.setupCollector != nil {
@@ -191,7 +197,7 @@ func TestBuildConcordEvent(t *testing.T) {
 	childCmd := &cobra.Command{Use: "deploy"}
 	rootCmd.AddCommand(childCmd)
 
-	c := NewCollector(childCmd, nil)
+	c := NewCollector(childCmd, nil, SOURCE)
 	c.CollectMetrics(0)
 
 	event := c.BuildConcordEvent()

pkg/telemetry/telemetry_test.go

@@ -102,7 +102,7 @@ func TestExecute(t *testing.T) {
 
 	// Setup dummy cobra command and collector
 	cmd := &cobra.Command{Use: "test-execute"}
-	c := NewCollector(cmd, nil)
+	c := NewCollector(cmd, nil, SOURCE)
 
 	// Trigger Execute. Since Execute doesn't return anything, we verify
 	// it functions without panicking or failing.

pkg/telemetry/types.go

@@ -30,15 +30,18 @@ const (
 	timeout2Sec     = 2 * time.Second
 	CLUSTER_TOOLKIT = "CLUSTER_TOOLKIT"
 	CONCORD         = "CONCORD"
+	SOURCE          = "SOURCE"
+	BINARY          = "BINARY"
 )
 
 // Collector encapsulates the telemetry state (avoids global variables).
 type Collector struct {
-	eventCmd       *cobra.Command
-	eventArgs      []string
-	eventStartTime time.Time
-	blueprint      config.Blueprint
-	metadata       map[string]string
+	eventCmd         *cobra.Command
+	eventArgs        []string
+	eventStartTime   time.Time
+	blueprint        config.Blueprint
+	installationMode string
+	metadata         map[string]string
 
 	mu sync.Mutex // Protects state against concurrent access
 }
@@ -90,6 +93,7 @@ const (
 	OS_VERSION         = "CLUSTER_TOOLKIT_OS_VERSION"
 	TERRAFORM_VERSION  = "CLUSTER_TOOLKIT_TERRAFORM_VERSION"
 	BILLING_ACCOUNT_ID = "CLUSTER_TOOLKIT_BILLING_ACCOUNT_ID"
+	INSTALLATION_MODE  = "CLUSTER_TOOLKIT_INSTALLATION_MODE"
 	IS_TEST_DATA       = "CLUSTER_TOOLKIT_IS_TEST_DATA"
 	EXIT_CODE          = "CLUSTER_TOOLKIT_EXIT_CODE"
 )