watcher - log telemetry when watcher fails (microsoft#210570)

Author: bpasero

src/vs/platform/files/node/watcher/watcherClient.ts

@@ -40,7 +40,7 @@ export class UniversalWatcherClient extends AbstractUniversalWatcherClient {
 		));
 
 		// React on unexpected termination of the watcher process
-		disposables.add(client.onDidProcessExit(({ code, signal }) => this.onError(`terminated by itself with code ${code}, signal: ${signal}`)));
+		disposables.add(client.onDidProcessExit(({ code, signal }) => this.onError(`terminated by itself with code ${code}, signal: ${signal} (ETERM)`)));
 
 		return ProxyChannel.toService<IUniversalWatcher>(getNextTickChannel(client.getChannel('watcher')));
 	}

src/vs/workbench/contrib/files/browser/files.contribution.ts

@@ -7,7 +7,7 @@ import * as nls from 'vs/nls';
 import { sep } from 'vs/base/common/path';
 import { Registry } from 'vs/platform/registry/common/platform';
 import { IConfigurationRegistry, Extensions as ConfigurationExtensions, ConfigurationScope, IConfigurationPropertySchema } from 'vs/platform/configuration/common/configurationRegistry';
-import { IWorkbenchContributionsRegistry, Extensions as WorkbenchExtensions, IWorkbenchContribution, WorkbenchPhase, registerWorkbenchContribution2 } from 'vs/workbench/common/contributions';
+import { IWorkbenchContribution, WorkbenchPhase, registerWorkbenchContribution2 } from 'vs/workbench/common/contributions';
 import { IFileEditorInput, IEditorFactoryRegistry, EditorExtensions } from 'vs/workbench/common/editor';
 import { AutoSaveConfiguration, HotExitConfiguration, FILES_EXCLUDE_CONFIG, FILES_ASSOCIATIONS_CONFIG, FILES_READONLY_INCLUDE_CONFIG, FILES_READONLY_EXCLUDE_CONFIG, FILES_READONLY_FROM_PERMISSIONS_CONFIG } from 'vs/platform/files/common/files';
 import { SortOrder, LexicographicOptions, FILE_EDITOR_INPUT_ID, BINARY_TEXT_FILE_MODE, UndoConfirmLevel, IFilesConfiguration } from 'vs/workbench/contrib/files/common/files';
@@ -20,7 +20,6 @@ import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors';
 import { isNative, isWeb, isWindows } from 'vs/base/common/platform';
 import { ExplorerViewletViewsContribution } from 'vs/workbench/contrib/files/browser/explorerViewlet';
 import { IEditorPaneRegistry, EditorPaneDescriptor } from 'vs/workbench/browser/editor';
-import { LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle';
 import { ILabelService } from 'vs/platform/label/common/label';
 import { InstantiationType, registerSingleton } from 'vs/platform/instantiation/common/extensions';
 import { ExplorerService, UNDO_REDO_SOURCE } from 'vs/workbench/contrib/files/browser/explorerService';
@@ -113,7 +112,7 @@ registerWorkbenchContribution2(TextFileSaveErrorHandler.ID, TextFileSaveErrorHan
 registerWorkbenchContribution2(FileUriLabelContribution.ID, FileUriLabelContribution, WorkbenchPhase.BlockStartup);
 
 // Register Workspace Watcher
-Registry.as<IWorkbenchContributionsRegistry>(WorkbenchExtensions.Workbench).registerWorkbenchContribution(WorkspaceWatcher, LifecyclePhase.Restored);
+registerWorkbenchContribution2(WorkspaceWatcher.ID, WorkspaceWatcher, WorkbenchPhase.AfterRestored);
 
 // Register Dirty Files Indicator
 registerWorkbenchContribution2(DirtyFilesIndicator.ID, DirtyFilesIndicator, WorkbenchPhase.BlockStartup);

src/vs/workbench/contrib/files/browser/workspaceWatcher.ts

@@ -15,9 +15,12 @@ import { IOpenerService } from 'vs/platform/opener/common/opener';
 import { isAbsolute } from 'vs/base/common/path';
 import { IUriIdentityService } from 'vs/platform/uriIdentity/common/uriIdentity';
 import { IHostService } from 'vs/workbench/services/host/browser/host';
+import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
 
 export class WorkspaceWatcher extends Disposable {
 
+	static readonly ID = 'workbench.contrib.workspaceWatcher';
+
 	private readonly watchedWorkspaces = new ResourceMap<IDisposable>(resource => this.uriIdentityService.extUri.getComparisonKey(resource));
 
 	constructor(
@@ -27,7 +30,8 @@ export class WorkspaceWatcher extends Disposable {
 		@INotificationService private readonly notificationService: INotificationService,
 		@IOpenerService private readonly openerService: IOpenerService,
 		@IUriIdentityService private readonly uriIdentityService: IUriIdentityService,
-		@IHostService private readonly hostService: IHostService
+		@IHostService private readonly hostService: IHostService,
+		@ITelemetryService private readonly telemetryService: ITelemetryService
 	) {
 		super();
 
@@ -68,9 +72,12 @@ export class WorkspaceWatcher extends Disposable {
 
 	private onDidWatchError(error: Error): void {
 		const msg = error.toString();
+		let reason: 'ENOSPC' | 'EUNKNOWN' | 'ETERM' | undefined = undefined;
 
 		// Detect if we run into ENOSPC issues
 		if (msg.indexOf('ENOSPC') >= 0) {
+			reason = 'ENOSPC';
+
 			this.notificationService.prompt(
 				Severity.Warning,
 				localize('enospcError', "Unable to watch for file changes. Please follow the instructions link to resolve this issue."),
@@ -87,6 +94,8 @@ export class WorkspaceWatcher extends Disposable {
 
 		// Detect when the watcher throws an error unexpectedly
 		else if (msg.indexOf('EUNKNOWN') >= 0) {
+			reason = 'EUNKNOWN';
+
 			this.notificationService.prompt(
 				Severity.Warning,
 				localize('eshutdownError', "File changes watcher stopped unexpectedly. A reload of the window may enable the watcher again unless the workspace cannot be watched for file changes."),
@@ -100,6 +109,24 @@ export class WorkspaceWatcher extends Disposable {
 				}
 			);
 		}
+
+		// Detect unexpected termination
+		else if (msg.indexOf('ETERM') >= 0) {
+			reason = 'ETERM';
+		}
+
+		// Log telemetry if we gathered a reason
+		if (reason) {
+			type WatchErrorClassification = {
+				owner: 'bpasero';
+				comment: 'An event that fires when a watcher errors';
+				reason: { classification: 'SystemMetaData'; purpose: 'PerformanceAndHealth'; comment: 'The watcher error reason.' };
+			};
+			type WatchErrorEvent = {
+				reason: string;
+			};
+			this.telemetryService.publicLog2<WatchErrorEvent, WatchErrorClassification>('fileWatcherError', { reason });
+		}
 	}
 
 	private watchWorkspace(workspace: IWorkspaceFolder): void {

src/vs/workbench/services/files/electron-sandbox/watcherClient.ts

@@ -46,7 +46,7 @@ export class UniversalWatcherClient extends AbstractUniversalWatcherClient {
 				if (reason?.code === 0) {
 					this.trace(`terminated by itself with code ${reason.code}, signal: ${reason.signal}`);
 				} else {
-					this.onError(`terminated by itself unexpectedly with code ${reason?.code}, signal: ${reason?.signal}`);
+					this.onError(`terminated by itself unexpectedly with code ${reason?.code}, signal: ${reason?.signal} (ETERM)`);
 				}
 			});