log activation and failed analytics

Author: akosyakov

src/extension.ts

@@ -34,8 +34,9 @@ if (!global.fetch) {
 
 const FIRST_INSTALL_KEY = 'gitpod-desktop.firstInstall';
 
-let telemetryService: TelemetryService;
+let telemetryService: TelemetryService | undefined;
 let remoteSession: RemoteSession | undefined;
+let logger: vscode.LogOutputChannel | undefined;
 
 export async function activate(context: vscode.ExtensionContext) {
 	const extensionId = context.extension.id;
@@ -47,18 +48,18 @@ export async function activate(context: vscode.ExtensionContext) {
 		// sync between machines
 		context.globalState.setKeysForSync([ReleaseNotes.RELEASE_NOTES_LAST_READ_KEY]);
 
-		const logger = vscode.window.createOutputChannel('Gitpod', { log: true });
+		logger = vscode.window.createOutputChannel('Gitpod', { log: true });
 		context.subscriptions.push(logger);
 
 		const onDidChangeLogLevel = (logLevel: vscode.LogLevel) => {
-			logger.info(`Log level: ${vscode.LogLevel[logLevel]}`);
+			logger!.info(`Log level: ${vscode.LogLevel[logLevel]}`);
 		};
-		context.subscriptions.push(logger.onDidChangeLogLevel(onDidChangeLogLevel));
-		onDidChangeLogLevel(logger.logLevel);
+		context.subscriptions.push(logger!.onDidChangeLogLevel(onDidChangeLogLevel));
+		onDidChangeLogLevel(logger!.logLevel);
 
 		logger.info(`${extensionId}/${packageJSON.version} (${os.release()} ${os.platform()} ${os.arch()}) vscode/${vscode.version} (${vscode.env.appName})`);
 
-		telemetryService = new TelemetryService(extensionId, packageJSON.version, packageJSON.segmentKey);
+		telemetryService = new TelemetryService(extensionId, packageJSON.version, packageJSON.segmentKey, logger!);
 
 		const notificationService = new NotificationService(telemetryService);
 
@@ -112,11 +113,11 @@ export async function activate(context: vscode.ExtensionContext) {
 			if (remoteConnectionInfo) {
 				commandManager.register({ id: 'gitpod.api.autoTunnel', execute: () => remoteConnector.autoTunnelCommand });
 
-				remoteSession = new RemoteSession(remoteConnectionInfo.remoteAuthority, remoteConnectionInfo.connectionInfo, context, hostService, sessionService, settingsSync, experiments, logger, telemetryService, notificationService);
+				remoteSession = new RemoteSession(remoteConnectionInfo.remoteAuthority, remoteConnectionInfo.connectionInfo, context, hostService, sessionService, settingsSync, experiments, logger!, telemetryService!, notificationService);
 				await remoteSession.initialize();
 			} else if (sessionService.isSignedIn()) {
 				const restartFlow = { flow: 'restart_workspace', userId: sessionService.getUserId() };
-				checkForStoppedWorkspaces(context, hostService.gitpodHost, restartFlow, notificationService, logger);
+				checkForStoppedWorkspaces(context, hostService.gitpodHost, restartFlow, notificationService, logger!);
 			}
 		});
 
@@ -125,15 +126,17 @@ export async function activate(context: vscode.ExtensionContext) {
 		telemetryService?.sendTelemetryException(e);
 		throw e;
 	} finally {
-		telemetryService?.sendTelemetryEvent('vscode_desktop_activate', {
+		const activateProperties = {
 			remoteName: vscode.env.remoteName || '',
 			remoteUri: String(!!(vscode.workspace.workspaceFile || vscode.workspace.workspaceFolders?.[0].uri)),
 			workspaceId: remoteConnectionInfo?.connectionInfo.workspaceId || '',
 			instanceId: remoteConnectionInfo?.connectionInfo.instanceId || '',
 			gitpodHost: remoteConnectionInfo?.connectionInfo.gitpodHost || '',
 			debugWorkspace: remoteConnectionInfo ? String(!!remoteConnectionInfo.connectionInfo.debugWorkspace) : '',
 			success: String(success)
-		});
+		};
+		logger?.info('Activation properties:', JSON.stringify(activateProperties, undefined, 2));
+		telemetryService?.sendTelemetryEvent('vscode_desktop_activate', activateProperties);
 	}
 }
 

src/services/telemetryService.ts

@@ -9,7 +9,7 @@ import * as os from 'os';
 import * as vscode from 'vscode';
 import { Configuration } from '../configuration';
 
-const analyticsClientFactory = async (key: string): Promise<BaseTelemetryClient> => {
+const analyticsClientFactory = async (key: string, logger: vscode.LogOutputChannel): Promise<BaseTelemetryClient> => {
 	let segmentAnalyticsClient = new Analytics({ writeKey: key });
 
 	// Sets the analytics client into a standardized form
@@ -20,9 +20,13 @@ const analyticsClientFactory = async (key: string): Promise<BaseTelemetryClient>
 					anonymousId: vscode.env.machineId,
 					event: eventName,
 					properties: data?.properties
+				}, (err: any) => {
+					if (err) {
+						logger.error('Failed to log event to app analytics:', err);
+					}
 				});
 			} 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) => {
@@ -60,17 +64,17 @@ const analyticsClientFactory = async (key: string): Promise<BaseTelemetryClient>
 				},
 			}).then((resp) => {
 				if (!resp.ok) {
-					console.log(`Metrics endpoint responded with ${resp.status} ${resp.statusText}`);
+					logger.warn(`Metrics endpoint responded with ${resp.status} ${resp.statusText}`);
 				}
 			}).catch((e) => {
-				console.error('Failed to report error to metrics endpoint!', e);
+				logger.error('Failed to report error to metrics endpoint!', e);
 			});
 		},
 		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);
 			}
 		}
 	};
@@ -102,8 +106,8 @@ export interface ITelemetryService {
 }
 
 export class TelemetryService extends BaseTelemetryReporter implements ITelemetryService {
-	constructor(extensionId: string, extensionVersion: string, key: string) {
-		const appender = new BaseTelemetryAppender(key, (key) => analyticsClientFactory(key));
+	constructor(extensionId: string, extensionVersion: string, key: string, logger: vscode.LogOutputChannel) {
+		const appender = new BaseTelemetryAppender(key, (key) => analyticsClientFactory(key, logger));
 		super(extensionId, extensionVersion, appender, {
 			release: os.release(),
 			platform: os.platform(),