update the error handling for Logs Query and Logs Query Batch

sdk/monitor/monitor-query/review/monitor-query.api.md

@@ -68,15 +68,7 @@ export interface LogsQueryBatchOptions extends OperationOptions {
 }
 
 // @public
-export interface LogsQueryBatchResult {
-    results: {
-        tables?: LogsTable[];
-        error?: LogsErrorInfo;
-        status?: LogsQueryResultStatus;
-        statistics?: Record<string, unknown>;
-        visualization?: Record<string, unknown>;
-    }[];
-}
+export type LogsQueryBatchResult = Array<LogsQueryPartialResult | LogsQuerySuccessfulResult | LogsQueryError>;
 
 // @public
 export class LogsQueryClient {
@@ -91,6 +83,12 @@ export interface LogsQueryClientOptions extends CommonClientOptions {
     endpoint?: string;
 }
 
+// @public
+export interface LogsQueryError extends Error {
+    code: string;
+    status: LogsQueryResultStatus.Failure;
+}
+
 // @public
 export interface LogsQueryOptions extends OperationOptions {
     additionalWorkspaces?: string[];
@@ -101,16 +99,31 @@ export interface LogsQueryOptions extends OperationOptions {
 }
 
 // @public
-export interface LogsQueryResult {
-    error?: LogsErrorInfo;
+export interface LogsQueryPartialResult {
+    incompleteTables: LogsTable[];
+    partialError: LogsErrorInfo;
     statistics?: Record<string, unknown>;
-    status: LogsQueryResultStatus;
-    tables: LogsTable[];
+    status: LogsQueryResultStatus.PartialFailure;
     visualization?: Record<string, unknown>;
 }
 
 // @public
-export type LogsQueryResultStatus = "PartialFailure" | "Success" | "Failure";
+export type LogsQueryResult = LogsQuerySuccessfulResult | LogsQueryPartialResult;
+
+// @public
+export enum LogsQueryResultStatus {
+    Failure = "Failure",
+    PartialFailure = "PartialFailure",
+    Success = "Success"
+}
+
+// @public
+export interface LogsQuerySuccessfulResult {
+    statistics?: Record<string, unknown>;
+    status: LogsQueryResultStatus.Success;
+    tables: LogsTable[];
+    visualization?: Record<string, unknown>;
+}
 
 // @public
 export interface LogsTable {

sdk/monitor/monitor-query/samples-dev/logsQuery.ts

@@ -6,7 +6,13 @@
  */
 
 import { DefaultAzureCredential } from "@azure/identity";
-import { Durations, LogsQueryClient, LogsTable, LogsQueryOptions } from "@azure/monitor-query";
+import {
+  Durations,
+  LogsQueryClient,
+  LogsTable,
+  LogsQueryOptions,
+  LogsQueryResultStatus
+} from "@azure/monitor-query";
 import * as dotenv from "dotenv";
 dotenv.config();
 
@@ -41,14 +47,6 @@ export async function main() {
     { duration: Durations.oneHour },
     queryLogsOptions
   );
-
-  const tablesFromResult: LogsTable[] | undefined = result.tables;
-
-  if (tablesFromResult == null) {
-    console.log(`No results for query '${kustoQuery}'`);
-    return;
-  }
-
   const executionTime =
     result.statistics && result.statistics.query && (result.statistics.query as any).executionTime;
 
@@ -58,6 +56,25 @@ export async function main() {
     }`
   );
 
+  if (result.status === LogsQueryResultStatus.Success) {
+    const tablesFromResult: LogsTable[] = result.tables;
+
+    if (tablesFromResult.length === 0) {
+      console.log(`No results for query '${kustoQuery}'`);
+      return;
+    }
+    console.log(`This query has returned table(s) - `);
+    processTables(tablesFromResult);
+  } else {
+    console.log(`Error processing the query '${kustoQuery}' - ${result.partialError}`);
+    if (result.incompleteTables.length > 0) {
+      console.log(`This query has also returned partial data in the following table(s) - `);
+      processTables(result.incompleteTables);
+    }
+  }
+}
+
+async function processTables(tablesFromResult: LogsTable[]) {
   for (const table of tablesFromResult) {
     const columnHeaderString = table.columnDescriptors
       .map((column) => `${column.name}(${column.type}) `)

sdk/monitor/monitor-query/samples-dev/logsQueryBatch.ts

@@ -6,7 +6,7 @@
  */
 
 import { DefaultAzureCredential } from "@azure/identity";
-import { LogsQueryClient } from "@azure/monitor-query";
+import { LogsQueryClient, LogsQueryResultStatus, LogsTable } from "@azure/monitor-query";
 import * as dotenv from "dotenv";
 dotenv.config();
 
@@ -47,43 +47,49 @@ export async function main() {
   ];
 
   const result = await logsQueryClient.queryBatch(queriesBatch);
-
-  if (result.results == null) {
+  if (result === null) {
     throw new Error("No response for query");
   }
 
   let i = 0;
-  for (const response of result.results) {
+  for (const response of result) {
     console.log(`Results for query with query: ${queriesBatch[i]}`);
-
-    if (response.error) {
-      console.log(` Query had errors:`, response.error);
+    if (response.status === LogsQueryResultStatus.Success) {
+      console.log(
+        `Printing results from query '${queriesBatch[i].query}' for '${queriesBatch[i].timespan}'`
+      );
+      processTables(response.tables);
+    } else if (response.status === LogsQueryResultStatus.PartialFailure) {
+      console.log(
+        `Printing Partial results from query '${queriesBatch[i].query}' for '${queriesBatch[i].timespan}'`
+      );
+      processTables(response.incompleteTables);
+      console.log(
+        ` Query had errors:${response.partialError.message} with code ${response.partialError.code}`
+      );
     } else {
-      if (response.tables == null) {
-        console.log(`No results for query`);
-      } else {
-        console.log(
-          `Printing results from query '${queriesBatch[i].query}' for '${queriesBatch[i].timespan}'`
-        );
-
-        for (const table of response.tables) {
-          const columnHeaderString = table.columnDescriptors
-            .map((column) => `${column.name}(${column.type}) `)
-            .join("| ");
-          console.log(columnHeaderString);
-
-          for (const row of table.rows) {
-            const columnValuesString = row.map((columnValue) => `'${columnValue}' `).join("| ");
-            console.log(columnValuesString);
-          }
-        }
-      }
+      console.log(`Printing Errors from query '${queriesBatch[i].query}'`);
+      console.log(` Query had errors:${response.message} with code ${response.code}`);
     }
     // next query
     i++;
   }
 }
 
+async function processTables(tablesFromResult: LogsTable[]) {
+  for (const table of tablesFromResult) {
+    const columnHeaderString = table.columnDescriptors
+      .map((column) => `${column.name}(${column.type}) `)
+      .join("| ");
+    console.log("| " + columnHeaderString);
+
+    for (const row of table.rows) {
+      const columnValuesString = row.map((columnValue) => `'${columnValue}' `).join("| ");
+      console.log("| " + columnValuesString);
+    }
+  }
+}
+
 main().catch((err) => {
   console.error("The sample encountered an error:", err);
   process.exit(1);

sdk/monitor/monitor-query/samples-dev/logsQueryMultipleWorkspaces.ts

@@ -6,7 +6,13 @@
  */
 
 import { DefaultAzureCredential } from "@azure/identity";
-import { Durations, LogsQueryClient, LogsTable, LogsQueryOptions } from "@azure/monitor-query";
+import {
+  Durations,
+  LogsQueryClient,
+  LogsTable,
+  LogsQueryOptions,
+  LogsQueryResultStatus
+} from "@azure/monitor-query";
 import * as dotenv from "dotenv";
 dotenv.config();
 
@@ -44,14 +50,6 @@ export async function main() {
     { duration: Durations.oneHour },
     queryLogsOptions
   );
-
-  const tablesFromResult: LogsTable[] | undefined = result.tables;
-
-  if (tablesFromResult == null) {
-    console.log(`No results for query '${kustoQuery}'`);
-    return;
-  }
-
   const executionTime =
     result.statistics && result.statistics.query && (result.statistics.query as any).executionTime;
 
@@ -61,6 +59,23 @@ export async function main() {
     }`
   );
 
+  if (result.status === LogsQueryResultStatus.Success) {
+    const tablesFromResult: LogsTable[] = result.tables;
+    if (tablesFromResult == null) {
+      console.log(`No results for query '${kustoQuery}'`);
+      return;
+    }
+    processTables(tablesFromResult);
+  } else {
+    console.log(`Error processing the query '${kustoQuery}' - ${result.partialError}`);
+    if (result.incompleteTables.length > 0) {
+      console.log(`This query has also returned partial data in the following table(s) - `);
+      processTables(result.incompleteTables);
+    }
+  }
+}
+
+async function processTables(tablesFromResult: LogsTable[]) {
   for (const table of tablesFromResult) {
     const columnHeaderString = table.columnDescriptors
       .map((column) => `${column.name}(${column.type}) `)

sdk/monitor/monitor-query/src/index.ts

@@ -11,8 +11,9 @@ export {
   LogsQueryBatchResult,
   LogsQueryOptions,
   LogsQueryResult,
-  // TODO: design issues around this still pending.
-  // QueryStatistics,
+  LogsQueryError,
+  LogsQueryPartialResult,
+  LogsQuerySuccessfulResult,
   LogsTable,
   LogsColumn,
   LogsQueryResultStatus,