use unified analytics endpoint

Author: akosyakov

.github/workflows/gitpod-web-docker.yml

@@ -32,7 +32,7 @@ jobs:
         working-directory: ./gitpod-web
         run: |
           set -e
-          setSegmentKey="setpath([\"segmentKey\"]; \"${{ secrets.ANALITYCS_KEY }}\")"
+          setSegmentKey="setpath([\"segmentKey\"]; \"untrusted-dummy-key\")"
           jqCommands="${setSegmentKey}"
           cat package.json | jq "${jqCommands}" > package.json.tmp
           mv package.json.tmp package.json

.github/workflows/release-gitpod-remote.yml

@@ -21,7 +21,7 @@ jobs:
         working-directory: ./gitpod-remote
         run: |
           set -e
-          setSegmentKey="setpath([\"segmentKey\"]; \"${{ secrets.ANALITYCS_KEY }}\")"
+          setSegmentKey="setpath([\"segmentKey\"]; \"untrusted-dummy-key\")"
           jqCommands="${setSegmentKey}"
           cat package.json | jq "${jqCommands}" > package.json.tmp
           mv package.json.tmp package.json

gitpod-shared/src/common/telemetry.ts

@@ -15,6 +15,10 @@ const enum TelemetryLevel {
 }
 
 function getTelemetryLevel(): TelemetryLevel {
+	if (vscode.env.appName === 'Gitpod Code') {
+		return TelemetryLevel.ON;
+	}
+	
 	const TELEMETRY_CONFIG_ID = 'telemetry';
 	const TELEMETRY_CONFIG_ENABLED_ID = 'enableTelemetry';
 
@@ -63,15 +67,10 @@ export class BaseTelemetryAppender implements ITelemetryAppender {
 	private _exceptionQueue: Array<{ exception: Error; data: AppenderData | undefined }> = [];
 
 	// Necessary information to create a telemetry client
-	private _clientFactory: (key: string) => Promise<BaseTelemetryClient>;
-	private _key: string;
+	private _clientFactory: () => Promise<BaseTelemetryClient>;
 
-	constructor(key: string, clientFactory: (key: string) => Promise<BaseTelemetryClient>) {
+	constructor(clientFactory: () => Promise<BaseTelemetryClient>) {
 		this._clientFactory = clientFactory;
-		this._key = key;
-		if (getTelemetryLevel() !== TelemetryLevel.OFF) {
-			this.instantiateAppender();
-		}
 	}
 
 	/**
@@ -131,10 +130,11 @@ export class BaseTelemetryAppender implements ITelemetryAppender {
 		if (this._isInstantiated) {
 			return;
 		}
+		this._isInstantiated = true;
+
 		// Call the client factory to get the client and then let it know it's instatntiated
-		this._clientFactory(this._key).then(client => {
+		this._clientFactory().then(client => {
 			this._telemetryClient = client;
-			this._isInstantiated = true;
 			this._flushQueues();
 		}).catch(err => {
 			console.error(err);

gitpod-shared/src/features.ts

@@ -123,6 +123,7 @@ export async function createGitpodExtensionContext(context: vscode.ExtensionCont
 		pendingWillCloseSocket,
 		workspaceInfo,
 		pendingGetOwner,
+		pendingGetUserId,
 		pendingGetUserTeams,
 		pendingInstanceListener,
 		pendingWorkspaceOwned,

gitpod-shared/src/gitpodContext.ts

@@ -2,33 +2,33 @@
  *  Copyright (c) Gitpod. All rights reserved.
  *--------------------------------------------------------------------------------------------*/
 
-import * as vscode from 'vscode';
-import * as util from 'util';
-import * as grpc from '@grpc/grpc-js';
 import { GitpodClient, GitpodServer, GitpodServiceImpl, WorkspaceInstanceUpdateListener } from '@gitpod/gitpod-protocol/lib/gitpod-service';
-import { PortServiceClient } from '@gitpod/supervisor-api-grpc/lib/port_grpc_pb';
-import { StatusServiceClient } from '@gitpod/supervisor-api-grpc/lib/status_grpc_pb';
+import { User } from '@gitpod/gitpod-protocol/lib/protocol';
 import { Team } from '@gitpod/gitpod-protocol/lib/teams-projects-protocol';
-import { NotificationServiceClient } from '@gitpod/supervisor-api-grpc/lib/notification_grpc_pb';
-import { TerminalServiceClient } from '@gitpod/supervisor-api-grpc/lib/terminal_grpc_pb';
-import { TokenServiceClient } from '@gitpod/supervisor-api-grpc/lib/token_grpc_pb';
 import { PortVisibility } from '@gitpod/gitpod-protocol/lib/workspace-instance';
 import { ControlServiceClient } from '@gitpod/supervisor-api-grpc/lib/control_grpc_pb';
+import { ExposePortRequest } from '@gitpod/supervisor-api-grpc/lib/control_pb';
 import { InfoServiceClient } from '@gitpod/supervisor-api-grpc/lib/info_grpc_pb';
-import * as uuid from 'uuid';
-import { CloseTunnelRequest, RetryAutoExposeRequest, TunnelPortRequest, TunnelVisiblity } from '@gitpod/supervisor-api-grpc/lib/port_pb';
 import { DebugWorkspaceType, WorkspaceInfoRequest, WorkspaceInfoResponse } from '@gitpod/supervisor-api-grpc/lib/info_pb';
-import { User } from '@gitpod/gitpod-protocol/lib/protocol';
-import ReconnectingWebSocket from 'reconnecting-websocket';
-import { ILogService } from './logService';
-import { GitpodYml } from './gitpodYaml';
-import * as path from 'path';
+import { NotificationServiceClient } from '@gitpod/supervisor-api-grpc/lib/notification_grpc_pb';
+import { PortServiceClient } from '@gitpod/supervisor-api-grpc/lib/port_grpc_pb';
+import { CloseTunnelRequest, RetryAutoExposeRequest, TunnelPortRequest, TunnelVisiblity } from '@gitpod/supervisor-api-grpc/lib/port_pb';
+import { StatusServiceClient } from '@gitpod/supervisor-api-grpc/lib/status_grpc_pb';
+import { PortsStatus, PortsStatusRequest, PortsStatusResponse } from '@gitpod/supervisor-api-grpc/lib/status_pb';
+import { TerminalServiceClient } from '@gitpod/supervisor-api-grpc/lib/terminal_grpc_pb';
+import { TokenServiceClient } from '@gitpod/supervisor-api-grpc/lib/token_grpc_pb';
 import { GetTokenRequest } from '@gitpod/supervisor-api-grpc/lib/token_pb';
-import { PortsStatusRequest, PortsStatusResponse, PortsStatus } from '@gitpod/supervisor-api-grpc/lib/status_pb';
+import * as grpc from '@grpc/grpc-js';
+import * as path from 'path';
+import ReconnectingWebSocket from 'reconnecting-websocket';
+import * as util from 'util';
+import * as uuid from 'uuid';
+import * as vscode from 'vscode';
 import { isGRPCErrorStatus } from './common/utils';
-import { ExposePortRequest } from '@gitpod/supervisor-api-grpc/lib/control_pb';
 import { ExperimentalSettings } from './experiments';
-import { TelemetryService } from './telemetryService';
+import { GitpodYml } from './gitpodYaml';
+import { ILogService } from './logService';
+import { TelemetryService, TelemetrySettings } from './telemetryService';
 
 // Important:
 // This class should performs all supervisor API calls used outside this module.
@@ -209,6 +209,7 @@ export class GitpodExtensionContext implements vscode.ExtensionContext {
 		readonly pendingWillCloseSocket: (() => Promise<void>)[],
 		readonly info: WorkspaceInfoResponse.AsObject,
 		readonly owner: Promise<User>,
+		readonly userId: Promise<string>,
 		readonly userTeams: Promise<Team[]>,
 		readonly instanceListener: Promise<WorkspaceInstanceUpdateListener>,
 		readonly workspaceOwned: Promise<boolean>,
@@ -224,7 +225,17 @@ export class GitpodExtensionContext implements vscode.ExtensionContext {
 
 		const extensionId = context.extension.id;
 		const packageJSON = context.extension.packageJSON;
-		this.telemetryService = new TelemetryService(extensionId, packageJSON.version, packageJSON.segmentKey);
+		const telemetrySettigns: TelemetrySettings = {
+			writeKey: packageJSON.segmentKey,
+			// in dev mode we report to IDE lab source directly
+			host: 'https://api.segment.io',
+			path: '/v1/batch',
+		}
+		if (telemetrySettigns.writeKey === "untrusted-dummy-key") {
+			telemetrySettigns.host = info.gitpodHost;
+			telemetrySettigns.path = '/analytics' + telemetrySettigns.path;
+		}
+		this.telemetryService = new TelemetryService(extensionId, packageJSON.version, userId, telemetrySettigns, logger);
 	}
 
 	get active() {

gitpod-shared/src/telemetryService.ts

@@ -4,43 +4,54 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { AppenderData, BaseTelemetryAppender, BaseTelemetryClient, BaseTelemetryReporter } from './common/telemetry';
-import { Analytics } from '@segment/analytics-node';
+import { Analytics, AnalyticsSettings } from '@segment/analytics-node';
 import * as os from 'os';
-import * as vscode from 'vscode';
+import { ILogService } from './logService';
 
-const analyticsClientFactory = async (key: string): Promise<BaseTelemetryClient> => {
-	let segmentAnalyticsClient = new Analytics({ writeKey: key });
+type RequireKeys<T extends object, K extends keyof T> =
+	Required<Pick<T, K>> & Omit<T, K>;
+
+export type TelemetrySettings = RequireKeys<AnalyticsSettings, 'writeKey' | 'host' | 'path'>
+
+const analyticsClientFactory = async (pendingUserId: Promise<string>, settings: TelemetrySettings, logger: ILogService): Promise<BaseTelemetryClient> => {
+	const userId = await pendingUserId;
+	let segmentAnalyticsClient = new Analytics(settings);
+	logger.debug("analytics: " + new URL(settings.path, settings.host).href.replace(/\/$/, '')); // aligned with how segment does it internally
 
 	// Sets the analytics client into a standardized form
 	const telemetryClient: BaseTelemetryClient = {
 		logEvent: (eventName: string, data?: AppenderData) => {
 			try {
 				segmentAnalyticsClient.track({
-					anonymousId: vscode.env.machineId,
+					userId,
 					event: eventName,
 					properties: data?.properties
+				}, (e) => {
+					if (e) {
+						logger.error('Failed to log event to app analytics:', e);
+					}
 				});
 			} catch (e: any) {
-				console.error('Failed to log event to app analytics!', e);
+				logger.error('Failed to log event to app analytics:', e);
 			}
 		},
 		logException: (_exception: Error, _data?: AppenderData) => {
-            throw new Error('Failed to log exception to app analytics!\n');
+			throw new Error('Failed to log exception to app analytics!\n');
 		},
 		flush: async () => {
 			try {
 				await segmentAnalyticsClient.closeAndFlush({ timeout: 3000 });
 			} catch (e: any) {
-				console.error('Failed to flush app analytics!', e);
+				logger.error('Failed to flush app analytics!', e);
 			}
 		}
 	};
 	return telemetryClient;
 };
 
 export class TelemetryService extends BaseTelemetryReporter {
-	constructor(extensionId: string, extensionVersion: string, key: string) {
-		const appender = new BaseTelemetryAppender(key, (key) => analyticsClientFactory(key));
+	constructor(extensionId: string, extensionVersion: string, userId: Promise<string>, settings: TelemetrySettings, logger: ILogService) {
+		const appender = new BaseTelemetryAppender(() => analyticsClientFactory(userId, settings, logger));
 		super(extensionId, extensionVersion, appender, {
 			release: os.release(),
 			platform: os.platform(),