chore: add is_container_env to telemetry MCP-2 (#298)

fmenezes · web-flow · commit 96c8f62be284 · 2025-06-19T17:46:39.000Z
diff --git a/src/logger.ts b/src/logger.ts
@@ -25,6 +25,7 @@ export const LogId = {
     telemetryMetadataError: mongoLogId(1_002_005),
     telemetryDeviceIdFailure: mongoLogId(1_002_006),
     telemetryDeviceIdTimeout: mongoLogId(1_002_007),
+    telemetryContainerEnvFailure: mongoLogId(1_002_008),
 
     toolExecute: mongoLogId(1_003_001),
     toolExecuteFailure: mongoLogId(1_003_002),
diff --git a/src/server.ts b/src/server.ts
@@ -130,7 +130,7 @@ export class Server {
             }
         }
 
-        this.telemetry.emitEvents([event]).catch(() => {});
+        this.telemetry.emitEvents([event]);
     }
 
     private registerTools() {
diff --git a/src/telemetry/telemetry.ts b/src/telemetry/telemetry.ts
@@ -7,114 +7,152 @@ import { MACHINE_METADATA } from "./constants.js";
 import { EventCache } from "./eventCache.js";
 import nodeMachineId from "node-machine-id";
 import { getDeviceId } from "@mongodb-js/device-id";
+import fs from "fs/promises";
+
+async function fileExists(filePath: string): Promise<boolean> {
+    try {
+        await fs.access(filePath, fs.constants.F_OK);
+        return true; // File exists
+    } catch (e: unknown) {
+        if (
+            e instanceof Error &&
+            (
+                e as Error & {
+                    code: string;
+                }
+            ).code === "ENOENT"
+        ) {
+            return false; // File does not exist
+        }
+        throw e; // Re-throw unexpected errors
+    }
+}
 
-type EventResult = {
-    success: boolean;
-    error?: Error;
-};
+async function isContainerized(): Promise<boolean> {
+    if (process.env.container) {
+        return true;
+    }
+
+    const exists = await Promise.all(["/.dockerenv", "/run/.containerenv", "/var/run/.containerenv"].map(fileExists));
 
-export const DEVICE_ID_TIMEOUT = 3000;
+    return exists.includes(true);
+}
 
 export class Telemetry {
-    private isBufferingEvents: boolean = true;
-    /** Resolves when the device ID is retrieved or timeout occurs */
-    public deviceIdPromise: Promise<string> | undefined;
     private deviceIdAbortController = new AbortController();
     private eventCache: EventCache;
     private getRawMachineId: () => Promise<string>;
+    private getContainerEnv: () => Promise<boolean>;
+    private cachedCommonProperties?: CommonProperties;
+    private flushing: boolean = false;
 
     private constructor(
         private readonly session: Session,
         private readonly userConfig: UserConfig,
-        private readonly commonProperties: CommonProperties,
-        { eventCache, getRawMachineId }: { eventCache: EventCache; getRawMachineId: () => Promise<string> }
+        {
+            eventCache,
+            getRawMachineId,
+            getContainerEnv,
+        }: {
+            eventCache: EventCache;
+            getRawMachineId: () => Promise<string>;
+            getContainerEnv: () => Promise<boolean>;
+        }
     ) {
         this.eventCache = eventCache;
         this.getRawMachineId = getRawMachineId;
+        this.getContainerEnv = getContainerEnv;
     }
 
     static create(
         session: Session,
         userConfig: UserConfig,
         {
-            commonProperties = { ...MACHINE_METADATA },
             eventCache = EventCache.getInstance(),
             getRawMachineId = () => nodeMachineId.machineId(true),
+            getContainerEnv = isContainerized,
         }: {
             eventCache?: EventCache;
             getRawMachineId?: () => Promise<string>;
-            commonProperties?: CommonProperties;
+            getContainerEnv?: () => Promise<boolean>;
         } = {}
     ): Telemetry {
-        const instance = new Telemetry(session, userConfig, commonProperties, { eventCache, getRawMachineId });
-
-        void instance.start();
-        return instance;
-    }
-
-    private async start(): Promise<void> {
-        if (!this.isTelemetryEnabled()) {
-            return;
-        }
-        this.deviceIdPromise = getDeviceId({
-            getMachineId: () => this.getRawMachineId(),
-            onError: (reason, error) => {
-                switch (reason) {
-                    case "resolutionError":
-                        logger.debug(LogId.telemetryDeviceIdFailure, "telemetry", String(error));
-                        break;
-                    case "timeout":
-                        logger.debug(LogId.telemetryDeviceIdTimeout, "telemetry", "Device ID retrieval timed out");
-                        break;
-                    case "abort":
-                        // No need to log in the case of aborts
-                        break;
-                }
-            },
-            abortSignal: this.deviceIdAbortController.signal,
+        const instance = new Telemetry(session, userConfig, {
+            eventCache,
+            getRawMachineId,
+            getContainerEnv,
         });
 
-        this.commonProperties.device_id = await this.deviceIdPromise;
-
-        this.isBufferingEvents = false;
+        return instance;
     }
 
     public async close(): Promise<void> {
         this.deviceIdAbortController.abort();
-        this.isBufferingEvents = false;
-        await this.emitEvents(this.eventCache.getEvents());
+        await this.flush();
     }
 
     /**
      * Emits events through the telemetry pipeline
      * @param events - The events to emit
      */
-    public async emitEvents(events: BaseEvent[]): Promise<void> {
-        try {
-            if (!this.isTelemetryEnabled()) {
-                logger.info(LogId.telemetryEmitFailure, "telemetry", `Telemetry is disabled.`);
-                return;
-            }
-
-            await this.emit(events);
-        } catch {
-            logger.debug(LogId.telemetryEmitFailure, "telemetry", `Error emitting telemetry events.`);
-        }
+    public emitEvents(events: BaseEvent[]): void {
+        void this.flush(events);
     }
 
     /**
      * Gets the common properties for events
      * @returns Object containing common properties for all events
      */
-    public getCommonProperties(): CommonProperties {
-        return {
-            ...this.commonProperties,
-            mcp_client_version: this.session.agentRunner?.version,
-            mcp_client_name: this.session.agentRunner?.name,
-            session_id: this.session.sessionId,
-            config_atlas_auth: this.session.apiClient.hasCredentials() ? "true" : "false",
-            config_connection_string: this.userConfig.connectionString ? "true" : "false",
-        };
+    private async getCommonProperties(): Promise<CommonProperties> {
+        if (!this.cachedCommonProperties) {
+            let deviceId: string | undefined;
+            let containerEnv: boolean | undefined;
+            try {
+                await Promise.all([
+                    getDeviceId({
+                        getMachineId: () => this.getRawMachineId(),
+                        onError: (reason, error) => {
+                            switch (reason) {
+                                case "resolutionError":
+                                    logger.debug(LogId.telemetryDeviceIdFailure, "telemetry", String(error));
+                                    break;
+                                case "timeout":
+                                    logger.debug(
+                                        LogId.telemetryDeviceIdTimeout,
+                                        "telemetry",
+                                        "Device ID retrieval timed out"
+                                    );
+                                    break;
+                                case "abort":
+                                    // No need to log in the case of aborts
+                                    break;
+                            }
+                        },
+                        abortSignal: this.deviceIdAbortController.signal,
+                    }).then((id) => {
+                        deviceId = id;
+                    }),
+                    this.getContainerEnv().then((env) => {
+                        containerEnv = env;
+                    }),
+                ]);
+            } catch (error: unknown) {
+                const err = error instanceof Error ? error : new Error(String(error));
+                logger.debug(LogId.telemetryDeviceIdFailure, "telemetry", err.message);
+            }
+            this.cachedCommonProperties = {
+                ...MACHINE_METADATA,
+                mcp_client_version: this.session.agentRunner?.version,
+                mcp_client_name: this.session.agentRunner?.name,
+                session_id: this.session.sessionId,
+                config_atlas_auth: this.session.apiClient.hasCredentials() ? "true" : "false",
+                config_connection_string: this.userConfig.connectionString ? "true" : "false",
+                is_container_env: containerEnv ? "true" : "false",
+                device_id: deviceId,
+            };
+        }
+
+        return this.cachedCommonProperties;
     }
 
     /**
@@ -135,60 +173,74 @@ export class Telemetry {
     }
 
     /**
-     * Attempts to emit events through authenticated and unauthenticated clients
+     * Attempts to flush events through authenticated and unauthenticated clients
      * Falls back to caching if both attempts fail
      */
-    private async emit(events: BaseEvent[]): Promise<void> {
-        if (this.isBufferingEvents) {
-            this.eventCache.appendEvents(events);
+    public async flush(events?: BaseEvent[]): Promise<void> {
+        if (!this.isTelemetryEnabled()) {
+            logger.info(LogId.telemetryEmitFailure, "telemetry", `Telemetry is disabled.`);
             return;
         }
 
-        const cachedEvents = this.eventCache.getEvents();
-        const allEvents = [...cachedEvents, ...events];
+        if (this.flushing) {
+            this.eventCache.appendEvents(events ?? []);
+            process.nextTick(async () => {
+                // try again if in the middle of a flush
+                await this.flush();
+            });
+            return;
+        }
 
-        logger.debug(
-            LogId.telemetryEmitStart,
-            "telemetry",
-            `Attempting to send ${allEvents.length} events (${cachedEvents.length} cached)`
-        );
+        this.flushing = true;
 
-        const result = await this.sendEvents(this.session.apiClient, allEvents);
-        if (result.success) {
+        try {
+            const cachedEvents = this.eventCache.getEvents();
+            const allEvents = [...cachedEvents, ...(events ?? [])];
+            if (allEvents.length <= 0) {
+                this.flushing = false;
+                return;
+            }
+
+            logger.debug(
+                LogId.telemetryEmitStart,
+                "telemetry",
+                `Attempting to send ${allEvents.length} events (${cachedEvents.length} cached)`
+            );
+
+            await this.sendEvents(this.session.apiClient, allEvents);
             this.eventCache.clearEvents();
             logger.debug(
                 LogId.telemetryEmitSuccess,
                 "telemetry",
                 `Sent ${allEvents.length} events successfully: ${JSON.stringify(allEvents, null, 2)}`
             );
-            return;
+        } catch (error: unknown) {
+            logger.debug(
+                LogId.telemetryEmitFailure,
+                "telemetry",
+                `Error sending event to client: ${error instanceof Error ? error.message : String(error)}`
+            );
+            this.eventCache.appendEvents(events ?? []);
+            process.nextTick(async () => {
+                // try again
+                await this.flush();
+            });
         }
 
-        logger.debug(
-            LogId.telemetryEmitFailure,
-            "telemetry",
-            `Error sending event to client: ${result.error instanceof Error ? result.error.message : String(result.error)}`
-        );
-        this.eventCache.appendEvents(events);
+        this.flushing = false;
     }
 
     /**
      * Attempts to send events through the provided API client
      */
-    private async sendEvents(client: ApiClient, events: BaseEvent[]): Promise<EventResult> {
-        try {
-            await client.sendEvents(
-                events.map((event) => ({
-                    ...event,
-                    properties: { ...this.getCommonProperties(), ...event.properties },
-                }))
-            );
-            return { success: true };
-        } catch (error) {
-            return {
-                success: false,
-                error: error instanceof Error ? error : new Error(String(error)),
-            };
-        }
+    private async sendEvents(client: ApiClient, events: BaseEvent[]): Promise<void> {
+        const commonProperties = await this.getCommonProperties();
+
+        await client.sendEvents(
+            events.map((event) => ({
+                ...event,
+                properties: { ...commonProperties, ...event.properties },
+            }))
+        );
     }
 }
diff --git a/src/telemetry/types.ts b/src/telemetry/types.ts
@@ -71,4 +71,5 @@ export type CommonProperties = {
     config_atlas_auth?: TelemetryBoolSet;
     config_connection_string?: TelemetryBoolSet;
     session_id?: string;
+    is_container_env?: TelemetryBoolSet;
 } & CommonStaticProperties;
diff --git a/src/tools/tool.ts b/src/tools/tool.ts
@@ -74,12 +74,12 @@ export abstract class ToolBase {
                 logger.debug(LogId.toolExecute, "tool", `Executing tool ${this.name}`);
 
                 const result = await this.execute(...args);
-                await this.emitToolEvent(startTime, result, ...args).catch(() => {});
+                this.emitToolEvent(startTime, result, ...args);
                 return result;
             } catch (error: unknown) {
                 logger.error(LogId.toolExecuteFailure, "tool", `Error executing ${this.name}: ${error as string}`);
                 const toolResult = await this.handleError(error, args[0] as ToolArgs<typeof this.argsShape>);
-                await this.emitToolEvent(startTime, toolResult, ...args).catch(() => {});
+                this.emitToolEvent(startTime, toolResult, ...args);
                 return toolResult;
             }
         };
@@ -179,11 +179,11 @@ export abstract class ToolBase {
      * @param result - Whether the command succeeded or failed
      * @param args - The arguments passed to the tool
      */
-    private async emitToolEvent(
+    private emitToolEvent(
         startTime: number,
         result: CallToolResult,
         ...args: Parameters<ToolCallback<typeof this.argsShape>>
-    ): Promise<void> {
+    ): void {
         if (!this.telemetry.isTelemetryEnabled()) {
             return;
         }
@@ -209,6 +209,6 @@ export abstract class ToolBase {
             event.properties.project_id = metadata.projectId;
         }
 
-        await this.telemetry.emitEvents([event]);
+        this.telemetry.emitEvents([event]);
     }
 }
diff --git a/tests/integration/telemetry.test.ts b/tests/integration/telemetry.test.ts
diff --git a/tests/unit/telemetry.test.ts b/tests/unit/telemetry.test.ts

Original file line number	Diff line number	Diff line change
`@@ -130,7 +130,7 @@ export class Server {`
`130`	`130`	`}`
`131`	`131`	`}`
`132`	`132`
`133`		`- this.telemetry.emitEvents([event]).catch(() => {});`
	`133`	`+ this.telemetry.emitEvents([event]);`
`134`	`134`	`}`
`135`	`135`
`136`	`136`	`private registerTools() {`