Add telemetry comments (#155503)

* add telemetry comments

* update comments
This commit is contained in:
João Moreno 2022-07-18 16:44:01 +02:00 committed by GitHub
parent 4b0d6f3bbc
commit f127c6cf28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 11 additions and 6 deletions

View file

@ -20,7 +20,8 @@ export function createUpdateURL(platform: string, quality: string, productServic
export type UpdateNotAvailableClassification = {
owner: 'joaomoreno';
explicit: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; isMeasurement: true };
explicit: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; isMeasurement: true; comment: 'Whether the user has manually checked for updates, or this was an automatic check.' };
comment: 'This is used to understand how often VS Code pings the update server for an update and there\'s none available.';
};
export abstract class AbstractUpdateService implements IUpdateService {

View file

@ -93,7 +93,8 @@ export class DarwinUpdateService extends AbstractUpdateService {
type UpdateDownloadedClassification = {
owner: 'joaomoreno';
version: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
version: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The version number of the new VS Code that has been downloaded.' };
comment: 'This is used to know how often VS Code has successfully downloaded the update.';
};
this.telemetryService.publicLog2<{ version: String }, UpdateDownloadedClassification>('update:downloaded', { version: update.version });

View file

@ -745,7 +745,8 @@ export class ExtHostSCM implements ExtHostSCMShape {
type TEvent = { extensionId: string };
type TMeta = {
owner: 'joaomoreno';
extensionId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
extensionId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The ID of the extension contributing to the Source Control API.' };
comment: 'This is used to know what extensions contribute to the Source Control API.';
};
this._telemetry.$publicLog2<TEvent, TMeta>('api/scm/createSourceControl', {
extensionId: extension.identifier.value,

View file

@ -52,8 +52,9 @@ export interface IViewPaneOptions extends IPaneOptions {
type WelcomeActionClassification = {
owner: 'joaomoreno';
viewId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
uri: { classification: 'SystemMetaData'; purpose: 'FeatureInsight' };
viewId: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The view ID in which the welcome view button was clicked.' };
uri: { classification: 'SystemMetaData'; purpose: 'FeatureInsight'; comment: 'The URI of the command ran by the result of clicking the button.' };
comment: 'This is used to know when users click on the welcome view buttons.';
};
const viewPaneContainerExpandedIcon = registerIcon('view-pane-container-expanded', Codicon.chevronDown, nls.localize('viewPaneContainerExpandedIcon', 'Icon for an expanded view pane container.'));

View file

@ -83,7 +83,8 @@ export interface ExtensionUrlHandlerEvent {
export interface ExtensionUrlHandlerClassification extends GDPRClassification<ExtensionUrlHandlerEvent> {
owner: 'joaomoreno';
readonly extensionId: { classification: 'PublicNonPersonalData'; purpose: 'FeatureInsight' };
readonly extensionId: { classification: 'PublicNonPersonalData'; purpose: 'FeatureInsight'; comment: 'The ID of the extension that should handle the URI' };
comment: 'This is used to understand the drop funnel of extension URI handling by the OS & VS Code.';
}
/**