Add telemetry support for Server API autocomplete functionality

- Introduced telemetry context management for Server API autocomplete events.
- Implemented logging for activation, registration, and triggering of autocomplete features.
- Created telemetry event names for better tracking of autocomplete interactions.

Author: Amit Joshi

src/client/extension.ts

@@ -53,6 +53,7 @@ import { authenticateUserInVSCode } from "../common/services/AuthenticationProvi
 import { PROVIDER_ID } from "../common/services/Constants";
 import { activateServerApiAutocomplete } from "../common/intellisense";
 import { EnableBLChanges } from "../common/ecs-features/ecsFeatureGates";
+import { setServerApiTelemetryContext } from "../common/intellisense/ServerApiTelemetryContext";
 
 let client: LanguageClient;
 let _context: vscode.ExtensionContext;
@@ -234,6 +235,15 @@ export async function activate(
 
                     const { enableBLChanges } = EnableBLChanges.getConfig() as { enableBLChanges?: boolean };
                     if (!serverApiAutocompleteInitialized && enableBLChanges) {
+                        // Set telemetry context for Server API autocomplete events
+                        setServerApiTelemetryContext({
+                            tenantId: TenantID,
+                            envId: EnvID,
+                            userId: AadObjectId,
+                            orgId: orgID,
+                            geo: geoName,
+                            extType: 'desktop'
+                        });
                         activateServerApiAutocomplete(_context, [
                             { languageId: 'javascript', triggerCharacters: ['.'] }
                         ]);

src/common/intellisense/ServerApiAutocompleteRegistrar.ts

@@ -5,6 +5,9 @@
 
 import * as vscode from "vscode";
 import { ServerApiCompletionProvider } from "./ServerApiCompletionProvider";
+import { oneDSLoggerWrapper } from "../OneDSLoggerTelemetry/oneDSLoggerWrapper";
+import { ServerApiTelemetryEventNames } from "./serverApiTelemetryEventNames";
+import { getServerApiTelemetryContext } from "./ServerApiTelemetryContext";
 
 /**
  * Configuration for autocomplete language support
@@ -60,6 +63,21 @@ export class ServerApiAutocompleteRegistrar {
             context.subscriptions.push(disposable);
         });
 
+        try {
+            const ctx = getServerApiTelemetryContext();
+            oneDSLoggerWrapper.getLogger().traceInfo(ServerApiTelemetryEventNames.SERVER_API_AUTOCOMPLETE_REGISTERED, {
+                languages: languageConfigs.map(l => l.languageId).join(','),
+                triggerChars: languageConfigs.map(l => (l.triggerCharacters || ['.']).join('')).join(','),
+                provider: "ServerApiCompletionProvider",
+                tenantId: ctx?.tenantId,
+                envId: ctx?.envId,
+                userId: ctx?.userId,
+                orgId: ctx?.orgId,
+                geo: ctx?.geo,
+                extType: ctx?.extType
+            });
+        } catch { /* no-op */ }
+
         return disposables;
     }
 
@@ -120,5 +138,21 @@ export function activateServerApiAutocomplete(
     customLanguages?: ILanguageConfig[]
 ): void {
     const languageConfigs = customLanguages || defaultLanguageConfigs;
+
+    try {
+        const ctx = getServerApiTelemetryContext();
+        oneDSLoggerWrapper.getLogger().traceInfo(ServerApiTelemetryEventNames.SERVER_API_AUTOCOMPLETE_ACTIVATE, {
+            languages: languageConfigs.map(l => l.languageId).join(','),
+            provider: "ServerApiCompletionProvider",
+            // context
+            tenantId: ctx?.tenantId,
+            envId: ctx?.envId,
+            userId: ctx?.userId,
+            orgId: ctx?.orgId,
+            geo: ctx?.geo,
+            extType: ctx?.extType
+        });
+    } catch { /* no-op */ }
+
     ServerApiAutocompleteRegistrar.registerLanguages(context, languageConfigs);
 }

src/common/intellisense/ServerApiCompletionProvider.ts

@@ -4,6 +4,9 @@
  */
 
 import * as vscode from "vscode";
+import { oneDSLoggerWrapper } from "../OneDSLoggerTelemetry/oneDSLoggerWrapper";
+import { ServerApiTelemetryEventNames } from "./serverApiTelemetryEventNames";
+import { getServerApiTelemetryContext } from "./ServerApiTelemetryContext";
 
 /**
  * Interface for Server API method definitions
@@ -437,20 +440,82 @@ export class ServerApiCompletionProvider implements vscode.CompletionItemProvide
 
         const completions: vscode.CompletionItem[] = [];
 
-        // Check what level of completion we need
-        if (textBeforeCursor.endsWith('Server.')) {
-            // Provide top-level namespace completions
-            completions.push(...this.getNamespaceCompletions());
-        } else if (textBeforeCursor.endsWith('Server.Connector.')) {
-            // Provide Connector sub-namespace completions
-            completions.push(...this.getConnectorSubNamespaces());
-        } else {
-            // Check for nested completions
-            const match = textBeforeCursor.match(/Server\.([^.]+(?:\.[^.]+)?)\.?$/);
-            if (match) {
-                const namespaceName = match[1];
-                completions.push(...this.getMethodCompletions(namespaceName));
+        try {
+            const ctx = getServerApiTelemetryContext();
+            oneDSLoggerWrapper.getLogger().traceInfo(ServerApiTelemetryEventNames.SERVER_API_AUTOCOMPLETE_TRIGGERED, {
+                languageId: document.languageId,
+                prefix: textBeforeCursor.trim().slice(-50),
+                tenantId: ctx?.tenantId,
+                envId: ctx?.envId,
+                userId: ctx?.userId,
+                orgId: ctx?.orgId,
+                geo: ctx?.geo,
+                extType: ctx?.extType
+            });
+
+            // Check what level of completion we need
+            if (textBeforeCursor.endsWith('Server.')) {
+                // Provide top-level namespace completions
+                const items = this.getNamespaceCompletions();
+                completions.push(...items);
+
+                oneDSLoggerWrapper.getLogger().traceInfo(ServerApiTelemetryEventNames.SERVER_API_AUTOCOMPLETE_NAMESPACES_SHOWN, {
+                    count: String(items.length),
+                    tenantId: ctx?.tenantId,
+                    envId: ctx?.envId,
+                    userId: ctx?.userId,
+                    orgId: ctx?.orgId,
+                    geo: ctx?.geo,
+                    extType: ctx?.extType
+                });
+            } else if (textBeforeCursor.endsWith('Server.Connector.')) {
+                // Provide Connector sub-namespace completions
+                const items = this.getConnectorSubNamespaces();
+                completions.push(...items);
+
+                oneDSLoggerWrapper.getLogger().traceInfo(ServerApiTelemetryEventNames.SERVER_API_AUTOCOMPLETE_SUB_NAMESPACES_SHOWN, {
+                    parent: 'Connector',
+                    count: String(items.length),
+                    tenantId: ctx?.tenantId,
+                    envId: ctx?.envId,
+                    userId: ctx?.userId,
+                    orgId: ctx?.orgId,
+                    geo: ctx?.geo,
+                    extType: ctx?.extType
+                });
+            } else {
+                // Check for nested completions
+                const match = textBeforeCursor.match(/Server\.([^.]+(?:\.[^.]+)?)\.?$/);
+                if (match) {
+                    const namespaceName = match[1];
+                    const items = this.getMethodCompletions(namespaceName);
+                    completions.push(...items);
+
+                    oneDSLoggerWrapper.getLogger().traceInfo(ServerApiTelemetryEventNames.SERVER_API_AUTOCOMPLETE_ITEMS_SHOWN, {
+                        namespace: namespaceName,
+                        count: String(items.length),
+                        tenantId: ctx?.tenantId,
+                        envId: ctx?.envId,
+                        userId: ctx?.userId,
+                        orgId: ctx?.orgId,
+                        geo: ctx?.geo,
+                        extType: ctx?.extType
+                    });
+                }
             }
+        } catch (err) {
+            try {
+                const e = err as Error;
+                const ctx = getServerApiTelemetryContext();
+                oneDSLoggerWrapper.getLogger().traceError(ServerApiTelemetryEventNames.SERVER_API_AUTOCOMPLETE_ERROR, e.message, e, {
+                    tenantId: ctx?.tenantId,
+                    envId: ctx?.envId,
+                    userId: ctx?.userId,
+                    orgId: ctx?.orgId,
+                    geo: ctx?.geo,
+                    extType: ctx?.extType
+                });
+            } catch { /* no-op */ }
         }
 
         return completions;

src/common/intellisense/ServerApiTelemetryContext.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
+
+export interface IServerApiTelemetryContext {
+    tenantId?: string;
+    envId?: string;
+    userId?: string;
+    orgId?: string;
+    geo?: string;
+    extType?: 'desktop' | 'web';
+}
+
+let _serverApiTelemetryContext: IServerApiTelemetryContext | undefined;
+
+export function setServerApiTelemetryContext(ctx?: IServerApiTelemetryContext) {
+    _serverApiTelemetryContext = ctx;
+}
+
+export function getServerApiTelemetryContext(): IServerApiTelemetryContext | undefined {
+    return _serverApiTelemetryContext;
+}

src/common/intellisense/serverApiTelemetryEventNames.ts

@@ -0,0 +1,81 @@
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ */
+
+/**
+ * Telemetry event names for Server API autocomplete functionality
+ * These events track the usage and performance of Server API IntelliSense features
+ * in Power Pages JavaScript development within VS Code
+ */
+export enum ServerApiTelemetryEventNames {
+    /**
+     * Fired when Server API autocomplete is activated/initialized in an extension
+     */
+    SERVER_API_AUTOCOMPLETE_ACTIVATE = "ServerApiAutocompleteActivate",
+
+    /**
+     * Fired when Server API completion providers are successfully registered
+     */
+    SERVER_API_AUTOCOMPLETE_REGISTERED = "ServerApiAutocompleteRegistered",
+
+    /**
+     * Fired when Server API autocomplete is triggered by user input
+     */
+    SERVER_API_AUTOCOMPLETE_TRIGGERED = "ServerApiAutocompleteTriggered",
+
+    /**
+     * Fired when Server API namespaces are shown to the user (e.g., Server.Logger, Server.Context)
+     */
+    SERVER_API_AUTOCOMPLETE_NAMESPACES_SHOWN = "ServerApiAutocompleteNamespacesShown",
+
+    /**
+     * Fired when Server API sub-namespaces are shown (e.g., Server.Connector.HttpClient)
+     */
+    SERVER_API_AUTOCOMPLETE_SUB_NAMESPACES_SHOWN = "ServerApiAutocompleteSubNamespacesShown",
+
+    /**
+     * Fired when specific Server API items/methods are shown to the user
+     */
+    SERVER_API_AUTOCOMPLETE_ITEMS_SHOWN = "ServerApiAutocompleteItemsShown",
+
+    /**
+     * Fired when an error occurs during Server API autocomplete processing
+     */
+    SERVER_API_AUTOCOMPLETE_ERROR = "ServerApiAutocompleteError",
+
+    /**
+     * Fired when Server API telemetry context is set with environment/org details
+     */
+    SERVER_API_TELEMETRY_CONTEXT_SET = "ServerApiTelemetryContextSet",
+
+    /**
+     * Fired when Server API feature flag (EnableBLChanges) is checked
+     */
+    SERVER_API_FEATURE_FLAG_CHECK = "ServerApiFeatureFlagCheck",
+
+    /**
+     * Fired when Server API autocomplete is enabled via feature flag
+     */
+    SERVER_API_FEATURE_FLAG_ENABLED = "ServerApiFeatureFlagEnabled",
+
+    /**
+     * Fired when Server API autocomplete is disabled via feature flag
+     */
+    SERVER_API_FEATURE_FLAG_DISABLED = "ServerApiFeatureFlagDisabled",
+
+    /**
+     * Fired when a Server API completion item is selected/accepted by the user
+     */
+    SERVER_API_COMPLETION_ITEM_SELECTED = "ServerApiCompletionItemSelected",
+
+    /**
+     * Fired when Server API definitions are loaded or refreshed
+     */
+    SERVER_API_DEFINITIONS_LOADED = "ServerApiDefinitionsLoaded",
+
+    /**
+     * Fired when there's an issue with Server API telemetry context retrieval
+     */
+    SERVER_API_TELEMETRY_CONTEXT_ERROR = "ServerApiTelemetryContextError"
+}

src/web/client/extension.ts

@@ -46,6 +46,7 @@ import { getECSOrgLocationValue } from "../../common/utilities/Utils";
 import { authenticateUserInVSCode } from "../../common/services/AuthenticationProvider";
 import { activateServerApiAutocomplete } from "../../common/intellisense";
 import { EnableBLChanges } from "../../common/ecs-features/ecsFeatureGates";
+import { setServerApiTelemetryContext } from "../../common/intellisense/ServerApiTelemetryContext";
 
 let serverApiAutocompleteInitialized = false;
 
@@ -154,6 +155,15 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
 
                                         const { enableBLChanges } = EnableBLChanges.getConfig() as { enableBLChanges?: boolean };
                                         if (!serverApiAutocompleteInitialized && enableBLChanges) {
+                                            // Set telemetry context for Server API autocomplete events
+                                            setServerApiTelemetryContext({
+                                                tenantId: queryParamsMap.get(queryParameters.TENANT_ID) as string,
+                                                envId: WebExtensionContext.environmentId,
+                                                userId: WebExtensionContext.userId,
+                                                orgId: orgId,
+                                                geo: WebExtensionContext.geoName,
+                                                extType: 'web'
+                                            });
                                             activateServerApiAutocomplete(context, [
                                                 { languageId: 'javascript', triggerCharacters: ['.'] }
                                             ]);