Test extension logging API

[sandy081]

Refs: #159892, #161944

• any @paulacamargo25
• any @weinand
• any @karthiknadig

Complexity: 5

Create Issue

---

Proposal

Added, logLevel and the corresponding change event to the output channel and env. Please test these APIs.

vscode/src/vscode-dts/vscode.proposed.extensionLog.d.ts

Lines 18 to 30 in 5a326b2

	export namespace env {
	/**
	* The current log level of the application.
	*/
	export const logLevel: LogLevel;
	/**
	* An {@link Event} which fires when the log level of the application changes.
	*/
	export const onDidChangeLogLevel: Event<LogLevel>;
	}

vscode/src/vscode-dts/vscode.proposed.extensionLog.d.ts

Lines 32 to 46 in 5a326b2

	/**
	* A channel for containing log output.
	*/
	export interface LogOutputChannel extends OutputChannel {
	/**
	* The current log level of the channel.
	*/
	readonly logLevel: LogLevel;
	/**
	* An {@link Event} which fires when the log level of the channel changes.
	*/
	readonly onDidChangeLogLevel: Event<LogLevel>;

Testing

Create a log output channel using the following API

vscode/src/vscode-dts/vscode.proposed.extensionLog.d.ts

Line 96 in 5a326b2

export function createOutputChannel(name: string, options: { readonly log: true }): LogOutputChannel;

Env: Testing Log Level and the change event for all logs

Configure log levels for all log channels using the command Set Log Level... and make sure

• log level change is being propagated in env and also in your log output channel
• log output channel UI is not logging the logs those do not respect the set log level.

Log Output Channel: Testing Log Level and the change event for a log output channel

Configure log levels for this log channel using the command Set Log Level... and make sure

• log level is being propagated to your output channel
• log output channel UI is not logging the logs those do not respect the set log level.
• this overrides the log level configured for all loggers.

CLI: Testing Log Level configure from CLI

You can now configure the default log level for an extension from CLI using the format code --log <extensionId>:<logLevel>, for eg., the following sets the log level to trace for all log output channels of vscode.git extension.

code --log vscode.git:trace

Following will set the log level to debug for all loggers (Note this format is already supported)

code --log debug

Please make sure

• the configured log level is propagated to your output channel
• the log level that was set for all loggers from the command line, is propagated to your output channel and also in env
• log output channel UI is not logging the logs those do not respect the configured log level.
• the documentation in the CLI explains this.

[karthiknadig]

@sandy081 This command did not work for me code-insiders --log vscode.git:trace . but code-insiders . works. I verified that vscode.git is installed. Created #164661 to track this.

[karthiknadig]

Tries this with a language server client. works fantastically!!!

These are being logged from python over LSP through language client.