feat(logging): tag logs with a per-session ID

src/core/container.ts

@@ -1,6 +1,7 @@
 import * as vscode from "vscode";
 
 import { AuthTelemetry } from "../instrumentation/auth";
+import { SessionLogger } from "../logging/sessionLogger";
 import { LoginCoordinator } from "../login/loginCoordinator";
 import { OAuthCallback } from "../oauth/oauthCallback";
 import { buildSession, extractExtensionVersion } from "../telemetry/event";
@@ -26,7 +27,9 @@ import type { Logger } from "../logging/logger";
  * Centralizes the creation and management of all core services.
  */
 export class ServiceContainer implements vscode.Disposable {
-	private readonly logger: vscode.LogOutputChannel;
+	private readonly outputChannel: vscode.LogOutputChannel;
+	private readonly sessionId: string;
+	private readonly logger: Logger;
 	private readonly pathResolver: PathResolver;
 	private readonly mementoManager: MementoManager;
 	private readonly secretsManager: SecretsManager;
@@ -42,7 +45,13 @@ export class ServiceContainer implements vscode.Disposable {
 	private readonly commandManager: CommandManager;
 
 	constructor(context: vscode.ExtensionContext) {
-		this.logger = vscode.window.createOutputChannel("Coder", { log: true });
+		this.outputChannel = vscode.window.createOutputChannel("Coder", {
+			log: true,
+		});
+		// One session ID per activation, shared by logs, API requests,
+		// telemetry, and the CLI so all data for a session correlates.
+		this.sessionId = newSessionId();
+		this.logger = new SessionLogger(this.outputChannel, this.sessionId);
 		this.pathResolver = new PathResolver(
 			context.globalStorageUri.fsPath,
 			context.logUri.fsPath,
@@ -56,7 +65,7 @@ export class ServiceContainer implements vscode.Disposable {
 
 		const session = buildSession(
 			extractExtensionVersion(context.extension.packageJSON),
-			newSessionId(),
+			this.sessionId,
 		);
 		const localJsonlSink = LocalJsonlSink.start(
 			{
@@ -139,6 +148,10 @@ export class ServiceContainer implements vscode.Disposable {
 		return this.logger;
 	}
 
+	getSessionId(): string {
+		return this.sessionId;
+	}
+
 	getCliManager(): CliManager {
 		return this.cliManager;
 	}
@@ -187,7 +200,7 @@ export class ServiceContainer implements vscode.Disposable {
 		try {
 			await this.telemetryService.dispose();
 		} finally {
-			this.logger.dispose();
+			this.outputChannel.dispose();
 		}
 	}
 }

src/logging/sessionLogger.ts

@@ -0,0 +1,42 @@
+import type { Logger } from "./logger";
+
+/**
+ * Wraps a {@link Logger} and prefixes every message with the session ID so all
+ * log lines produced during a session can be correlated by searching for a
+ * single ID. Composition, not inheritance: it forwards to the underlying
+ * logger after tagging the message.
+ */
+export class SessionLogger implements Logger {
+	constructor(
+		private readonly inner: Logger,
+		private readonly sessionId: string,
+	) {}
+
+	private prefix(message: string): string {
+		return `[${this.sessionId}] ${message}`;
+	}
+
+	trace(message: string, ...args: unknown[]): void {
+		this.inner.trace(this.prefix(message), ...args);
+	}
+
+	debug(message: string, ...args: unknown[]): void {
+		this.inner.debug(this.prefix(message), ...args);
+	}
+
+	info(message: string, ...args: unknown[]): void {
+		this.inner.info(this.prefix(message), ...args);
+	}
+
+	warn(message: string, ...args: unknown[]): void {
+		this.inner.warn(this.prefix(message), ...args);
+	}
+
+	error(message: string, ...args: unknown[]): void {
+		this.inner.error(this.prefix(message), ...args);
+	}
+
+	show(): void {
+		this.inner.show();
+	}
+}

test/unit/logging/sessionLogger.test.ts

@@ -0,0 +1,45 @@
+import { describe, expect, it } from "vitest";
+
+import { SessionLogger } from "@/logging/sessionLogger";
+
+import { createMockLogger } from "../../mocks/testHelpers";
+
+const SESSION_ID = "0123456789abcdef0123456789abcdef";
+
+describe("SessionLogger", () => {
+	it("prefixes every level with the session ID", () => {
+		const inner = createMockLogger();
+		const logger = new SessionLogger(inner, SESSION_ID);
+
+		logger.trace("trace msg");
+		logger.debug("debug msg");
+		logger.info("info msg");
+		logger.warn("warn msg");
+		logger.error("error msg");
+
+		expect(inner.trace).toHaveBeenCalledWith(`[${SESSION_ID}] trace msg`);
+		expect(inner.debug).toHaveBeenCalledWith(`[${SESSION_ID}] debug msg`);
+		expect(inner.info).toHaveBeenCalledWith(`[${SESSION_ID}] info msg`);
+		expect(inner.warn).toHaveBeenCalledWith(`[${SESSION_ID}] warn msg`);
+		expect(inner.error).toHaveBeenCalledWith(`[${SESSION_ID}] error msg`);
+	});
+
+	it("forwards additional arguments unchanged", () => {
+		const inner = createMockLogger();
+		const logger = new SessionLogger(inner, SESSION_ID);
+		const err = new Error("boom");
+
+		logger.error("failed", err, 42);
+
+		expect(inner.error).toHaveBeenCalledWith(`[${SESSION_ID}] failed`, err, 42);
+	});
+
+	it("delegates show() to the underlying logger", () => {
+		const inner = createMockLogger();
+		const logger = new SessionLogger(inner, SESSION_ID);
+
+		logger.show();
+
+		expect(inner.show).toHaveBeenCalledOnce();
+	});
+});