Added setting python.logging.level which carries the logging level value the extension will log at (#11698)

Kartik Raj · ericsnowcurrently · commit 9bedf2d350d2 · 2020-06-18T14:03:33.000-06:00
* Added setting

* Code reviews

* Fix unit tests

* Code reviews

* Put config.level back

* Added commnet

* Code review

* More code reviews

* Fix tests
diff --git a/news/3 Code Health/11699.md b/news/3 Code Health/11699.md
@@ -0,0 +1 @@
+Added setting `python.logging.level` which carries the logging level value the extension will log at.
diff --git a/news/3 Code Health/9837.md b/news/3 Code Health/9837.md
@@ -1 +1 @@
-Move all logging to the Python output channel.
+Move all logging to the Python output channel.
diff --git a/package.json b/package.json
@@ -1714,6 +1714,19 @@
                     "description": "Automatically update the language server.",
                     "scope": "application"
                 },
+                "python.logging.level": {
+                    "type": "string",
+                    "default": "error",
+                    "enum": [
+                        "off",
+                        "error",
+                        "warn",
+                        "info",
+                        "debug"
+                    ],
+                    "description": "The logging level the extension logs at, defaults to 'error'",
+                    "scope": "machine"
+                },
                 "python.experiments.enabled": {
                     "type": "boolean",
                     "default": true,
diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts
@@ -15,6 +15,7 @@ import {
 import { LanguageServerType } from '../activation/types';
 import '../common/extensions';
 import { IInterpreterAutoSeletionProxyService, IInterpreterSecurityService } from '../interpreter/autoSelection/types';
+import { LogLevel } from '../logging/levels';
 import { sendTelemetryEvent } from '../telemetry';
 import { EventName } from '../telemetry/constants';
 import { sendSettingTelemetry } from '../telemetry/envFileTelemetry';
@@ -34,11 +35,13 @@ import {
     IFormattingSettings,
     IInterpreterPathService,
     ILintingSettings,
+    ILoggingSettings,
     IPythonSettings,
     ISortImportSettings,
     ITerminalSettings,
     ITestingSettings,
     IWorkspaceSymbolSettings,
+    LoggingLevelSettingType,
     Resource
 } from './types';
 import { debounceSync } from './utils/decorators';
@@ -111,6 +114,7 @@ export class PythonSettings implements IPythonSettings {
     public insidersChannel!: ExtensionChannels;
     public experiments!: IExperiments;
     public languageServer: LanguageServerType = LanguageServerType.Microsoft;
+    public logging: ILoggingSettings = { level: LogLevel.Error };
 
     protected readonly changed = new EventEmitter<void>();
     private workspaceRoot: Resource;
@@ -251,6 +255,15 @@ export class PythonSettings implements IPythonSettings {
         this.devOptions = systemVariables.resolveAny(pythonSettings.get<any[]>('devOptions'))!;
         this.devOptions = Array.isArray(this.devOptions) ? this.devOptions : [];
 
+        // tslint:disable-next-line: no-any
+        const loggingSettings = systemVariables.resolveAny(pythonSettings.get<any>('logging'))!;
+        loggingSettings.level = convertSettingTypeToLogLevel(loggingSettings.level);
+        if (this.logging) {
+            Object.assign<ILoggingSettings, ILoggingSettings>(this.logging, loggingSettings);
+        } else {
+            this.logging = loggingSettings;
+        }
+
         // tslint:disable-next-line:no-backbone-get-set-outside-model no-non-null-assertion
         const lintingSettings = systemVariables.resolveAny(pythonSettings.get<ILintingSettings>('linting'))!;
         if (this.linting) {
@@ -703,3 +716,23 @@ function isValidPythonPath(pythonPath: string): boolean {
         return false;
     }
 }
+
+function convertSettingTypeToLogLevel(setting: LoggingLevelSettingType | undefined): LogLevel | 'off' {
+    switch (setting) {
+        case 'info': {
+            return LogLevel.Info;
+        }
+        case 'warn': {
+            return LogLevel.Warn;
+        }
+        case 'off': {
+            return 'off';
+        }
+        case 'debug': {
+            return LogLevel.Debug;
+        }
+        default: {
+            return LogLevel.Error;
+        }
+    }
+}
diff --git a/src/client/common/types.ts b/src/client/common/types.ts
@@ -18,6 +18,7 @@ import {
     WorkspaceEdit
 } from 'vscode';
 import { LanguageServerType } from '../activation/types';
+import { LogLevel } from '../logging/levels';
 import { CommandsWithoutArgs } from './application/commands';
 import { ExtensionChannels } from './insidersBuild/types';
 import { InterpreterUri } from './installer/types';
@@ -187,6 +188,7 @@ export interface IPythonSettings {
     readonly experiments: IExperiments;
     readonly languageServer: LanguageServerType;
     readonly defaultInterpreterPath: string;
+    readonly logging: ILoggingSettings;
 }
 export interface ISortImportSettings {
     readonly path: string;
@@ -228,6 +230,12 @@ export interface IMypyCategorySeverity {
     readonly error: DiagnosticSeverity;
     readonly note: DiagnosticSeverity;
 }
+
+export type LoggingLevelSettingType = 'off' | 'error' | 'warn' | 'info' | 'debug';
+
+export interface ILoggingSettings {
+    readonly level: LogLevel | 'off';
+}
 export interface ILintingSettings {
     readonly enabled: boolean;
     readonly ignorePatterns: string[];
diff --git a/src/client/extensionActivation.ts b/src/client/extensionActivation.ts
@@ -49,7 +49,7 @@ import { IServiceContainer, IServiceManager } from './ioc/types';
 import { getLanguageConfiguration } from './language/languageConfiguration';
 import { LinterCommands } from './linters/linterCommands';
 import { registerTypes as lintersRegisterTypes } from './linters/serviceRegistry';
-import { addOutputChannelLogging } from './logging';
+import { addOutputChannelLogging, setLoggingLevel } from './logging';
 import { PythonCodeActionProvider } from './providers/codeActionProvider/pythonCodeActionProvider';
 import { PythonFormattingEditProvider } from './providers/formatProvider';
 import { ReplProvider } from './providers/replProvider';
@@ -117,14 +117,19 @@ async function activateLegacy(
     commonRegisterTerminalTypes(serviceManager);
     debugConfigurationRegisterTypes(serviceManager);
 
+    const configuration = serviceManager.get<IConfigurationService>(IConfigurationService);
+    // We should start logging using the log level as soon as possible, so set it as soon as we can access the level.
+    // `IConfigurationService` may depend any of the registered types, so doing it after all registrations are finished.
+    // XXX Move this *after* abExperiments is activated?
+    setLoggingLevel(configuration.getSettings().logging.level);
+
     const abExperiments = serviceContainer.get<IExperimentsManager>(IExperimentsManager);
     await abExperiments.activate();
 
     // Register datascience types after experiments have loaded.
     // To ensure we can register types based on experiments.
     dataScienceRegisterTypes(serviceManager);
 
-    const configuration = serviceManager.get<IConfigurationService>(IConfigurationService);
     const languageServerType = configuration.getSettings().languageServer;
 
     // Language feature registrations.
diff --git a/src/client/logging/_global.ts b/src/client/logging/_global.ts
@@ -2,11 +2,12 @@
 // Licensed under the MIT License.
 'use strict';
 
+import * as winston from 'winston';
 import { isCI } from '../common/constants';
 import { IOutputChannel } from '../common/types';
 import { CallInfo } from '../common/utils/decorators';
 import { getFormatter } from './formatters';
-import { LogLevel } from './levels';
+import { LogLevel, resolveLevelName } from './levels';
 import { configureLogger, createLogger, ILogger, LoggerConfig, logToAll } from './logger';
 import { createTracingDecorator, LogInfo, TraceOptions, tracing as _tracing } from './trace';
 import { getPythonOutputChannelTransport } from './transports';
@@ -70,7 +71,22 @@ function initialize() {
     }
 }
 
-// Register the output channel transport the logger will log into
+// Set the logging level the extension logs at.
+export function setLoggingLevel(level: LogLevel | 'off') {
+    if (level === 'off') {
+        // For now we disable all logging. One alternative would be
+        // to only disable logging to the output channel (by removing
+        // the transport from the logger).
+        globalLogger.clear();
+    } else {
+        const levelName = resolveLevelName(level, winston.config.npm.levels);
+        if (levelName) {
+            globalLogger.level = levelName;
+        }
+    }
+}
+
+// Register the output channel transport the logger will log into.
 export function addOutputChannelLogging(channel: IOutputChannel) {
     const formatter = getFormatter();
     const transport = getPythonOutputChannelTransport(channel, formatter);
diff --git a/src/client/logging/index.ts b/src/client/logging/index.ts
@@ -5,6 +5,7 @@
 export {
     // aliases
     // (for convenience)
+    setLoggingLevel,
     addOutputChannelLogging,
     logError,
     logInfo,
diff --git a/src/test/common/configSettings/configSettings.pythonPath.unit.test.ts b/src/test/common/configSettings/configSettings.pythonPath.unit.test.ts
@@ -45,6 +45,7 @@ suite('Python Settings - pythonPath', () => {
         experimentsManager = typemoq.Mock.ofType<IExperimentsManager>();
         workspaceService = typemoq.Mock.ofType<IWorkspaceService>();
         pythonSettings.setup((p) => p.get(typemoq.It.isValue('defaultInterpreterPath'))).returns(() => 'python');
+        pythonSettings.setup((p) => p.get('logging')).returns(() => ({ level: 'error' }));
     });
     teardown(() => {
         if (configSettings) {
diff --git a/src/test/common/configSettings/configSettings.unit.test.ts b/src/test/common/configSettings/configSettings.unit.test.ts
@@ -21,6 +21,7 @@ import {
     IExperiments,
     IFormattingSettings,
     ILintingSettings,
+    ILoggingSettings,
     ISortImportSettings,
     ITerminalSettings,
     ITestingSettings,
@@ -105,6 +106,7 @@ suite('Python Settings', async () => {
         config.setup((c) => c.get<any[]>('devOptions')).returns(() => sourceSettings.devOptions);
 
         // complex settings
+        config.setup((c) => c.get<ILoggingSettings>('logging')).returns(() => sourceSettings.logging);
         config.setup((c) => c.get<ILintingSettings>('linting')).returns(() => sourceSettings.linting);
         config.setup((c) => c.get<IAnalysisSettings>('analysis')).returns(() => sourceSettings.analysis);
         config.setup((c) => c.get<ISortImportSettings>('sortImports')).returns(() => sourceSettings.sortImports);

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Added setting `python.logging.level` which carries the logging level value the extension will log at.
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-Move all logging to the Python output channel.`
	`1`	`+Move all logging to the Python output channel.`