feat: instrument startup telemetry

Author: EhabY

src/core/cliManager.ts

@@ -25,6 +25,7 @@ import type { Api } from "coder/site/src/api/api";
 import type { IncomingMessage } from "node:http";
 
 import type { Logger } from "../logging/logger";
+import type { TelemetryService } from "../telemetry/service";
 
 import type { CliCredentialManager } from "./cliCredentialManager";
 import type { PathResolver } from "./pathResolver";
@@ -33,13 +34,26 @@ type ResolvedBinary =
 	| { binPath: string; stat: Stats; source: "file-path" | "directory" }
 	| { binPath: string; source: "not-found" };
 
+type CliDownloadReason = "missing" | "version_mismatch";
+
+interface BinaryDownloadResult {
+	binPath: string;
+	downloadedBytes?: number;
+}
+
+interface DownloadResult {
+	status: number;
+	downloadedBytes: number;
+}
+
 export class CliManager {
 	private readonly binaryLock: BinaryLock;
 
 	constructor(
 		private readonly output: Logger,
 		private readonly pathResolver: PathResolver,
 		private readonly cliCredentialManager: CliCredentialManager,
+		private readonly telemetry: TelemetryService,
 	) {
 		this.binaryLock = new BinaryLock(output);
 	}
@@ -140,6 +154,8 @@ export class CliManager {
 		);
 
 		let existingVersion: string | null = null;
+		const downloadReason: CliDownloadReason =
+			resolved.source === "not-found" ? "missing" : "version_mismatch";
 		if (resolved.source !== "not-found") {
 			this.output.debug(
 				"Existing binary size is",
@@ -224,13 +240,28 @@ export class CliManager {
 				latestVersion = latestParsedVersion;
 			}
 
-			await this.performBinaryDownload(
-				restClient,
-				latestVersion,
-				downloadBinPath,
-				progressLogPath,
+			return await this.telemetry.trace(
+				"cli.download",
+				async (span) => {
+					const recordDownloadedBytes = (downloadedBytes: number): void => {
+						if (downloadedBytes > 0) {
+							span.setMeasurement("downloadedBytes", downloadedBytes);
+						}
+					};
+					const downloadResult = await this.performBinaryDownload(
+						restClient,
+						latestVersion,
+						downloadBinPath,
+						progressLogPath,
+						recordDownloadedBytes,
+					);
+					if (downloadResult.downloadedBytes !== undefined) {
+						recordDownloadedBytes(downloadResult.downloadedBytes);
+					}
+					return this.renameToFinalPath(resolved, downloadResult.binPath);
+				},
+				{ reason: downloadReason },
 			);
-			return await this.renameToFinalPath(resolved, downloadBinPath);
 		} catch (error) {
 			const fallback = await this.handleAnyBinaryFailure(
 				error,
@@ -413,7 +444,8 @@ export class CliManager {
 		parsedVersion: semver.SemVer,
 		binPath: string,
 		progressLogPath: string,
-	): Promise<string> {
+		recordDownloadedBytes: (downloadedBytes: number) => void,
+	): Promise<BinaryDownloadResult> {
 		const cfg = vscode.workspace.getConfiguration("coder");
 		const tempFile = tempFilePath(binPath, "temp");
 
@@ -449,6 +481,7 @@ export class CliManager {
 				bytesDownloaded: number,
 				totalBytes: number | null,
 			) => {
+				recordDownloadedBytes(bytesDownloaded);
 				await downloadProgress.writeProgress(progressLogPath, {
 					bytesDownloaded,
 					totalBytes,
@@ -457,7 +490,7 @@ export class CliManager {
 			};
 
 			const client = restClient.getAxiosInstance();
-			const status = await this.download(
+			const downloadResult = await this.download(
 				client,
 				binSource,
 				writeStream,
@@ -467,7 +500,7 @@ export class CliManager {
 				onProgress,
 			);
 
-			switch (status) {
+			switch (downloadResult.status) {
 				case 200: {
 					await downloadProgress.writeProgress(progressLogPath, {
 						bytesDownloaded: 0,
@@ -480,27 +513,32 @@ export class CliManager {
 							"Skipping binary signature verification due to settings",
 						);
 					} else {
-						await this.verifyBinarySignatures(client, tempFile, [
-							// A signature placed at the same level as the binary.  It must be
-							// named exactly the same with an appended `.asc` (such as
-							// coder-windows-amd64.exe.asc or coder-linux-amd64.asc).
-							binSource + ".asc",
-							// The releases.coder.com bucket does not include the leading "v",
-							// and unlike what we get from buildinfo it uses a truncated version
-							// with only major.minor.patch.  The signature name follows the same
-							// rule as above.
-							`https://releases.coder.com/coder-cli/${parsedVersion.major}.${parsedVersion.minor}.${parsedVersion.patch}/${binName}.asc`,
-						]);
+						await this.telemetry.trace("cli.verify", () =>
+							this.verifyBinarySignatures(client, tempFile, [
+								// A signature placed at the same level as the binary.  It must be
+								// named exactly the same with an appended `.asc` (such as
+								// coder-windows-amd64.exe.asc or coder-linux-amd64.asc).
+								binSource + ".asc",
+								// The releases.coder.com bucket does not include the leading "v",
+								// and unlike what we get from buildinfo it uses a truncated version
+								// with only major.minor.patch.  The signature name follows the same
+								// rule as above.
+								`https://releases.coder.com/coder-cli/${parsedVersion.major}.${parsedVersion.minor}.${parsedVersion.patch}/${binName}.asc`,
+							]),
+						);
 					}
 
 					// Replace existing binary (handles both renames + Windows lock)
 					await this.replaceExistingBinary(binPath, tempFile);
 
-					return binPath;
+					return {
+						binPath,
+						downloadedBytes: downloadResult.downloadedBytes,
+					};
 				}
 				case 304: {
 					this.output.info("Using existing binary since server returned a 304");
-					return binPath;
+					return { binPath };
 				}
 				case 404: {
 					vscode.window
@@ -537,7 +575,7 @@ export class CliManager {
 							}
 							const params = new URLSearchParams({
 								title: `Failed to download binary on \`${cliUtils.goos()}-${cliUtils.goarch()}\``,
-								body: `Received status code \`${status}\` when downloading the binary.`,
+								body: `Received status code \`${downloadResult.status}\` when downloading the binary.`,
 							});
 							const uri = vscode.Uri.parse(
 								`https://github.com/coder/vscode-coder/issues/new?${params.toString()}`,
@@ -565,7 +603,7 @@ export class CliManager {
 			bytesDownloaded: number,
 			totalBytes: number | null,
 		) => Promise<void>,
-	): Promise<number> {
+	): Promise<DownloadResult> {
 		const baseUrl = client.defaults.baseURL;
 
 		const controller = new AbortController();
@@ -583,6 +621,7 @@ export class CliManager {
 		});
 		this.output.info("Got status code", resp.status);
 
+		let written = 0;
 		if (resp.status === 200) {
 			const rawContentLength = (resp.headers["content-length"] ??
 				resp.headers["x-original-content-length"]) as unknown;
@@ -599,9 +638,6 @@ export class CliManager {
 				this.output.info("Got content length", prettyBytes(contentLength));
 			}
 
-			// Track how many bytes were written.
-			let written = 0;
-
 			const completed = await vscode.window.withProgress<boolean>(
 				{
 					location: vscode.ProgressLocation.Notification,
@@ -686,7 +722,10 @@ export class CliManager {
 			this.output.info(`Downloaded ${prettyBytes(written)}`);
 		}
 
-		return resp.status;
+		return {
+			status: resp.status,
+			downloadedBytes: written,
+		};
 	}
 
 	/**
@@ -776,8 +815,8 @@ export class CliManager {
 		this.output.info("Downloading signature from", source);
 		const signaturePath = path.join(cliPath + ".asc");
 		const writeStream = createWriteStream(signaturePath);
-		const status = await this.download(client, source, writeStream);
-		if (status === 200) {
+		const downloadResult = await this.download(client, source, writeStream);
+		if (downloadResult.status === 200) {
 			try {
 				await pgp.verifySignature(
 					publicKeys,
@@ -806,7 +845,7 @@ export class CliManager {
 				this.output.info("Binary will be ran anyway at user request");
 			}
 		}
-		return status;
+		return downloadResult.status;
 	}
 
 	/**

src/core/container.ts

@@ -51,6 +51,25 @@ export class ServiceContainer implements vscode.Disposable {
 			context.globalState,
 			this.logger,
 		);
+
+		const sessionId = newSessionId();
+		const localJsonlSink = LocalJsonlSink.start(
+			{
+				baseDir: this.pathResolver.getTelemetryPath(),
+				sessionId,
+			},
+			this.logger,
+		);
+		const session = buildSession(
+			extractExtensionVersion(context.extension.packageJSON),
+			sessionId,
+		);
+		this.telemetryService = new TelemetryService(
+			session,
+			[localJsonlSink],
+			this.logger,
+		);
+
 		// Circular ref: cliCredentialManager ↔ cliManager. The resolver
 		// closure captures `this` by reference, so `this.cliManager` is
 		// available when the closure is called (after construction).
@@ -75,6 +94,7 @@ export class ServiceContainer implements vscode.Disposable {
 			this.logger,
 			this.pathResolver,
 			this.cliCredentialManager,
+			this.telemetryService,
 		);
 		this.contextManager = new ContextManager(context);
 		this.oauthCallback = new OAuthCallback(context.secrets, this.logger);
@@ -96,23 +116,6 @@ export class ServiceContainer implements vscode.Disposable {
 			this.logger,
 		);
 
-		const sessionId = newSessionId();
-		const localJsonlSink = LocalJsonlSink.start(
-			{
-				baseDir: this.pathResolver.getTelemetryPath(),
-				sessionId,
-			},
-			this.logger,
-		);
-		const session = buildSession(
-			extractExtensionVersion(context.extension.packageJSON),
-			sessionId,
-		);
-		this.telemetryService = new TelemetryService(
-			session,
-			[localJsonlSink],
-			this.logger,
-		);
 		this.commandManager = new CommandManager(this.telemetryService);
 	}
 

src/extension.ts

@@ -14,6 +14,7 @@ import { ServiceContainer } from "./core/container";
 import { DeploymentManager } from "./deployment/deploymentManager";
 import { CertificateError } from "./error/certificateError";
 import { getErrorDetail, toError } from "./error/errorUtils";
+import { ActivationTelemetry } from "./instrumentation/activation";
 import { OAuthSessionManager } from "./oauth/sessionManager";
 import { Remote } from "./remote/remote";
 import { getRemoteSshExtension } from "./remote/sshExtension";
@@ -30,6 +31,22 @@ const MY_WORKSPACES_TREE_ID = "myWorkspaces";
 const ALL_WORKSPACES_TREE_ID = "allWorkspaces";
 
 export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
+	const serviceContainer = new ServiceContainer(ctx);
+	ctx.subscriptions.push(serviceContainer);
+	const activationTelemetry = new ActivationTelemetry(
+		serviceContainer.getTelemetryService(),
+	);
+
+	await activationTelemetry.trace(() =>
+		doActivate(ctx, serviceContainer, activationTelemetry),
+	);
+}
+
+async function doActivate(
+	ctx: vscode.ExtensionContext,
+	serviceContainer: ServiceContainer,
+	activationTelemetry: ActivationTelemetry,
+): Promise<void> {
 	// The Remote SSH extension's proposed APIs are used to override the SSH host
 	// name in VS Code itself. It's visually unappealing having a lengthy name!
 	//
@@ -59,9 +76,6 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
 	// Initialize the global vscodeProposed module for use throughout the extension
 	initVscodeProposed(vscodeProposed);
 
-	const serviceContainer = new ServiceContainer(ctx);
-	ctx.subscriptions.push(serviceContainer);
-
 	const output = serviceContainer.getLogger();
 	const mementoManager = serviceContainer.getMementoManager();
 	const secretsManager = serviceContainer.getSecretsManager();
@@ -75,6 +89,12 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
 	const startupMode = await mementoManager.getAndClearStartupMode();
 
 	const deployment = await secretsManager.getCurrentDeployment();
+	const deploymentSessionAuth = deployment
+		? await secretsManager.getSessionAuth(deployment.safeHostname)
+		: undefined;
+	activationTelemetry.setAuthState(
+		deploymentSessionAuth ? "valid_token" : "none",
+	);
 
 	// Shared handler for auth failures (used by interceptor + session manager)
 	const handleAuthFailure = (): Promise<void> => {
@@ -111,8 +131,7 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
 	// in commands that operate on the current login.
 	const client = CoderApi.create(
 		deployment?.url || "",
-		(await secretsManager.getSessionAuth(deployment?.safeHostname ?? ""))
-			?.token,
+		deploymentSessionAuth?.token,
 		output,
 	);
 	ctx.subscriptions.push(client);
@@ -372,11 +391,14 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
 			if (details) {
 				ctx.subscriptions.push(details);
 
-				await deploymentManager.setDeploymentIfValid({
+				const deploymentSet = await deploymentManager.setDeploymentIfValid({
 					safeHostname: details.safeHostname,
 					url: details.url,
 					token: details.token,
 				});
+				activationTelemetry.setAuthState(
+					deploymentSet ? "valid_token" : "expired",
+				);
 
 				// If a deep link stored a chat agent ID before the
 				// remote-authority reload, open it now that the
@@ -391,7 +413,9 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
 		} catch (ex) {
 			if (ex instanceof CertificateError) {
 				output.warn(ex.detail);
-				await ex.showNotification("Failed to open workspace", { modal: true });
+				await ex.showNotification("Failed to open workspace", {
+					modal: true,
+				});
 			} else if (isAxiosError(ex)) {
 				const msg = getErrorMessage(ex, "None");
 				const detail = getErrorDetail(ex) || "None";
@@ -432,9 +456,10 @@ export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
 		contextManager.set("coder.loaded", true);
 	} else if (deployment) {
 		output.info(`Initializing deployment: ${deployment.url}`);
-		deploymentManager
-			.setDeploymentIfValid(deployment)
-			// Failure is logged internally
+		activationTelemetry
+			.traceDeploymentInit(() =>
+				deploymentManager.setDeploymentIfValid(deployment),
+			)
 			.then((success) => {
 				if (success) {
 					output.info("Deployment authenticated and set");