/*--------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All rights reserved. * Licensed under the MIT License. See License.txt in the project root for license information. *--------------------------------------------------------------------------------------------*/ import * as perf from 'vs/base/common/performance'; import { createDecorator } from 'vs/platform/instantiation/common/instantiation'; import { IWorkspaceContextService, WorkbenchState } from 'vs/platform/workspace/common/workspace'; import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions'; import { IUpdateService } from 'vs/platform/update/common/update'; import { ILifecycleService, LifecyclePhase } from 'vs/workbench/services/lifecycle/common/lifecycle'; import { IViewletService } from 'vs/workbench/services/viewlet/browser/viewlet'; import { IPanelService } from 'vs/workbench/services/panel/common/panelService'; import { IEditorService } from 'vs/workbench/services/editor/common/editorService'; import { IAccessibilityService } from 'vs/platform/accessibility/common/accessibility'; import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry'; /* __GDPR__FRAGMENT__ "IMemoryInfo" : { "workingSetSize" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "privateBytes": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "sharedBytes": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true } } */ export interface IMemoryInfo { readonly workingSetSize: number; readonly privateBytes: number; readonly sharedBytes: number; } /* __GDPR__FRAGMENT__ "IStartupMetrics" : { "version" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "ellapsed" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "isLatestVersion": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "didUseCachedData": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "windowKind": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "windowCount": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "viewletId": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "panelId": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "editorIds": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "timers.ellapsedAppReady" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedWindowLoad" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedWindowLoadToRequire" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedExtensions" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedExtensionsReady" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedRequire" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedWorkspaceStorageInit" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedWorkspaceServiceInit" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedViewletRestore" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedPanelRestore" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedEditorRestore" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedWorkbench" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedTimersToTimersComputed" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "timers.ellapsedNlsGeneration" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "platform" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "release" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "arch" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "totalmem" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "freemem" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "meminfo" : { "${inline}": [ "${IMemoryInfo}" ] }, "cpus.count" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "cpus.speed" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "cpus.model" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" }, "initialStartup" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "hasAccessibilitySupport" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "isVMLikelyhood" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "emptyWorkbench" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth", "isMeasurement": true }, "loadavg" : { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" } } */ export interface IStartupMetrics { /** * The version of these metrics. */ readonly version: 2; /** * If this started the main process and renderer or just a renderer (new or reloaded). */ readonly initialStartup: boolean; /** * No folder, no file, no workspace has been opened */ readonly emptyWorkbench: boolean; /** * This is the latest (stable/insider) version. Iff not we should ignore this * measurement. */ readonly isLatestVersion: boolean; /** * Whether we asked for and V8 accepted cached data. */ readonly didUseCachedData: boolean; /** * How/why the window was created. See https://github.com/microsoft/vscode/blob/d1f57d871722f4d6ba63e4ef6f06287121ceb045/src/vs/platform/lifecycle/common/lifecycle.ts#L50 */ readonly windowKind: number; /** * The total number of windows that have been restored/created */ readonly windowCount: number; /** * The active viewlet id or `undedined` */ readonly viewletId?: string; /** * The active panel id or `undefined` */ readonly panelId?: string; /** * The editor input types or `[]` */ readonly editorIds: string[]; /** * The time it took to create the workbench. * * * Happens in the main-process *and* the renderer-process * * Measured with the *start* and `didStartWorkbench`-performance mark. The *start* is either the start of the * main process or the start of the renderer. * * This should be looked at carefully because times vary depending on * * This being the first window, the only window, or a reloaded window * * Cached data being present and used or not * * The numbers and types of editors being restored * * The numbers of windows being restored (when starting 'fresh') * * The viewlet being restored (esp. when it's a contributed viewlet) */ readonly ellapsed: number; /** * Individual timers... */ readonly timers: { /** * The time it took to receieve the [`ready`](https://electronjs.org/docs/api/app#event-ready)-event. Measured from the first line * of JavaScript code till receiving that event. * * * Happens in the main-process * * Measured with the `main:started` and `main:appReady` performance marks. * * This can be compared between insider and stable builds. * * This should be looked at per OS version and per electron version. * * This is often affected by AV software (and can change with AV software updates outside of our release-cycle). * * It is not our code running here and we can only observe what's happening. */ readonly ellapsedAppReady?: number; /** * The time it took to generate NLS data. * * * Happens in the main-process * * Measured with the `nlsGeneration:start` and `nlsGeneration:end` performance marks. * * This only happens when a non-english locale is being used. * * It is our code running here and we should monitor this carefully for regressions. */ readonly ellapsedNlsGeneration?: number; /** * The time it took to tell electron to open/restore a renderer (browser window). * * * Happens in the main-process * * Measured with the `main:appReady` and `main:loadWindow` performance marks. * * This can be compared between insider and stable builds. * * It is our code running here and we should monitor this carefully for regressions. */ readonly ellapsedWindowLoad?: number; /** * The time it took to create a new renderer (browser window) and to initialize that to the point * of load the main-bundle (`workbench.desktop.main.js`). * * * Happens in the main-process *and* the renderer-process * * Measured with the `main:loadWindow` and `willLoadWorkbenchMain` performance marks. * * This can be compared between insider and stable builds. * * It is mostly not our code running here and we can only observe what's happening. * */ readonly ellapsedWindowLoadToRequire: number; /** * The time it took to wait for resolving the shell environment. This time the workbench * will not continue to load and be blocked entirely. * * * Happens in the renderer-process * * Measured with the `willWaitForShellEnv` and `didWaitForShellEnv` performance marks. */ readonly ellapsedWaitForShellEnv: number; /** * The time it took to require the workspace storage DB, connect to it * and load the initial set of values. * * * Happens in the renderer-process * * Measured with the `willInitWorkspaceStorage` and `didInitWorkspaceStorage` performance marks. */ readonly ellapsedWorkspaceStorageInit: number; /** * The time it took to initialize the workspace and configuration service. * * * Happens in the renderer-process * * Measured with the `willInitWorkspaceService` and `didInitWorkspaceService` performance marks. */ readonly ellapsedWorkspaceServiceInit: number; /** * The time it took to load the main-bundle of the workbench, e.g. `workbench.desktop.main.js`. * * * Happens in the renderer-process * * Measured with the `willLoadWorkbenchMain` and `didLoadWorkbenchMain` performance marks. * * This varies *a lot* when V8 cached data could be used or not * * This should be looked at with and without V8 cached data usage and per electron/v8 version * * This is affected by the size of our code bundle (which grows about 3-5% per release) */ readonly ellapsedRequire: number; /** * The time it took to read extensions' package.json-files *and* interpret them (invoking * the contribution points). * * * Happens in the renderer-process * * Measured with the `willLoadExtensions` and `didLoadExtensions` performance marks. * * Reading of package.json-files is avoided by caching them all in a single file (after the read, * until another extension is installed) * * Happens in parallel to other things, depends on async timing */ readonly ellapsedExtensions: number; // the time from start till `didLoadExtensions` // remove? readonly ellapsedExtensionsReady: number; /** * The time it took to restore the viewlet. * * * Happens in the renderer-process * * Measured with the `willRestoreViewlet` and `didRestoreViewlet` performance marks. * * This should be looked at per viewlet-type/id. * * Happens in parallel to other things, depends on async timing */ readonly ellapsedViewletRestore: number; /** * The time it took to restore the panel. * * * Happens in the renderer-process * * Measured with the `willRestorePanel` and `didRestorePanel` performance marks. * * This should be looked at per panel-type/id. * * Happens in parallel to other things, depends on async timing */ readonly ellapsedPanelRestore: number; /** * The time it took to restore editors - that is text editor and complex editor likes the settings UI * or webviews (markdown preview). * * * Happens in the renderer-process * * Measured with the `willRestoreEditors` and `didRestoreEditors` performance marks. * * This should be looked at per editor and per editor type. * * Happens in parallel to other things, depends on async timing */ readonly ellapsedEditorRestore: number; /** * The time it took to create the workbench. * * * Happens in the renderer-process * * Measured with the `willStartWorkbench` and `didStartWorkbench` performance marks. */ readonly ellapsedWorkbench: number; /** * This time it took inside the renderer to start the workbench. * * * Happens in the renderer-process * * Measured with the `renderer/started` and `didStartWorkbench` performance marks */ readonly ellapsedRenderer: number; // the time it took to generate this object. // remove? readonly ellapsedTimersToTimersComputed: number; }; readonly hasAccessibilitySupport: boolean; readonly isVMLikelyhood?: number; readonly platform?: string; readonly release?: string; readonly arch?: string; readonly totalmem?: number; readonly freemem?: number; readonly meminfo?: IMemoryInfo; readonly cpus?: { count: number; speed: number; model: string; }; readonly loadavg?: number[]; } export interface ITimerService { readonly _serviceBrand: undefined; readonly startupMetrics: Promise; } export const ITimerService = createDecorator('timerService'); export type Writeable = { -readonly [P in keyof T]: Writeable }; export abstract class AbstractTimerService implements ITimerService { declare readonly _serviceBrand: undefined; private readonly _startupMetrics: Promise; constructor( @ILifecycleService private readonly _lifecycleService: ILifecycleService, @IWorkspaceContextService private readonly _contextService: IWorkspaceContextService, @IExtensionService private readonly _extensionService: IExtensionService, @IUpdateService private readonly _updateService: IUpdateService, @IViewletService private readonly _viewletService: IViewletService, @IPanelService private readonly _panelService: IPanelService, @IEditorService private readonly _editorService: IEditorService, @IAccessibilityService private readonly _accessibilityService: IAccessibilityService, @ITelemetryService private readonly _telemetryService: ITelemetryService, ) { this._startupMetrics = Promise.all([ this._extensionService.whenInstalledExtensionsRegistered(), _lifecycleService.when(LifecyclePhase.Restored) ]) .then(() => this._computeStartupMetrics()) .then(metrics => { this._reportStartupTimes(metrics); return metrics; }); } get startupMetrics(): Promise { return this._startupMetrics; } private _reportStartupTimes(metrics: IStartupMetrics): void { // report IStartupMetrics as telemetry /* __GDPR__ "startupTimeVaried" : { "${include}": [ "${IStartupMetrics}" ] } */ this._telemetryService.publicLog('startupTimeVaried', metrics); // report raw timers as telemetry const entries: Record = Object.create(null); for (const entry of perf.getEntries()) { entries[entry.name] = entry.startTime; } /* __GDPR__ "startupRawTimers" : { "entries": { "classification": "SystemMetaData", "purpose": "PerformanceAndHealth" } } */ this._telemetryService.publicLog('startupRawTimers', { entries }); } private async _computeStartupMetrics(): Promise { const now = Date.now(); const initialStartup = this._isInitialStartup(); const startMark = initialStartup ? 'main:started' : 'main:loadWindow'; const activeViewlet = this._viewletService.getActiveViewlet(); const activePanel = this._panelService.getActivePanel(); const info: Writeable = { version: 2, ellapsed: perf.getDuration(startMark, 'didStartWorkbench'), // reflections isLatestVersion: Boolean(await this._updateService.isLatestVersion()), didUseCachedData: this._didUseCachedData(), windowKind: this._lifecycleService.startupKind, windowCount: await this._getWindowCount(), viewletId: activeViewlet?.getId(), editorIds: this._editorService.visibleEditors.map(input => input.getTypeId()), panelId: activePanel ? activePanel.getId() : undefined, // timers timers: { ellapsedAppReady: initialStartup ? perf.getDuration('main:started', 'main:appReady') : undefined, ellapsedNlsGeneration: initialStartup ? perf.getDuration('nlsGeneration:start', 'nlsGeneration:end') : undefined, ellapsedWindowLoad: initialStartup ? perf.getDuration('main:appReady', 'main:loadWindow') : undefined, ellapsedWindowLoadToRequire: perf.getDuration('main:loadWindow', 'willLoadWorkbenchMain'), ellapsedRequire: perf.getDuration('willLoadWorkbenchMain', 'didLoadWorkbenchMain'), ellapsedWaitForShellEnv: perf.getDuration('willWaitForShellEnv', 'didWaitForShellEnv'), ellapsedWorkspaceStorageInit: perf.getDuration('willInitWorkspaceStorage', 'didInitWorkspaceStorage'), ellapsedWorkspaceServiceInit: perf.getDuration('willInitWorkspaceService', 'didInitWorkspaceService'), ellapsedExtensions: perf.getDuration('willLoadExtensions', 'didLoadExtensions'), ellapsedEditorRestore: perf.getDuration('willRestoreEditors', 'didRestoreEditors'), ellapsedViewletRestore: perf.getDuration('willRestoreViewlet', 'didRestoreViewlet'), ellapsedPanelRestore: perf.getDuration('willRestorePanel', 'didRestorePanel'), ellapsedWorkbench: perf.getDuration('willStartWorkbench', 'didStartWorkbench'), ellapsedExtensionsReady: perf.getDuration(startMark, 'didLoadExtensions'), ellapsedRenderer: perf.getDuration('renderer/started', 'didStartWorkbench'), ellapsedTimersToTimersComputed: Date.now() - now, }, // system info platform: undefined, release: undefined, arch: undefined, totalmem: undefined, freemem: undefined, meminfo: undefined, cpus: undefined, loadavg: undefined, isVMLikelyhood: undefined, initialStartup, hasAccessibilitySupport: this._accessibilityService.isScreenReaderOptimized(), emptyWorkbench: this._contextService.getWorkbenchState() === WorkbenchState.EMPTY }; await this._extendStartupInfo(info); return info; } protected abstract _isInitialStartup(): boolean; protected abstract _didUseCachedData(): boolean; protected abstract _getWindowCount(): Promise; protected abstract _extendStartupInfo(info: Writeable): Promise; } export class TimerService extends AbstractTimerService { protected _isInitialStartup(): boolean { return false; } protected _didUseCachedData(): boolean { return false; } protected async _getWindowCount(): Promise { return 1; } protected async _extendStartupInfo(info: Writeable): Promise { info.isVMLikelyhood = 0; info.platform = navigator.userAgent; info.release = navigator.appVersion; } }