feat(telemetry): integrate telemetry tracking for vscode extension

Author: jiashengguo

packages/schema/src/extension.ts

@@ -6,6 +6,7 @@ import { AUTH_PROVIDER_ID, ZenStackAuthenticationProvider } from './zenstack-aut
 import { DocumentationCache } from './documentation-cache';
 import { ZModelPreview } from './zmodel-preview';
 import { ReleaseNotesManager } from './release-notes-manager';
+import telemetry from './vscode-telemetry';
 
 // Global variables
 let client: LanguageClient;
@@ -19,13 +20,17 @@ export async function requireAuth(): Promise<vscode.AuthenticationSession | unde
     if (!session) {
         const signIn = 'Sign in';
         const selection = await vscode.window.showWarningMessage('Please sign in to use this feature', signIn);
+        telemetry.track('extension:signin:show');
         if (selection === signIn) {
+            telemetry.track('extension:signin:start');
             try {
                 session = await vscode.authentication.getSession(AUTH_PROVIDER_ID, [], { createIfNone: true });
                 if (session) {
+                    telemetry.track('extension:signin:complete');
                     vscode.window.showInformationMessage('ZenStack sign-in successful!');
                 }
             } catch (e: unknown) {
+                telemetry.track('extension:signin:error', { error: e instanceof Error ? e.message : String(e) });
                 vscode.window.showErrorMessage(
                     'ZenStack sign-in failed: ' + (e instanceof Error ? e.message : String(e))
                 );
@@ -37,6 +42,7 @@ export async function requireAuth(): Promise<vscode.AuthenticationSession | unde
 
 // This function is called when the extension is activated.
 export function activate(context: vscode.ExtensionContext): void {
+    telemetry.track('extension:activate');
     // Initialize and register the ZenStack authentication provider
     context.subscriptions.push(new ZenStackAuthenticationProvider(context));
 

packages/schema/src/vscode-telemetry.ts

@@ -0,0 +1,73 @@
+import { init, Mixpanel } from 'mixpanel';
+import * as os from 'os';
+import vscode from 'vscode';
+import { getMachineId } from './utils/machine-id-utils';
+import { v5 as uuidv5 } from 'uuid';
+import { TELEMETRY_TRACKING_TOKEN } from './constants';
+
+export type TelemetryEvents =
+    | 'extension:activate'
+    | 'extension:zmodel-preview'
+    | 'extension:zmodel-save'
+    | 'extension:signin:show'
+    | 'extension:signin:start'
+    | 'extension:signin:error'
+    | 'extension:signin:complete';
+
+export class VSCodeTelemetry {
+    private readonly mixpanel: Mixpanel | undefined;
+    private readonly deviceId = this.getDeviceId();
+    private readonly _os_type = os.type();
+    private readonly _os_release = os.release();
+    private readonly _os_arch = os.arch();
+    private readonly _os_version = os.version();
+    private readonly _os_platform = os.platform();
+    private readonly vscodeAppName = vscode.env.appName;
+    private readonly vscodeVersion = vscode.version;
+    private readonly vscodeAppHost = vscode.env.appHost;
+
+    constructor() {
+        if (vscode.env.isTelemetryEnabled) {
+            this.mixpanel = init(TELEMETRY_TRACKING_TOKEN, {
+                geolocate: true,
+            });
+        }
+    }
+
+    private getDeviceId() {
+        const hostId = getMachineId();
+        return uuidv5(hostId, '133cac15-3efb-50fa-b5fc-4b90e441e563');
+    }
+
+    track(event: TelemetryEvents, properties: Record<string, unknown> = {}) {
+        if (this.mixpanel) {
+            const payload = {
+                distinct_id: this.deviceId,
+                time: new Date(),
+                $os: this._os_type,
+                osType: this._os_type,
+                osRelease: this._os_release,
+                osPlatform: this._os_platform,
+                osArch: this._os_arch,
+                osVersion: this._os_version,
+                nodeVersion: process.version,
+                vscodeAppName: this.vscodeAppName,
+                vscodeVersion: this.vscodeVersion,
+                vscodeAppHost: this.vscodeAppHost,
+                ...properties,
+            };
+            this.mixpanel.track(event, payload);
+        }
+    }
+
+    identify(userId: string) {
+        if (this.mixpanel) {
+            this.mixpanel.track('$identify', {
+                $identified_id: userId,
+                $anon_id: this.deviceId,
+                token: TELEMETRY_TRACKING_TOKEN,
+            });
+        }
+    }
+}
+export default new VSCodeTelemetry();

packages/schema/src/zenstack-auth-provider.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode';
-
+import telemetry from './vscode-telemetry';
 interface JWTClaims {
     jti?: string;
     sub?: string;
@@ -150,9 +150,6 @@ export class ZenStackAuthenticationProvider implements vscode.AuthenticationProv
             }
         );
     }
-    private generateState(): string {
-        return Math.random().toString(36).substring(2, 15) + Math.random().toString(36).substring(2, 15);
-    }
 
     // Handle authentication callback from ZenStack
     public async handleAuthCallback(callbackUri: vscode.Uri): Promise<void> {
@@ -184,6 +181,7 @@ export class ZenStackAuthenticationProvider implements vscode.AuthenticationProv
         try {
             // Decode JWT to get claims
             const claims = this.parseJWTClaims(accessToken);
+            telemetry.identify(claims.email!);
             return {
                 id: claims.jti || Math.random().toString(36),
                 accessToken: accessToken,

packages/schema/src/zmodel-preview.ts

@@ -7,6 +7,7 @@ import { URI } from 'vscode-uri';
 import { DocumentationCache } from './documentation-cache';
 import { requireAuth } from './extension';
 import { API_URL } from './zenstack-auth-provider';
+import telemetry from './vscode-telemetry';
 
 /**
  * ZModelPreview class handles ZModel file preview functionality
@@ -92,6 +93,7 @@ export class ZModelPreview implements vscode.Disposable {
      * Preview a ZModel file
      */
     async previewZModelFile(): Promise<void> {
+        telemetry.track('extension:zmodel-preview');
         const editor = vscode.window.activeTextEditor;
 
         if (!editor) {
@@ -285,6 +287,7 @@ export class ZModelPreview implements vscode.Disposable {
      * Save ZModel documentation to a user-selected file
      */
     async saveZModelDocumentation(): Promise<void> {
+        telemetry.track('extension:zmodel-save');
         // Check if we have cached content first
         if (!this.lastGeneratedMarkdown) {
             vscode.window.showErrorMessage(