Monitor query updates

sdk/monitor/monitor-query/package.json

@@ -46,7 +46,7 @@
     "build:samples": "dev-tool samples publish --force",
     "build:test": "tsc -p . && rollup -c 2>&1",
     "build:types": "downlevel-dts types/latest types/3.1",
-    "build": "npm run clean && tsc -p . && npm run lint && npm run build:nodebrowser && api-extractor run --local && npm run build:types",
+    "build": "npm run clean && tsc -p . && npm run build:nodebrowser && api-extractor run --local && npm run build:types",
     "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
     "clean": "rimraf dist dist-* temp types *.tgz *.log coverage coverage-browser",
     "docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --stripInternal --mode file --out ./dist/docs ./src",

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

@@ -7,7 +7,6 @@
 import { CommonClientOptions } from '@azure/core-client';
 import { OperationOptions } from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { PipelineOptions } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 
 // @public
@@ -42,7 +41,7 @@ export interface ErrorInfo {
     additionalProperties?: Record<string, unknown>;
     code: string;
     details?: ErrorDetail[];
-    innererror?: ErrorInfo;
+    innerError?: ErrorInfo;
     message: string;
 }
 
@@ -66,15 +65,19 @@ export interface LogsColumn {
 export type LogsColumnType = string;
 
 // @public
-export type LogsQueryBatchOptions = OperationOptions;
+export interface LogsQueryBatchOptions extends OperationOptions {
+    throwOnAnyFailure?: boolean;
+}
 
 // @public
 export interface LogsQueryBatchResult {
+    // (undocumented)
+    batchResultStatus: "AllSucceeded" | "AllFailed" | "PartiallySucceeded";
     results?: {
-        id?: string;
         status?: number;
         tables?: LogsTable[];
         error?: ErrorInfo;
+        logsQueryResultStatus?: LogsQueryResultStatus;
         statistics?: Record<string, unknown>;
         visualization?: Record<string, unknown>;
     }[];
@@ -101,19 +104,24 @@ export interface LogsQueryOptions extends OperationOptions {
     includeQueryStatistics?: boolean;
     includeVisualization?: boolean;
     serverTimeoutInSeconds?: number;
+    throwOnAnyFailure?: boolean;
 }
 
 // @public
 export interface LogsQueryResult {
     error?: ErrorInfo;
+    logsQueryResultStatus?: LogsQueryResultStatus;
     statistics?: Record<string, unknown>;
     tables: LogsTable[];
     visualization?: Record<string, unknown>;
 }
 
+// @public
+export type LogsQueryResultStatus = "Partial" | "Success" | "Failed";
+
 // @public
 export interface LogsTable {
-    columns: LogsColumn[];
+    columnDescriptors: LogsColumn[];
     name: string;
     rows: (Date | string | number | Record<string, unknown> | boolean)[][];
 }
@@ -171,7 +179,7 @@ export interface MetricNamespace {
 }
 
 // @public
-export interface MetricsClientOptions extends PipelineOptions {
+export interface MetricsClientOptions extends CommonClientOptions {
     endpoint?: string;
 }
 
@@ -199,6 +207,7 @@ export interface MetricsQueryOptions extends OperationOptions {
 // @public
 export interface MetricsQueryResult {
     cost?: number;
+    getMetricByName(metricName: string): Metric;
     granularity?: string;
     metrics: Metric[];
     namespace?: string;

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

@@ -59,7 +59,7 @@ export async function main() {
   );
 
   for (const table of tablesFromResult) {
-    const columnHeaderString = table.columns
+    const columnHeaderString = table.columnDescriptors
       .map((column) => `${column.name}(${column.type}) `)
       .join("| ");
     console.log("| " + columnHeaderString);

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

@@ -54,7 +54,7 @@ export async function main() {
 
   let i = 0;
   for (const response of result.results) {
-    console.log(`Results for query with id: ${response.id}`);
+    console.log(`Results for query with query: ${queriesBatch[i]}`);
 
     if (response.error) {
       console.log(` Query had errors:`, response.error);
@@ -67,7 +67,7 @@ export async function main() {
         );
 
         for (const table of response.tables) {
-          const columnHeaderString = table.columns
+          const columnHeaderString = table.columnDescriptors
             .map((column) => `${column.name}(${column.type}) `)
             .join("| ");
           console.log(columnHeaderString);

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

@@ -62,7 +62,7 @@ export async function main() {
   );
 
   for (const table of tablesFromResult) {
-    const columnHeaderString = table.columns
+    const columnHeaderString = table.columnDescriptors
       .map((column) => `${column.name}(${column.type}) `)
       .join("| ");
     console.log("| " + columnHeaderString);

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

@@ -24,26 +24,33 @@ export async function main() {
   const iterator = metricsQueryClient.listMetricDefinitions(metricsResourceId);
   let result = await iterator.next();
   const firstMetric: MetricDefinition = result.value;
-
+  let secondMetricName: string;
   while (!result.done) {
     console.log(` metricDefinitions - ${result.value.id}, ${result.value.name}`);
+    secondMetricName = result.value.name!;
     result = await iterator.next();
   }
   console.log(`First Metric Definition = ${firstMetric.name}`);
 
   console.log(`Picking an example metric to query: ${firstMetric.name!}`);
 
-  const metricsResponse = await metricsQueryClient.query(metricsResourceId, [firstMetric.name!], {
-    granularity: "PT1M",
-    timespan: { duration: Durations.FiveMinutes }
-  });
+  const metricsResponse = await metricsQueryClient.query(
+    metricsResourceId,
+    [firstMetric.name!, secondMetricName!],
+    {
+      granularity: "PT1M",
+      timespan: { duration: Durations.FiveMinutes }
+    }
+  );
 
   console.log(
     `Query cost: ${metricsResponse.cost}, interval: ${metricsResponse.granularity}, time span: ${metricsResponse.timespan}`
   );
 
   const metrics: Metric[] = metricsResponse.metrics;
   console.log(`Metrics:`, JSON.stringify(metrics, undefined, 2));
+  const metric = metricsResponse.getMetricByName(firstMetric.name!);
+  console.log(`Selected Metric: ${firstMetric.name}`, JSON.stringify(metric, undefined, 2));
 }
 
 main().catch((err) => {

sdk/monitor/monitor-query/samples/v1/javascript/logsQuery.js

@@ -23,7 +23,7 @@ async function main() {
   const kustoQuery =
     "AppEvents | project TimeGenerated, Name, AppRoleInstance | order by TimeGenerated asc | limit 10";
 
-  console.log(`Running '${kustoQuery}' over the last 5 minutes`);
+  console.log(`Running '${kustoQuery}' over the last One Hour`);
   const queryLogsOptions = {
     // explicitly control the amount of time the server can spend processing the query.
     serverTimeoutInSeconds: 60,
@@ -32,13 +32,13 @@ async function main() {
     includeQueryStatistics: true
   };
 
-  const result = await logsQueryClient.queryLogs(
+  const result = await logsQueryClient.query(
     monitorWorkspaceId,
     kustoQuery,
     // The timespan is an ISO8601 formatted time (or interval). Some common aliases
-    // are available (like lastDay, lastHour, last48Hours, etc..) but any properly formatted ISO8601
+    // are available (like OneDay, OneHour, FoutyEightHours, etc..) but any properly formatted ISO8601
     // value is valid.
-    Durations.lastHour,
+    { duration: Durations.OneHour },
     queryLogsOptions
   );
 
@@ -59,7 +59,7 @@ async function main() {
   );
 
   for (const table of tablesFromResult) {
-    const columnHeaderString = table.columns
+    const columnHeaderString = table.columnDescriptors
       .map((column) => `${column.name}(${column.type}) `)
       .join("| ");
     console.log("| " + columnHeaderString);

sdk/monitor/monitor-query/samples/v1/javascript/logsQueryBatch.js

@@ -25,38 +25,36 @@ async function main() {
     {
       workspaceId: monitorWorkspaceId,
       query: kqlQuery,
-      timespan: "P1D"
+      timespan: { duration: "P1D" }
     },
     {
       workspaceId: monitorWorkspaceId,
       query: "AzureActivity | summarize count()",
-      timespan: "PT1H"
+      timespan: { duration: "PT1H" }
     },
     {
       workspaceId: monitorWorkspaceId,
       query:
         "AppRequests | take 10 | summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId",
-      timespan: "PT1H"
+      timespan: { duration: "PT1H" }
     },
     {
       workspaceId: monitorWorkspaceId,
       query: "AppRequests | take 2",
-      timespan: "PT1H",
+      timespan: { duration: "PT1H" },
       includeQueryStatistics: true
     }
   ];
 
-  const result = await logsQueryClient.queryLogsBatch({
-    queries: queriesBatch
-  });
+  const result = await logsQueryClient.queryBatch(queriesBatch);
 
   if (result.results == null) {
     throw new Error("No response for query");
   }
 
   let i = 0;
   for (const response of result.results) {
-    console.log(`Results for query with id: ${response.id}`);
+    console.log(`Results for query with query: ${queriesBatch[i]}`);
 
     if (response.error) {
       console.log(` Query had errors:`, response.error);
@@ -69,7 +67,7 @@ async function main() {
         );
 
         for (const table of response.tables) {
-          const columnHeaderString = table.columns
+          const columnHeaderString = table.columnDescriptors
             .map((column) => `${column.name}(${column.type}) `)
             .join("| ");
           console.log(columnHeaderString);

sdk/monitor/monitor-query/samples/v1/javascript/logsQueryMultipleWorkspaces.js

@@ -35,13 +35,13 @@ async function main() {
     additionalWorkspaces: [additionalWorkspaces1, additionalWorkspaces2]
   };
 
-  const result = await logsQueryClient.queryLogs(
+  const result = await logsQueryClient.query(
     monitorWorkspaceId,
     kustoQuery,
     // The timespan is an ISO8601 formatted time (or interval). Some common aliases
-    // are available (like lastDay, lastHour, last48Hours, etc..) but any properly formatted ISO8601
+    // are available (like durationOf1Day, durationOf1Hour, durationOf48Hours, etc..) but any properly formatted ISO8601
     // value is valid.
-    Durations.lastHour,
+    { duration: Durations.OneHour },
     queryLogsOptions
   );
 
@@ -62,7 +62,7 @@ async function main() {
   );
 
   for (const table of tablesFromResult) {
-    const columnHeaderString = table.columns
+    const columnHeaderString = table.columnDescriptors
       .map((column) => `${column.name}(${column.type}) `)
       .join("| ");
     console.log("| " + columnHeaderString);

sdk/monitor/monitor-query/samples/v1/javascript/metricsQuery.js

@@ -21,31 +21,36 @@ async function main() {
     throw new Error("METRICS_RESOURCE_ID must be set in the environment for this sample");
   }
 
-  const result = await metricsQueryClient.getMetricDefinitions(metricsResourceId);
-
-  for (const definition of result.definitions) {
-    console.log(`Definition = ${definition.name}`);
+  const iterator = metricsQueryClient.listMetricDefinitions(metricsResourceId);
+  let result = await iterator.next();
+  const firstMetric = result.value;
+  let secondMetricName;
+  while (!result.done) {
+    console.log(` metricDefinitions - ${result.value.id}, ${result.value.name}`);
+    secondMetricName = result.value.name;
+    result = await iterator.next();
   }
-
-  const firstMetric = result.definitions[0];
+  console.log(`First Metric Definition = ${firstMetric.name}`);
 
   console.log(`Picking an example metric to query: ${firstMetric.name}`);
 
-  const metricsResponse = await metricsQueryClient.queryMetrics(
+  const metricsResponse = await metricsQueryClient.query(
     metricsResourceId,
-    Durations.last5Minutes,
+    [firstMetric.name, secondMetricName],
     {
-      metricNames: [firstMetric.name],
-      interval: "PT1M"
+      granularity: "PT1M",
+      timespan: { duration: Durations.FiveMinutes }
     }
   );
 
   console.log(
-    `Query cost: ${metricsResponse.cost}, interval: ${metricsResponse.interval}, time span: ${metricsResponse.timespan}`
+    `Query cost: ${metricsResponse.cost}, interval: ${metricsResponse.granularity}, time span: ${metricsResponse.timespan}`
   );
 
   const metrics = metricsResponse.metrics;
   console.log(`Metrics:`, JSON.stringify(metrics, undefined, 2));
+  const metric = metricsResponse.getMetricByName(firstMetric.name);
+  console.log(`Selected Metric: ${firstMetric.name}`, JSON.stringify(metric, undefined, 2));
 }
 
 main().catch((err) => {

sdk/monitor/monitor-query/samples/v1/typescript/src/logsQuery.ts

@@ -6,7 +6,7 @@
  */
 
 import { DefaultAzureCredential } from "@azure/identity";
-import { Durations, LogsQueryClient, LogsTable, QueryLogsOptions } from "@azure/monitor-query";
+import { Durations, LogsQueryClient, LogsTable, LogsQueryOptions } from "@azure/monitor-query";
 import * as dotenv from "dotenv";
 dotenv.config();
 
@@ -23,22 +23,22 @@ export async function main() {
   const kustoQuery =
     "AppEvents | project TimeGenerated, Name, AppRoleInstance | order by TimeGenerated asc | limit 10";
 
-  console.log(`Running '${kustoQuery}' over the last 5 minutes`);
-  const queryLogsOptions: QueryLogsOptions = {
+  console.log(`Running '${kustoQuery}' over the last One Hour`);
+  const queryLogsOptions: LogsQueryOptions = {
     // explicitly control the amount of time the server can spend processing the query.
     serverTimeoutInSeconds: 60,
     // optionally enable returning additional statistics about the query's execution.
     // (by default this is off)
     includeQueryStatistics: true
   };
 
-  const result = await logsQueryClient.queryLogs(
+  const result = await logsQueryClient.query(
     monitorWorkspaceId,
     kustoQuery,
     // The timespan is an ISO8601 formatted time (or interval). Some common aliases
-    // are available (like lastDay, lastHour, last48Hours, etc..) but any properly formatted ISO8601
+    // are available (like OneDay, OneHour, FoutyEightHours, etc..) but any properly formatted ISO8601
     // value is valid.
-    Durations.lastHour,
+    { duration: Durations.OneHour },
     queryLogsOptions
   );
 
@@ -50,7 +50,7 @@ export async function main() {
   }
 
   const executionTime =
-    result.statistics && result.statistics.query && result.statistics.query.executionTime;
+    result.statistics && result.statistics.query && (result.statistics.query as any).executionTime;
 
   console.log(
     `Results for query '${kustoQuery}', execution time: ${
@@ -59,7 +59,7 @@ export async function main() {
   );
 
   for (const table of tablesFromResult) {
-    const columnHeaderString = table.columns
+    const columnHeaderString = table.columnDescriptors
       .map((column) => `${column.name}(${column.type}) `)
       .join("| ");
     console.log("| " + columnHeaderString);