Update telemetry enablement (#104)

* Update telemetry enablement

Signed-off-by: Kim Tsao <[email protected]>

* Address review comments

Signed-off-by: Kim Tsao <[email protected]>

Author: kim-tsao

deploy/chart/devfile-registry/README.md

@@ -76,4 +76,5 @@ The following fields can be configured in the Helm chart, either via the `values
 | `ociRegistry.imagePullpolicy`          | Image pull policy for oci registry image        | `Always` |
 | `ociRegistry.memoryLimit`              | Memory for oci registry container               | `256Mi` |
 | `persistence.enabled`                  | Enable persistent storage for the registry      | `true` |
-| `persistence.size`                     | The size of the persistent volume (if-enabled)  | `1Gi` |
+| `persistence.size`                     | The size of the persistent volume (if-enabled)  | `1Gi` |
+| `telemetry.key`                        | The write key for the Segment instance          | **MUST BE SET BY USER**  |

deploy/chart/devfile-registry/templates/deployment.yaml

@@ -91,10 +91,10 @@ spec:
         env:
           - name: DEVFILE_VIEWER_ROOT
             value: "/viewer"
-          - name: ENABLE_TELEMETRY
-            value: {{ .Values.telemetry.enabled | quote }}
           - name: REGISTRY_NAME
             value: {{ .Values.telemetry.registryName }}
+          - name: TELEMETRY_KEY
+            value: {{ .Values.telemetry.key }}
         volumeMounts:
         - name: viewer-config
           mountPath: "/app/config"

deploy/chart/devfile-registry/values.yaml

@@ -32,5 +32,4 @@ persistence:
   size: 1Gi
 
 telemetry:
-  enabled: "false"
   registryName: "devfile-registry"

index/server/pkg/server/constants.go

@@ -36,6 +36,6 @@ var (
 	sampleBase64IndexPath = os.Getenv("DEVFILE_SAMPLE_BASE64_INDEX")
 	stackIndexPath        = os.Getenv("DEVFILE_STACK_INDEX")
 	stackBase64IndexPath  = os.Getenv("DEVFILE_STACK_BASE64_INDEX")
-	enableTelemetry       = util.GetOptionalEnv("ENABLE_TELEMETRY", false).(bool)
+	enableTelemetry       = util.IsTelemetryEnabled()
 	registry              = util.GetOptionalEnv("REGISTRY_NAME", "devfile-registry")
 )

index/server/pkg/util/telemetry.go

@@ -9,12 +9,13 @@ import (
 )
 
 const (
-	telemetryKey = "6HBMiy5UxBtsbxXx7O4n0t0u4dt8IAR3"
-	defaultUser  = "devfile-registry"
-	viewerId     = "registry-viewer"
-	consoleId    = "openshift-console"
+	defaultUser = "devfile-registry"
+	viewerId    = "registry-viewer"
+	consoleId   = "openshift-console"
 )
 
+var telemetryKey = GetOptionalEnv("TELEMETRY_KEY", "").(string)
+
 //TrackEvent tracks event for telemetry
 func TrackEvent(event analytics.Message) error {
 	// Initialize client for telemetry

index/server/pkg/util/util.go

@@ -175,3 +175,10 @@ func ConvertToOldIndexFormat(schemaList []indexSchema.Schema) []indexSchema.Sche
 	}
 	return oldSchemaList
 }
+
+func IsTelemetryEnabled() bool {
+	if len(telemetryKey) > 0 {
+		return true
+	}
+	return false
+}