pass the telemtry properties through the config

Author: nirinchev

src/telemetry/telemetry.ts

@@ -14,11 +14,6 @@ type EventResult = {
 };
 
 export class Telemetry {
-    public static baseCommonProperties: CommonProperties = {
-        ...MACHINE_METADATA,
-        hosting_mode: "standalone",
-    };
-
     private isBufferingEvents: boolean = true;
     /** Resolves when the setup is complete or a timeout occurs */
     public setupPromise: Promise<[string, boolean]> | undefined;
@@ -40,14 +35,21 @@ export class Telemetry {
         userConfig: UserConfig,
         deviceId: DeviceId,
         {
-            commonProperties = this.baseCommonProperties,
+            commonProperties = {},
             eventCache = EventCache.getInstance(),
         }: {
+            commonProperties?: Partial<CommonProperties>;
             eventCache?: EventCache;
-            commonProperties?: CommonProperties;
         } = {}
     ): Telemetry {
-        const instance = new Telemetry(session, userConfig, commonProperties, { eventCache, deviceId });
+        const mergedProperties = {
+            ...MACHINE_METADATA,
+            ...commonProperties,
+        };
+        const instance = new Telemetry(session, userConfig, mergedProperties, {
+            eventCache,
+            deviceId,
+        });
 
         void instance.setup();
         return instance;

src/transports/base.ts

@@ -13,12 +13,14 @@ import {
     type ConnectionErrorHandler,
     connectionErrorHandler as defaultConnectionErrorHandler,
 } from "../common/connectionErrorHandler.js";
+import type { CommonProperties } from "../telemetry/types.js";
 
 export type TransportRunnerConfig = {
     userConfig: UserConfig;
     createConnectionManager?: ConnectionManagerFactoryFn;
     connectionErrorHandler?: ConnectionErrorHandler;
     additionalLoggers?: LoggerBase[];
+    telemetryProperties?: Partial<CommonProperties>;
 };
 
 export abstract class TransportRunnerBase {
@@ -27,16 +29,19 @@ export abstract class TransportRunnerBase {
     protected readonly userConfig: UserConfig;
     private readonly createConnectionManager: ConnectionManagerFactoryFn;
     private readonly connectionErrorHandler: ConnectionErrorHandler;
+    private readonly telemetryProperties: Partial<CommonProperties>;
 
     protected constructor({
         userConfig,
         createConnectionManager = createMCPConnectionManager,
         connectionErrorHandler = defaultConnectionErrorHandler,
         additionalLoggers = [],
+        telemetryProperties = {},
     }: TransportRunnerConfig) {
         this.userConfig = userConfig;
         this.createConnectionManager = createConnectionManager;
         this.connectionErrorHandler = connectionErrorHandler;
+        this.telemetryProperties = telemetryProperties;
         const loggers: LoggerBase[] = [...additionalLoggers];
         if (this.userConfig.loggers.includes("stderr")) {
             loggers.push(new ConsoleLogger());
@@ -79,7 +84,9 @@ export abstract class TransportRunnerBase {
             connectionManager,
         });
 
-        const telemetry = Telemetry.create(session, this.userConfig, this.deviceId);
+        const telemetry = Telemetry.create(session, this.userConfig, this.deviceId, {
+            commonProperties: this.telemetryProperties,
+        });
 
         const result = new Server({
             mcpServer,

tests/integration/transports/streamableHttp.test.ts

@@ -1,7 +1,7 @@
 import { StreamableHttpRunner } from "../../../src/transports/streamableHttp.js";
 import { Client } from "@modelcontextprotocol/sdk/client/index.js";
 import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
-import { describe, expect, it, beforeAll, afterAll, beforeEach } from "vitest";
+import { describe, expect, it, beforeAll, afterAll, beforeEach, afterEach } from "vitest";
 import { config } from "../../../src/common/config.js";
 import type { LoggerType, LogLevel, LogPayload } from "../../../src/common/logger.js";
 import { LoggerBase, LogId } from "../../../src/common/logger.js";
@@ -158,4 +158,26 @@ describe("StreamableHttpRunner", () => {
             expect(serverStartedMessage?.level).toBe("info");
         });
     });
+
+    describe("with telemetry properties", () => {
+        afterEach(async () => {
+            await runner.close();
+            config.telemetry = oldTelemetry;
+            config.loggers = oldLoggers;
+            config.httpHeaders = {};
+        });
+
+        it("merges them with the base properties", async () => {
+            config.telemetry = "enabled";
+            runner = new StreamableHttpRunner({
+                userConfig: config,
+                telemetryProperties: { hosting_mode: "vscode-extension" },
+            });
+            await runner.start();
+
+            const server = await runner["setupServer"]();
+            const properties = server["telemetry"].getCommonProperties();
+            expect(properties.hosting_mode).toBe("vscode-extension");
+        });
+    });
 });

tests/unit/telemetry.test.ts

@@ -214,12 +214,9 @@ describe("Telemetry", () => {
         });
 
         it("should add hostingMode to events if set", async () => {
-            Telemetry.baseCommonProperties = {
-                ...Telemetry.baseCommonProperties,
-                hosting_mode: "vscode-extension",
-            };
             telemetry = Telemetry.create(session, config, mockDeviceId, {
                 eventCache: mockEventCache as unknown as EventCache,
+                commonProperties: { hosting_mode: "vscode-extension" },
             });
             await telemetry.setupPromise;