1
>
/*---------------------------------------------------------------------------------------------
telemetryService.ts
2
>
* Copyright (c) Microsoft Corporation. All rights reserved.
3
>
* Licensed under the MIT License. See License.txt in the project root for license information.
4
>
*--------------------------------------------------------------------------------------------*/
5
>
6
>
import { DisposableStore } from '../../../base/common/lifecycle.js';
7
>
import { mixin } from '../../../base/common/objects.js';
8
>
import { isWeb } from '../../../base/common/platform.js';
9
>
import { PolicyCategory } from '../../../base/common/policy.js';
10
>
import { escapeRegExpCharacters } from '../../../base/common/strings.js';
11
>
import { localize } from '../../../nls.js';
12
>
import { IConfigurationService } from '../../configuration/common/configuration.js';
13
>
import { ConfigurationScope, Extensions, IConfigurationRegistry } from '../../configuration/common/configurationRegistry.js';
14
>
import { IMeteredConnectionService } from '../../meteredConnection/common/meteredConnection.js';
15
>
import product from '../../product/common/product.js';
16
>
import { IProductService } from '../../product/common/productService.js';
17
>
import { Registry } from '../../registry/common/platform.js';
18
>
import { ClassifiedEvent, IGDPRProperty, OmitMetadata, StrictPropertyCheck } from './gdprTypings.js';
19
>
import { ITelemetryData, ITelemetryService, TelemetryConfiguration, TelemetryLevel, TELEMETRY_CRASH_REPORTER_SETTING_ID, TELEMETRY_OLD_SETTING_ID, TELEMETRY_SECTION_ID, TELEMETRY_SETTING_ID, ICommonProperties } from './telemetry.js';
20
>
import { cleanData, getTelemetryLevel, ITelemetryAppender, TelemetryTrustedValue } from './telemetryUtils.js';
21
>
22
>
export interface ITelemetryServiceConfig {
23
>
appenders: ITelemetryAppender[];
24
>
sendErrorTelemetry?: boolean;
25
>
commonProperties?: ICommonProperties;
26
>
piiPaths?: string[];
27
>
/**
28
>
* If true, telemetry events will be buffered until setExperimentProperty is called
29
>
* (up to 10 seconds) to ensure experiment context is attached to all events.
30
>
*/
31
>
waitForExperimentProperties?: boolean;
32
>
/**
33
>
* If provided, telemetry events will be dropped when the connection is metered.
34
>
*/
35
>
meteredConnectionService?: IMeteredConnectionService;
36
>
}
37
>
38
>
interface IPendingEvent {
39
>
eventName: string;
40
>
eventLevel: TelemetryLevel;
41
>
data: ITelemetryData | undefined;
42
>
}
43
>
44
>
export class TelemetryService implements ITelemetryService {
45
>
46
>
static readonly IDLE_START_EVENT_NAME = 'UserIdleStart';
47
>
static readonly IDLE_STOP_EVENT_NAME = 'UserIdleStop';
48
>
49
>
private static readonly BUFFER_FLUSH_TIMEOUT = 10000; // 10 seconds
50
>
private static readonly MAX_BUFFER_SIZE = 1000;
51
>
52
>
declare readonly _serviceBrand: undefined;
53
>
54
>
readonly sessionId: string;
55
>
readonly machineId: string;
56
>
readonly sqmId: string;
57
>
readonly devDeviceId: string;
58
>
readonly firstSessionDate: string;
59
>
readonly msftInternal: boolean | undefined;
60
>
61
>
private _appenders: ITelemetryAppender[];
62
>
private _commonProperties: ICommonProperties;
63
>
private _experimentProperties: { [name: string]: string | TelemetryTrustedValue<string> } = {};
64
>
private _piiPaths: string[];
65
>
private _telemetryLevel: TelemetryLevel;
66
>
private _sendErrorTelemetry: boolean;
67
>
68
>
private readonly _meteredConnectionService: IMeteredConnectionService | undefined;
69
>
70
>
private _pendingEvents: IPendingEvent[] = [];
71
>
private _isExperimentPropertySet = false;
72
>
private _flushTimeout: ReturnType<typeof setTimeout> | undefined;
73
>
74
>
private readonly _disposables = new DisposableStore();
75
>
private _cleanupPatterns: RegExp[] = [];
76
>
77
>
constructor(
78
config: ITelemetryServiceConfig,
79
@IConfigurationService private _configurationService: IConfigurationService,