Prefix log messages with session ID

Author: lionel-

extensions/positron-supervisor/src/KallichoreSession.ts

@@ -47,6 +47,7 @@ import { CommBackendRequest, CommRpcMessage, CommImpl } from './Comm';
 import { channel, Sender } from './Channel';
 import { DapComm } from './DapComm';
 import { JupyterKernelStatus } from './jupyter/JupyterKernelStatus.js';
+import { OutputChannelFormatted, LogOutputChannelFormatted } from './OutputChannelFormatted';
 
 /**
  * The reason for a disconnection event.
@@ -135,12 +136,12 @@ export class KallichoreSession implements JupyterLanguageRuntimeSession {
 	/**
 	 * The channel to which output for this specific kernel is logged, if any
 	 */
-	private readonly _kernelChannel: vscode.OutputChannel;
+	private readonly _kernelChannel: OutputChannelFormatted;
 
 	/**
 	 * The channel to which output for this specific console is logged
 	 */
-	private readonly _consoleChannel: vscode.LogOutputChannel;
+	private readonly _consoleChannel: LogOutputChannelFormatted;
 
 	/**
 	 * The channel to which profile output for this specific kernel is logged, if any
@@ -213,14 +214,18 @@ export class KallichoreSession implements JupyterLanguageRuntimeSession {
 		this.onDidEndSession = this._exit.event;
 
 		// Establish log channels for the console and kernel we're connecting to
-		this._consoleChannel = vscode.window.createOutputChannel(
-			metadata.notebookUri ?
-				`${runtimeMetadata.runtimeName}: Notebook: (${path.basename(metadata.notebookUri.path)})` :
-				`${runtimeMetadata.runtimeName}: Console`,
-			{ log: true });
-
-		this._kernelChannel = positron.window.createRawLogOutputChannel(
-			`${runtimeMetadata.runtimeName}: Kernel`);
+		this._consoleChannel = new LogOutputChannelFormatted(
+			vscode.window.createOutputChannel(
+				`${runtimeMetadata.languageName} Supervisor`,
+				{ log: true }
+			),
+			(msg) => `${metadata.sessionId} ${msg}`
+		);
+
+		this._kernelChannel = new OutputChannelFormatted(
+			positron.window.createRawLogOutputChannel(`${runtimeMetadata.languageName} Kernel`),
+			(msg) => `${metadata.sessionId} ${msg}`
+		);
 		this._kernelChannel.appendLine(`** Begin kernel log for session ${dynState.sessionName} (${metadata.sessionId}) at ${new Date().toLocaleString()} **`);
 
 		// Open the established barrier immediately if we're restoring an

extensions/positron-supervisor/src/OutputChannelFormatted.ts

@@ -0,0 +1,144 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (C) 2025 Posit Software, PBC. All rights reserved.
+ *  Licensed under the Elastic License 2.0. See LICENSE.txt for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+
+/**
+ * Function type for formatting messages before they are appended to the channel.
+ */
+export type MessageFormatter = (message: string) => string;
+
+/**
+ * OutputChannel with formatting applied to `appendLine()`.
+ */
+export class OutputChannelFormatted implements vscode.OutputChannel {
+	constructor(
+		private readonly channel: vscode.OutputChannel,
+		private readonly formatter: MessageFormatter
+	) { }
+
+	get name(): string {
+		return this.channel.name;
+	}
+
+	append(value: string): void {
+		this.channel.append(value);
+	}
+
+	appendLine(value: string): void {
+		this.channel.appendLine(this.formatter(value));
+	}
+
+	replace(value: string): void {
+		this.channel.replace(value);
+	}
+
+	clear(): void {
+		this.channel.clear();
+	}
+
+	show(preserveFocus?: boolean): void;
+	show(column?: vscode.ViewColumn, preserveFocus?: boolean): void;
+	show(columnOrPreserveFocus?: vscode.ViewColumn | boolean, preserveFocus?: boolean): void {
+		if (typeof columnOrPreserveFocus === 'boolean' || columnOrPreserveFocus === undefined) {
+			this.channel.show(columnOrPreserveFocus);
+		} else {
+			this.channel.show(preserveFocus);
+		}
+	}
+
+	hide(): void {
+		this.channel.hide();
+	}
+
+	dispose(): void {
+		this.channel.dispose();
+	}
+}
+
+/**
+ * A wrapper around LogOutputChannel that allows custom message formatting for all log methods.
+ */
+export class LogOutputChannelFormatted implements vscode.LogOutputChannel {
+	constructor(
+		private readonly channel: vscode.LogOutputChannel,
+		private readonly formatter: MessageFormatter
+	) { }
+
+	get logLevel(): vscode.LogLevel {
+		return this.channel.logLevel;
+	}
+
+	get onDidChangeLogLevel(): vscode.Event<vscode.LogLevel> {
+		return this.channel.onDidChangeLogLevel;
+	}
+
+	get name(): string {
+		return this.channel.name;
+	}
+
+	append(value: string): void {
+		this.channel.append(value);
+	}
+
+	appendLine(value: string): void {
+		this.channel.appendLine(this.formatter(value));
+	}
+
+	replace(value: string): void {
+		this.channel.replace(value);
+	}
+
+	clear(): void {
+		this.channel.clear();
+	}
+
+	show(preserveFocus?: boolean): void;
+	show(column?: vscode.ViewColumn, preserveFocus?: boolean): void;
+	show(columnOrPreserveFocus?: vscode.ViewColumn | boolean, preserveFocus?: boolean): void {
+		if (typeof columnOrPreserveFocus === 'boolean' || columnOrPreserveFocus === undefined) {
+			this.channel.show(columnOrPreserveFocus);
+		} else {
+			this.channel.show(preserveFocus);
+		}
+	}
+
+	hide(): void {
+		this.channel.hide();
+	}
+
+	dispose(): void {
+		this.channel.dispose();
+	}
+
+	trace(message: string, ...args: any[]): void {
+		this.channel.trace(this.formatter(message), ...args);
+	}
+
+	debug(message: string, ...args: any[]): void {
+		this.channel.debug(this.formatter(message), ...args);
+	}
+
+	info(message: string, ...args: any[]): void {
+		this.channel.info(this.formatter(message), ...args);
+	}
+
+	warn(message: string, ...args: any[]): void {
+		this.channel.warn(this.formatter(message), ...args);
+	}
+
+	error(message: string | Error, ...args: any[]): void {
+		if (typeof message === 'string') {
+			this.channel.error(this.formatter(message), ...args);
+		} else {
+			// Format the error message and include stack trace if available
+			const formatted = this.formatter(message.message);
+			const fullMessage = message.stack
+				? `${formatted}\n${message.stack}`
+				: formatted;
+			this.channel.error(fullMessage, ...args);
+		}
+	}
+}