Compound view for all telemetry with supporting source filters (microsoft#238090)

Author: sandy081

src/vs/platform/telemetry/common/telemetryLogAppender.ts

@@ -8,7 +8,7 @@ import { localize } from '../../../nls.js';
 import { IEnvironmentService } from '../../environment/common/environment.js';
 import { ILogService, ILogger, ILoggerService, LogLevel } from '../../log/common/log.js';
 import { IProductService } from '../../product/common/productService.js';
-import { ITelemetryAppender, isLoggingOnly, supportsTelemetry, telemetryLogId, validateTelemetryData } from './telemetryUtils.js';
+import { ITelemetryAppender, TelemetryLogGroup, isLoggingOnly, supportsTelemetry, telemetryLogId, validateTelemetryData } from './telemetryUtils.js';
 
 export class TelemetryLogAppender extends Disposable implements ITelemetryAppender {
 
@@ -31,10 +31,13 @@ export class TelemetryLogAppender extends Disposable implements ITelemetryAppend
 			const justLoggingAndNotSending = isLoggingOnly(productService, environmentService);
 			const logSuffix = justLoggingAndNotSending ? ' (Not Sent)' : '';
 			const isVisible = () => supportsTelemetry(productService, environmentService) && logService.getLevel() === LogLevel.Trace;
-			this.logger = this._register(loggerService.createLogger(telemetryLogId, { name: localize('telemetryLog', "Telemetry{0}", logSuffix), hidden: !isVisible() }));
+			this.logger = this._register(loggerService.createLogger(telemetryLogId,
+				{
+					name: localize('telemetryLog', "Telemetry{0}", logSuffix),
+					hidden: !isVisible(),
+					group: TelemetryLogGroup
+				}));
 			this._register(logService.onDidChangeLogLevel(() => loggerService.setVisibility(telemetryLogId, isVisible())));
-			this.logger.info('Below are logs for every telemetry event sent from VS Code once the log level is set to trace.');
-			this.logger.info('===========================================================');
 		}
 	}
 

src/vs/platform/telemetry/common/telemetryUtils.ts

@@ -6,8 +6,10 @@
 import { cloneAndChange, safeStringify } from '../../../base/common/objects.js';
 import { isObject } from '../../../base/common/types.js';
 import { URI } from '../../../base/common/uri.js';
+import { localize } from '../../../nls.js';
 import { IConfigurationService } from '../../configuration/common/configuration.js';
 import { IEnvironmentService } from '../../environment/common/environment.js';
+import { LoggerGroup } from '../../log/common/log.js';
 import { IProductService } from '../../product/common/productService.js';
 import { getRemoteName } from '../../remote/common/remoteHosts.js';
 import { verifyMicrosoftInternalDomain } from './commonProperties.js';
@@ -56,6 +58,7 @@ export class NullEndpointTelemetryService implements ICustomEndpointTelemetrySer
 
 export const telemetryLogId = 'telemetry';
 export const extensionTelemetryLogChannelId = 'extensionTelemetryLog';
+export const TelemetryLogGroup: LoggerGroup = { id: 'telemetry', name: localize('telemetryLogName', "Telemetry") };
 
 export interface ITelemetryAppender {
 	log(eventName: string, data: any): void;

src/vs/platform/telemetry/test/common/telemetryLogAppender.test.ts

@@ -93,7 +93,7 @@ suite('TelemetryLogAdapter', () => {
 		const testInstantiationService = new TestInstantiationService();
 		const testObject = new TelemetryLogAppender(new NullLogService(), testLoggerService, testInstantiationService.stub(IEnvironmentService, {}), testInstantiationService.stub(IProductService, {}));
 		testObject.log('testEvent', { hello: 'world', isTrue: true, numberBetween1And3: 2 });
-		assert.strictEqual(testLoggerService.createLogger().logs.length, 2);
+		assert.strictEqual(testLoggerService.createLogger().logs.length, 0);
 		testObject.dispose();
 		testInstantiationService.dispose();
 	});
@@ -103,7 +103,7 @@ suite('TelemetryLogAdapter', () => {
 		const testInstantiationService = new TestInstantiationService();
 		const testObject = new TelemetryLogAppender(new NullLogService(), testLoggerService, testInstantiationService.stub(IEnvironmentService, {}), testInstantiationService.stub(IProductService, {}));
 		testObject.log('testEvent', { hello: 'world', isTrue: true, numberBetween1And3: 2 });
-		assert.strictEqual(testLoggerService.createLogger().logs[2], 'telemetry/testEvent' + JSON.stringify([{
+		assert.strictEqual(testLoggerService.createLogger().logs[0], 'telemetry/testEvent' + JSON.stringify([{
 			properties: {
 				hello: 'world',
 			},

src/vs/workbench/api/common/extHostTelemetry.ts

@@ -13,7 +13,7 @@ import { IExtHostInitDataService } from './extHostInitDataService.js';
 import { ExtensionIdentifier, IExtensionDescription } from '../../../platform/extensions/common/extensions.js';
 import { UIKind } from '../../services/extensions/common/extensionHostProtocol.js';
 import { getRemoteName } from '../../../platform/remote/common/remoteHosts.js';
-import { cleanData, cleanRemoteAuthority, extensionTelemetryLogChannelId } from '../../../platform/telemetry/common/telemetryUtils.js';
+import { cleanData, cleanRemoteAuthority, extensionTelemetryLogChannelId, TelemetryLogGroup } from '../../../platform/telemetry/common/telemetryUtils.js';
 import { mixin } from '../../../base/common/objects.js';
 import { URI } from '../../../base/common/uri.js';
 import { Disposable } from '../../../base/common/lifecycle.js';
@@ -46,15 +46,19 @@ export class ExtHostTelemetry extends Disposable implements ExtHostTelemetryShap
 		super();
 		this.extHostTelemetryLogFile = URI.revive(this.initData.environment.extensionTelemetryLogResource);
 		this._inLoggingOnlyMode = this.initData.environment.isExtensionTelemetryLoggingOnly;
-		this._outputLogger = loggerService.createLogger(this.extHostTelemetryLogFile, { id: extensionTelemetryLogChannelId, name: localize('extensionTelemetryLog', "Extension Telemetry{0}", this._inLoggingOnlyMode ? ' (Not Sent)' : ''), hidden: true });
+		this._outputLogger = loggerService.createLogger(this.extHostTelemetryLogFile,
+			{
+				id: extensionTelemetryLogChannelId,
+				name: localize('extensionTelemetryLog', "Extension Telemetry{0}", this._inLoggingOnlyMode ? ' (Not Sent)' : ''),
+				hidden: true,
+				group: TelemetryLogGroup,
+			});
 		this._register(this._outputLogger);
 		this._register(loggerService.onDidChangeLogLevel(arg => {
 			if (isLogLevel(arg)) {
 				this.updateLoggerVisibility();
 			}
 		}));
-		this._outputLogger.info('Below are logs for extension telemetry events sent to the telemetry output channel API once the log level is set to trace.');
-		this._outputLogger.info('===========================================================');
 	}
 
 	private updateLoggerVisibility(): void {

src/vs/workbench/api/test/browser/extHostTelemetry.test.ts

@@ -286,11 +286,11 @@ suite('ExtHostTelemetry', function () {
 		const logger = createLogger(functionSpy, extensionTelemetry);
 
 		// Ensure headers are logged on instantiation
-		assert.strictEqual(loggerService.createLogger().logs.length, 2);
+		assert.strictEqual(loggerService.createLogger().logs.length, 0);
 
 		logger.logUsage('test-event', { 'test-data': 'test-data' });
 		// Initial header is logged then the event
-		assert.strictEqual(loggerService.createLogger().logs.length, 3);
-		assert.ok(loggerService.createLogger().logs[2].startsWith('test-extension/test-event'));
+		assert.strictEqual(loggerService.createLogger().logs.length, 1);
+		assert.ok(loggerService.createLogger().logs[0].startsWith('test-extension/test-event'));
 	});
 });