[installation-telemetry] Expose user control over sending customer ID

Author: adrienthebo

components/dashboard/src/admin/Settings.tsx

@@ -59,8 +59,27 @@ export default function Settings() {
                     checked={adminSettings?.sendTelemetry ?? false}
                     onChange={(evt) =>
                         actuallySetTelemetryPrefs({
+                            ...adminSettings,
                             sendTelemetry: evt.target.checked,
-                        })
+                        } as InstallationAdminSettings)
+                    }
+                />
+                <CheckBox
+                    title="Include customer ID in telemetry"
+                    desc={
+                        <span>
+                            An optional customer ID can be included with telemetry to provide better customer support.{" "}
+                            <a className="gp-link" href="https://www.gitpod.io/privacy">
+                                Read our Privacy Policy
+                            </a>
+                        </span>
+                    }
+                    checked={adminSettings?.sendCustomerID ?? false}
+                    onChange={(evt) =>
+                        actuallySetTelemetryPrefs({
+                            ...adminSettings,
+                            sendCustomerID: evt.target.checked,
+                        } as InstallationAdminSettings)
                     }
                 />
                 <InfoBox>

components/gitpod-protocol/src/installation-admin-protocol.ts

@@ -8,6 +8,7 @@ import { v4 as uuidv4 } from "uuid";
 
 const InstallationAdminSettingsPrototype = {
     sendTelemetry: true,
+    sendCustomerID: true,
 };
 
 export type InstallationAdminSettings = typeof InstallationAdminSettingsPrototype;

components/installation-telemetry/cmd/send.go

@@ -50,15 +50,20 @@ var sendCmd = &cobra.Command{
 			err = client.Close()
 		}()
 
+		properties := analytics.NewProperties().
+			Set("version", versionId).
+			Set("totalUsers", data.TotalUsers).
+			Set("totalWorkspaces", data.TotalWorkspaces).
+			Set("totalInstances", data.TotalInstances)
+
+		if data.InstallationAdmin.Settings.SendCustomerID {
+			properties.Set("customerID", data.CustomerID)
+		}
+
 		telemetry := analytics.Track{
-			UserId: data.InstallationAdmin.ID,
-			Event:  "Installation telemetry",
-			Properties: analytics.NewProperties().
-				Set("version", versionId).
-				Set("totalUsers", data.TotalUsers).
-				Set("totalWorkspaces", data.TotalWorkspaces).
-				Set("totalInstances", data.TotalInstances).
-				Set("licenseType", data.LicenseType),
+			UserId:     data.InstallationAdmin.ID,
+			Event:      "Installation telemetry",
+			Properties: properties,
 		}
 
 		client.Enqueue(telemetry)

components/installation-telemetry/pkg/server/installationAdmin.go

@@ -14,7 +14,8 @@ import (
 )
 
 type InstallationAdminSettings struct {
-	SendTelemetry bool `json:"sendTelemetry"`
+	SendTelemetry  bool `json:"sendTelemetry"`
+	SendCustomerID bool `json:"sendCustomerID"`
 }
 
 type Data struct {

components/server/src/installation-admin/telemetry-data-provider.ts

@@ -29,6 +29,11 @@ export class InstallationAdminTelemetryDataProvider {
                 licenseType: this.licenseEvaluator.getLicenseData().type,
                 customerID: this.licenseEvaluator.getLicenseData().payload.customerID,
             } as TelemetryData;
+
+            if (data.installationAdmin.settings.sendCustomerID) {
+                data.customerID = this.licenseEvaluator.getLicenseData().payload.customerID;
+            }
+
             return data;
         } finally {
             span.finish();