π OpenHands: AI-Driven Development
feat: tag Agent Canvas telemetry by deployment kind (OSS-13530) (#17529)
Rohit Malhotraf3f887a813e2
diff --git a/__tests__/hooks/use-tracking.test.ts b/__tests__/hooks/use-tracking.test.tsindex 66fdfd88a6..d2098218fa 100644--- a/__tests__/hooks/use-tracking.test.ts+++ b/__tests__/hooks/use-tracking.test.ts@@ -410,6 +410,7 @@ describe("useTracking", () => {expect(captureMock).toHaveBeenCalledWith("backend_added", {...COMMON,backend_kind: "cloud",+ deployment_kind: "remote",connection_method: "cloud_login",has_api_key: true,source: "add_backend_modal",diff --git a/__tests__/services/telemetry.test.ts b/__tests__/services/telemetry.test.tsindex 7fa7de110b..a6611437d6 100644--- a/__tests__/services/telemetry.test.ts+++ b/__tests__/services/telemetry.test.ts@@ -143,6 +143,7 @@ describe("Telemetry Service", () => {package_name: "@openhands/agent-canvas",package_version: expect.any(String),backend_kind: null,+ deployment_kind: null,agent_server_version: "unknown",automation_sdk_version: "unknown",backend_version: "unknown",@@ -164,6 +165,7 @@ describe("Telemetry Service", () => {event: "backend_context_event",properties: expect.objectContaining({backend_kind: "cloud",+ deployment_kind: "remote",agent_server_version: "1.36.2",automation_sdk_version: "1.36.3",backend_version: "1.36.2",diff --git a/src/services/telemetry-context.ts b/src/services/telemetry-context.tsindex a5ce460360..d5d81bdaf3 100644--- a/src/services/telemetry-context.ts+++ b/src/services/telemetry-context.ts@@ -2,6 +2,8 @@ import type { BackendKind } from "#/api/backend-registry/types";export const UNKNOWN_TELEMETRY_VERSION = "unknown";+export type DeploymentKind = "local" | "remote";+export type BackendConnectionMethod = "manual" | "cloud_login" | "cloud_cookie";export interface CloudTelemetryContextInput {@@ -30,6 +32,14 @@ function normalizeOptionalProperty(return trimmed || null;}+export function getDeploymentKindForBackend(+ backendKind: BackendKind | null | undefined,+): DeploymentKind | null {+ if (backendKind === "cloud") return "remote";+ if (backendKind === "local") return "local";+ return null;+}+export function getBackendTelemetryProperties({backendKind,agentServerVersion,@@ -48,6 +58,7 @@ export function getBackendTelemetryProperties({return {backend_kind: backendKind ?? null,+ deployment_kind: getDeploymentKindForBackend(backendKind),agent_server_version: resolvedAgentServerVersion,automation_sdk_version: resolvedAutomationSdkVersion,backend_version: resolvedBackendVersion,diff --git a/src/services/telemetry.ts b/src/services/telemetry.tsindex 945812f3fa..d00d150986 100644--- a/src/services/telemetry.ts+++ b/src/services/telemetry.ts@@ -40,11 +40,14 @@ import {AGENT_CANVAS_CLIENT_SOURCE,AGENT_CANVAS_CLIENT_VERSION,} from "#/api/client-source";+import type { BackendKind } from "#/api/backend-registry/types";import {getBackendTelemetryProperties,getCloudTelemetryProperties,+ getDeploymentKindForBackend,type BackendTelemetryContextInput,type CloudTelemetryContextInput,+ type DeploymentKind,} from "#/services/telemetry-context";const TELEMETRY_CONSENT_KEY = "openhands-telemetry-consent";@@ -133,6 +136,20 @@ const CANVAS_EVENT_PROPERTIES = Object.freeze({package_version: packageJson.version,});+function getExplicitDeploymentKind(value: unknown): DeploymentKind | null {+ return value === "remote" || value === "local" ? value : null;+}++function getEventDeploymentKind(+ properties: Record<string, unknown>,+): DeploymentKind | null {+ return (+ getDeploymentKindForBackend(+ properties.backend_kind as BackendKind | null,+ ) ?? getExplicitDeploymentKind(properties.deployment_kind)+ );+}+let telemetryBackendContext = getBackendTelemetryProperties({});let telemetryCloudContext = getCloudTelemetryProperties();@@ -153,12 +170,17 @@ function addCanvasEventProperties(): CaptureResult | null {if (!event) return null;+ const properties = {+ ...telemetryBackendContext,+ ...telemetryCloudContext,+ ...event.properties,+ };+return {...event,properties: {- ...telemetryBackendContext,- ...telemetryCloudContext,- ...event.properties,+ ...properties,+ deployment_kind: getEventDeploymentKind(properties),...CANVAS_EVENT_PROPERTIES,},};