Adding additional logging and telemetry for Build features (#19449) (#19452)

* additonal Entra sign-in logging for connection dialog

* added error telemetry

* query result and execution plan error telemetry

* pr comments + fixed test

* fix unit test

* table designer error reporting

---------

Co-authored-by: Benjin Dubishar <[email protected]>
Co-authored-by: Lauren Nathan <[email protected]>

Author: 3 people

src/connectionconfig/connectionDialogWebviewController.ts

@@ -922,15 +922,29 @@ export class ConnectionDialogWebviewController extends FormWebviewController<
             id: "azureSignIn",
             callback: async () => {
                 const account = await this._mainController.azureAccountService.addAccount();
+                this.logger.verbose(
+                    `Added Azure account '${account.displayInfo}', ${account.key.id}`,
+                );
+
                 const accountsComponent = this.getFormComponent(this.state, "accountId");
-                if (accountsComponent) {
-                    accountsComponent.options = await getAccounts(
-                        this._mainController.azureAccountService,
-                    );
-                    this.state.connectionProfile.accountId = account.key.id;
-                    this.updateState();
-                    await this.handleAzureMFAEdits("accountId");
+
+                if (!accountsComponent) {
+                    this.logger.error("Account component not found");
+                    return;
                 }
+
+                accountsComponent.options = await getAccounts(
+                    this._mainController.azureAccountService,
+                );
+
+                this.state.connectionProfile.accountId = account.key.id;
+
+                this.logger.verbose(
+                    `Read ${accountsComponent.options.length} Azure accounts, selecting '${account.key.id}'`,
+                );
+
+                this.updateState();
+                await this.handleAzureMFAEdits("accountId");
             },
         });
 

src/controllers/mainController.ts

@@ -2359,6 +2359,8 @@ export default class MainController implements vscode.Disposable {
             );
 
             executionPlanController.revealToForeground();
+
+            sendActionEvent(TelemetryViews.ExecutionPlan, TelemetryActions.Open);
         }
     };
 }

src/controllers/sharedExecutionPlanUtils.ts

@@ -37,6 +37,7 @@ export async function saveExecutionPlan(
     if (saveUri) {
         // Write the content to the new file
         void vscode.workspace.fs.writeFile(saveUri, Buffer.from(payload.sqlPlanContent));
+        sendActionEvent(TelemetryViews.ExecutionPlan, TelemetryActions.SavePlan);
     }
 
     return state;
@@ -92,7 +93,9 @@ export async function createExecutionPlanGraphs(
     let newState = {
         ...state.executionPlanState,
     };
+
     const startTime = performance.now(); // timer for telemetry
+
     for (const plan of xmlPlans) {
         const planFile: ExecutionPlanGraphInfo = {
             graphFileContent: plan,

src/queryResult/queryResultWebViewController.ts

@@ -9,7 +9,7 @@ import * as Constants from "../constants/constants";
 import * as LocalizedConstants from "../constants/locConstants";
 import { ReactWebviewViewController } from "../controllers/reactWebviewViewController";
 import { SqlOutputContentProvider } from "../models/sqlOutputContentProvider";
-import { sendActionEvent } from "../telemetry/telemetry";
+import { sendActionEvent, sendErrorEvent } from "../telemetry/telemetry";
 import { TelemetryActions, TelemetryViews } from "../sharedInterfaces/telemetry";
 import { randomUUID } from "crypto";
 import { ApiStatus } from "../sharedInterfaces/webview";
@@ -331,7 +331,17 @@ export class QueryResultWebviewController extends ReactWebviewViewController<
         var res = this._queryResultStateMap.get(uri);
         if (!res) {
             // This should never happen
-            throw new Error(`No query result state found for uri ${uri}`);
+
+            const error = new Error(`No query result state found for uri ${uri}`);
+
+            sendErrorEvent(
+                TelemetryViews.QueryResult,
+                TelemetryActions.GetQueryResultState,
+                error,
+                false, // includeErrorMessage
+            );
+
+            throw error;
         }
         return res;
     }

src/sharedInterfaces/telemetry.ts

@@ -92,6 +92,8 @@ export enum TelemetryActions {
     Feedback = "Feedback",
     ChatWithDatabase = "ChatWithDatabase",
     StartConversation = "StartConversation",
+    GetQueryResultState = "GetQueryResultState",
+    SavePlan = "SavePlan",
 }
 
 /**

src/tableDesigner/tableDesignerWebviewController.ts

@@ -11,7 +11,7 @@ import * as designer from "../sharedInterfaces/tableDesigner";
 import UntitledSqlDocumentService from "../controllers/untitledSqlDocumentService";
 import { getDesignerView } from "./tableDesignerTabDefinition";
 import { TreeNodeInfo } from "../objectExplorer/nodes/treeNodeInfo";
-import { sendActionEvent, startActivity } from "../telemetry/telemetry";
+import { sendActionEvent, sendErrorEvent, startActivity } from "../telemetry/telemetry";
 import { ActivityStatus, TelemetryActions, TelemetryViews } from "../sharedInterfaces/telemetry";
 import { copied, scriptCopiedToClipboard } from "../constants/locConstants";
 import { UserSurvey } from "../nps/userSurvey";
@@ -73,7 +73,18 @@ export class TableDesignerWebviewController extends ReactWebviewPanelController<
 
     private async initialize() {
         if (!this._targetNode) {
-            await vscode.window.showErrorMessage("Unable to find object explorer node");
+            const errorMessage = "Unable to find object explorer node";
+            await vscode.window.showErrorMessage(errorMessage);
+
+            sendErrorEvent(
+                TelemetryViews.TableDesigner,
+                TelemetryActions.Initialize,
+                new Error(errorMessage),
+                true, //includeErrorMessage
+                undefined, // errorCode
+                "unableToFindObjectExplorerNode",
+            );
+
             return;
         }
 
@@ -103,12 +114,32 @@ export class TableDesignerWebviewController extends ReactWebviewPanelController<
             );
 
             if (!connectionString || connectionString === "") {
-                await vscode.window.showErrorMessage(
-                    "Unable to find connection string for the connection",
+                const errorMessage = "Unable to find connection string for the connection";
+
+                await vscode.window.showErrorMessage(errorMessage);
+
+                sendErrorEvent(
+                    TelemetryViews.TableDesigner,
+                    TelemetryActions.Initialize,
+                    new Error(errorMessage),
+                    true, //includeErrorMessage
+                    undefined, // errorCode
+                    "unableToFindConnectionString",
                 );
+
                 return;
             }
         } catch (e) {
+            const error = e instanceof Error ? e : new Error(getErrorMessage(e));
+
+            sendErrorEvent(
+                TelemetryViews.TableDesigner,
+                TelemetryActions.Initialize,
+                error,
+                false, //includeErrorMessage
+                undefined, // errorCode
+                "unableToFindConnectionString",
+            );
             await vscode.window.showErrorMessage(
                 "Unable to find connection string for the connection: " + getErrorMessage(e),
             );
@@ -240,7 +271,15 @@ export class TableDesignerWebviewController extends ReactWebviewPanelController<
 
                 return afterEditState;
             } catch (e) {
-                vscode.window.showErrorMessage(e.message);
+                const error = e instanceof Error ? e : new Error(getErrorMessage(e));
+
+                sendErrorEvent(
+                    TelemetryViews.TableDesigner,
+                    TelemetryActions.Edit,
+                    error,
+                    false, //includeErrorMessage
+                );
+                vscode.window.showErrorMessage(getErrorMessage(e));
                 return state;
             }
         });