Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-30 13:31:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

More granular telemetry API (#141086)

Browse Source 
* Initial implementation of proposed telemetry API

* TelemetryDetails -> TelemetryConfiguration + proposed guards
This commit is contained in:
Logan Ramos
2022-01-20 13:34:03 -05:00
committed by GitHub
parent f36b3e7025
commit 4475ae1240
6 changed files with 83 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/vs/workbench/api/browser/mainThreadTelemetry.ts
View File

@@ -19,42 +19,34 @@ export class MainThreadTelemetry extends Disposable implements MainThreadTelemet
private static readonly _name = 'pluginHostTelemetry';
private _oldTelemetryEnabledValue: boolean | undefined;
constructor(
extHostContext: IExtHostContext,
@ITelemetryService private readonly _telemetryService: ITelemetryService,
@IConfigurationService private readonly _configurationService: IConfigurationService,
@IEnvironmentService private readonly _environmenService: IEnvironmentService,
@IEnvironmentService private readonly _environmentService: IEnvironmentService,
@IProductService private readonly _productService: IProductService
) {
super();
this._proxy = extHostContext.getProxy(ExtHostContext.ExtHostTelemetry);
if (supportsTelemetry(this._productService, this._environmenService)) {
if (supportsTelemetry(this._productService, this._environmentService)) {
this._register(this._configurationService.onDidChangeConfiguration(e => {
if (e.affectsConfiguration(TELEMETRY_SETTING_ID) || e.affectsConfiguration(TELEMETRY_OLD_SETTING_ID)) {
const telemetryEnabled = this.telemetryEnabled;
// Since changing telemetryLevel from "off" => "error" doesn't change the isEnabled state
// We shouldn't fire a change event
if (telemetryEnabled !== this._oldTelemetryEnabledValue) {
this._oldTelemetryEnabledValue = telemetryEnabled;
this._proxy.$onDidChangeTelemetryEnabled(this.telemetryEnabled);
}
this._proxy.$onDidChangeTelemetryLevel(this.telemetryLevel);
}
}));
}
this._proxy.$initializeTelemetryEnabled(this.telemetryEnabled);
this._proxy.$initializeTelemetryLevel(this.telemetryLevel);
}
private get telemetryEnabled(): boolean {
if (!supportsTelemetry(this._productService, this._environmenService)) {
return false;
private get telemetryLevel(): TelemetryLevel {
if (!supportsTelemetry(this._productService, this._environmentService)) {
return TelemetryLevel.NONE;
}
return getTelemetryLevel(this._configurationService) === TelemetryLevel.USAGE;
return getTelemetryLevel(this._configurationService);
}
$publicLog(eventName: string, data: any = Object.create(null)): void {

10
src/vs/workbench/api/common/extHost.api.impl.ts
View File

@@ -303,11 +303,19 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
return extHostTerminalService.getDefaultShell(false);
},
get isTelemetryEnabled() {
return extHostTelemetry.getTelemetryEnabled();
return extHostTelemetry.getTelemetryConfiguration();
},
get onDidChangeTelemetryEnabled(): Event<boolean> {
return extHostTelemetry.onDidChangeTelemetryEnabled;
},
get telemetryConfiguration(): vscode.TelemetryConfiguration {
checkProposedApiEnabled(extension, 'telemetry');
return extHostTelemetry.getTelemetryDetails();
},
get onDidChangeTelemetryConfiguration(): Event<vscode.TelemetryConfiguration> {
checkProposedApiEnabled(extension, 'telemetry');
return extHostTelemetry.onDidChangeTelemetryConfiguration;
},
get isNewAppInstall() {
const installAge = Date.now() - new Date(initData.telemetryInfo.firstSessionDate).getTime();
return isNaN(installAge) ? false : installAge < 1000 * 60 * 60 * 24; // install age is less than a day

6
src/vs/workbench/api/common/extHost.protocol.ts
View File

@@ -36,7 +36,7 @@ import * as quickInput from 'vs/platform/quickinput/common/quickInput';
import { IRemoteConnectionData, RemoteAuthorityResolverErrorCode, ResolverResult, TunnelDescription } from 'vs/platform/remote/common/remoteAuthorityResolver';
import { ProvidedPortAttributes, TunnelCreationOptions, TunnelOptions, TunnelProviderFeatures } from 'vs/platform/remote/common/tunnel';
import { ClassifiedEvent, GDPRClassification, StrictPropertyCheck } from 'vs/platform/telemetry/common/gdprTypings';
import { ITelemetryInfo } from 'vs/platform/telemetry/common/telemetry';
import { ITelemetryInfo, TelemetryLevel } from 'vs/platform/telemetry/common/telemetry';
import { ICreateContributedTerminalProfileOptions, IProcessProperty, IShellLaunchConfigDto, ITerminalEnvironment, ITerminalLaunchError, ITerminalProfile, TerminalLocation } from 'vs/platform/terminal/common/terminal';
import { ThemeColor, ThemeIcon } from 'vs/platform/theme/common/themeService';
import { IExtensionIdWithVersion } from 'vs/platform/extensionManagement/common/extensionStorage';
@@ -1723,8 +1723,8 @@ export interface ExtHostQuickOpenShape {
}
export interface ExtHostTelemetryShape {
$initializeTelemetryEnabled(enabled: boolean): void;
$onDidChangeTelemetryEnabled(enabled: boolean): void;
$initializeTelemetryLevel(level: TelemetryLevel): void;
$onDidChangeTelemetryLevel(level: TelemetryLevel): void;
}
export interface ITerminalLinkDto {

34
src/vs/workbench/api/common/extHostTelemetry.ts
View File

@@ -6,24 +6,42 @@
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
import { Event, Emitter } from 'vs/base/common/event';
import { ExtHostTelemetryShape } from 'vs/workbench/api/common/extHost.protocol';
import { TelemetryLevel } from 'vs/platform/telemetry/common/telemetry';
import type { TelemetryConfiguration } from 'vscode';
export class ExtHostTelemetry implements ExtHostTelemetryShape {
private readonly _onDidChangeTelemetryEnabled = new Emitter<boolean>();
readonly onDidChangeTelemetryEnabled: Event<boolean> = this._onDidChangeTelemetryEnabled.event;
private _enabled: boolean = false;
private readonly _onDidChangeTelemetryConfiguration = new Emitter<TelemetryConfiguration>();
readonly onDidChangeTelemetryConfiguration: Event<TelemetryConfiguration> = this._onDidChangeTelemetryConfiguration.event;
getTelemetryEnabled(): boolean {
return this._enabled;
private _level: TelemetryLevel = TelemetryLevel.NONE;
private _oldTelemetryEnablement: boolean | undefined;
getTelemetryConfiguration(): boolean {
return this._level === TelemetryLevel.USAGE;
}
$initializeTelemetryEnabled(enabled: boolean): void {
this._enabled = enabled;
getTelemetryDetails(): TelemetryConfiguration {
return {
isCrashEnabled: this._level >= TelemetryLevel.CRASH,
isErrorsEnabled: this._level >= TelemetryLevel.ERROR,
isUsageEnabled: this._level >= TelemetryLevel.USAGE
};
}
$onDidChangeTelemetryEnabled(enabled: boolean): void {
this._enabled = enabled;
this._onDidChangeTelemetryEnabled.fire(enabled);
$initializeTelemetryLevel(level: TelemetryLevel): void {
this._level = level;
}
$onDidChangeTelemetryLevel(level: TelemetryLevel): void {
this._oldTelemetryEnablement = this.getTelemetryConfiguration();
this._level = level;
if (this._oldTelemetryEnablement !== this.getTelemetryConfiguration()) {
this._onDidChangeTelemetryEnabled.fire(this.getTelemetryConfiguration());
}
this._onDidChangeTelemetryConfiguration.fire(this.getTelemetryDetails());
}
}