@sussudio/platform/telemetry/common/telemetry.d.mts

Internal APIs for VS Code's service injection the base services.

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { ClassifiedEvent, IGDPRProperty, OmitMetadata, StrictPropertyCheck } from './gdprTypings.mjs';
export declare const ITelemetryService: import('../../instantiation/common/instantiation.mjs').ServiceIdentifier<ITelemetryService>;
export interface ITelemetryInfo {
	sessionId: string;
	machineId: string;
	firstSessionDate: string;
	msftInternal?: boolean;
}
export interface ITelemetryData {
	from?: string;
	target?: string;
	[key: string]: any;
}
export interface ITelemetryService {
	/**
	 * Whether error telemetry will get sent. If false, `publicLogError` will no-op.
	 */
	readonly sendErrorTelemetry: boolean;
	readonly _serviceBrand: undefined;
	/**
	 * @deprecated Use publicLog2 and the typescript GDPR annotation where possible
	 */
	publicLog(eventName: string, data?: ITelemetryData): Promise<void>;
	/**
	 * Sends a telemetry event that has been privacy approved.
	 * Do not call this unless you have been given approval.
	 */
	publicLog2<E extends ClassifiedEvent<OmitMetadata<T>> = never, T extends IGDPRProperty = never>(
		eventName: string,
		data?: StrictPropertyCheck<T, E>,
	): Promise<void>;
	/**
	 * @deprecated Use publicLogError2 and the typescript GDPR annotation where possible
	 */
	publicLogError(errorEventName: string, data?: ITelemetryData): Promise<void>;
	publicLogError2<E extends ClassifiedEvent<OmitMetadata<T>> = never, T extends IGDPRProperty = never>(
		eventName: string,
		data?: StrictPropertyCheck<T, E>,
	): Promise<void>;
	getTelemetryInfo(): Promise<ITelemetryInfo>;
	setExperimentProperty(name: string, value: string): void;
	readonly telemetryLevel: TelemetryLevel;
}
export interface ITelemetryEndpoint {
	id: string;
	aiKey: string;
	sendErrorTelemetry: boolean;
}
export declare const ICustomEndpointTelemetryService: import('../../instantiation/common/instantiation.mjs').ServiceIdentifier<ICustomEndpointTelemetryService>;
export interface ICustomEndpointTelemetryService {
	readonly _serviceBrand: undefined;
	publicLog(endpoint: ITelemetryEndpoint, eventName: string, data?: ITelemetryData): Promise<void>;
	publicLogError(endpoint: ITelemetryEndpoint, errorEventName: string, data?: ITelemetryData): Promise<void>;
}
export declare const currentSessionDateStorageKey = 'telemetry.currentSessionDate';
export declare const firstSessionDateStorageKey = 'telemetry.firstSessionDate';
export declare const lastSessionDateStorageKey = 'telemetry.lastSessionDate';
export declare const machineIdKey = 'telemetry.machineId';
export declare const TELEMETRY_SECTION_ID = 'telemetry';
export declare const TELEMETRY_SETTING_ID = 'telemetry.telemetryLevel';
export declare const TELEMETRY_CRASH_REPORTER_SETTING_ID = 'telemetry.enableCrashReporter';
export declare const TELEMETRY_OLD_SETTING_ID = 'telemetry.enableTelemetry';
export declare const enum TelemetryLevel {
	NONE = 0,
	CRASH = 1,
	ERROR = 2,
	USAGE = 3,
}
export declare const enum TelemetryConfiguration {
	OFF = 'off',
	CRASH = 'crash',
	ERROR = 'error',
	ON = 'all',
}