[monitor-query] Update samples to use 10-minute server timeout (Azure#23055)

Author: timovv

sdk/monitor/monitor-query/README.md

@@ -376,13 +376,13 @@ For information on request throttling at the Log Analytics service level, see [R
 
 #### Set logs query timeout
 
-Some logs queries take longer than 3 minutes to execute. The default server timeout is 3 minutes. You can increase the server timeout to a maximum of 10 minutes. In the following example, the `LogsQueryOptions` object's `serverTimeoutInSeconds` property is used to decrease the server timeout to 1 minute:
+Some logs queries take longer than 3 minutes to execute. The default server timeout is 3 minutes. You can increase the server timeout to a maximum of 10 minutes. In the following example, the `LogsQueryOptions` object's `serverTimeoutInSeconds` property is used to increase the server timeout to 10 minutes:
 
 ```ts
 // setting optional parameters
 const queryLogsOptions: LogsQueryOptions = {
   // explicitly control the amount of time the server can spend processing the query.
-  serverTimeoutInSeconds: 60
+  serverTimeoutInSeconds: 600 // 600 seconds = 10 minutes
 };
 
 const result = await logsQueryClient.queryWorkspace(

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

@@ -32,7 +32,7 @@ export async function main() {
   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,
+    serverTimeoutInSeconds: 600, // sets the timeout to 10 minutes
     // optionally enable returning additional statistics about the query's execution.
     // (by default this is off)
     includeQueryStatistics: true,

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

@@ -34,7 +34,7 @@ export async function main() {
   console.log(`Running '${kustoQuery}' over the last 5 minutes`);
   const queryLogsOptions: LogsQueryOptions = {
     // explicitly control the amount of time the server can spend processing the query.
-    serverTimeoutInSeconds: 60,
+    serverTimeoutInSeconds: 600, // sets the timeout to 10 minutes
     // optionally enable returning additional statistics about the query's execution.
     // (by default this is off)
     includeQueryStatistics: true,

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

@@ -7,8 +7,7 @@
 
 const { DefaultAzureCredential } = require("@azure/identity");
 const { Durations, LogsQueryClient, LogsQueryResultStatus } = require("@azure/monitor-query");
-const dotenv = require("dotenv");
-dotenv.config();
+require("dotenv").config();
 
 const monitorWorkspaceId = process.env.MONITOR_WORKSPACE_ID;
 
@@ -26,10 +25,10 @@ async function main() {
   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,
+    serverTimeoutInSeconds: 600,
     // optionally enable returning additional statistics about the query's execution.
     // (by default this is off)
-    includeQueryStatistics: true
+    includeQueryStatistics: true,
   };
 
   const result = await logsQueryClient.queryWorkspace(
@@ -86,3 +85,5 @@ main().catch((err) => {
   console.error("The sample encountered an error:", err);
   process.exit(1);
 });
+
+module.exports = { main };

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

@@ -7,8 +7,7 @@
 
 const { DefaultAzureCredential } = require("@azure/identity");
 const { LogsQueryClient, LogsQueryResultStatus } = require("@azure/monitor-query");
-const dotenv = require("dotenv");
-dotenv.config();
+require("dotenv").config();
 
 const monitorWorkspaceId = process.env.MONITOR_WORKSPACE_ID;
 
@@ -25,25 +24,25 @@ async function main() {
     {
       workspaceId: monitorWorkspaceId,
       query: kqlQuery,
-      timespan: { duration: "P1D" }
+      timespan: { duration: "P1D" },
     },
     {
       workspaceId: monitorWorkspaceId,
       query: "AzureActivity | summarize count()",
-      timespan: { duration: "PT1H" }
+      timespan: { duration: "PT1H" },
     },
     {
       workspaceId: monitorWorkspaceId,
       query:
         "AppRequests | take 10 | summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId",
-      timespan: { duration: "PT1H" }
+      timespan: { duration: "PT1H" },
     },
     {
       workspaceId: monitorWorkspaceId,
       query: "AppRequests | take 2",
       timespan: { duration: "PT1H" },
-      includeQueryStatistics: true
-    }
+      includeQueryStatistics: true,
+    },
   ];
 
   const result = await logsQueryClient.queryBatch(queriesBatch);
@@ -94,3 +93,5 @@ main().catch((err) => {
   console.error("The sample encountered an error:", err);
   process.exit(1);
 });
+
+module.exports = { main };

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

@@ -7,8 +7,7 @@
 
 const { DefaultAzureCredential } = require("@azure/identity");
 const { Durations, LogsQueryClient, LogsQueryResultStatus } = require("@azure/monitor-query");
-const dotenv = require("dotenv");
-dotenv.config();
+require("dotenv").config();
 
 const monitorWorkspaceId = process.env.MONITOR_WORKSPACE_ID;
 const additionalWorkspaces1 = process.env.ADDITIONAL_WORKSPACES_1 || "workspace1";
@@ -28,11 +27,11 @@ async function main() {
   console.log(`Running '${kustoQuery}' over the last 5 minutes`);
   const queryLogsOptions = {
     // explicitly control the amount of time the server can spend processing the query.
-    serverTimeoutInSeconds: 60,
+    serverTimeoutInSeconds: 600,
     // optionally enable returning additional statistics about the query's execution.
     // (by default this is off)
     includeQueryStatistics: true,
-    additionalWorkspaces: [additionalWorkspaces1, additionalWorkspaces2]
+    additionalWorkspaces: [additionalWorkspaces1, additionalWorkspaces2],
   };
 
   const result = await logsQueryClient.queryWorkspace(
@@ -87,3 +86,5 @@ main().catch((err) => {
   console.error("The sample encountered an error:", err);
   process.exit(1);
 });
+
+module.exports = { main };

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

@@ -7,9 +7,7 @@
 
 const { DefaultAzureCredential } = require("@azure/identity");
 const { Durations, MetricsQueryClient } = require("@azure/monitor-query");
-const dotenv = require("dotenv");
-
-dotenv.config();
+require("dotenv").config();
 
 const metricsResourceId = process.env.METRICS_RESOURCE_ID;
 
@@ -34,7 +32,7 @@ async function main() {
     console.log(`Picking an example list of metrics to query: ${metricNames}`);
     const metricsResponse = await metricsQueryClient.queryResource(metricsResourceId, metricNames, {
       granularity: "PT1M",
-      timespan: { duration: Durations.fiveMinutes }
+      timespan: { duration: Durations.fiveMinutes },
     });
 
     console.log(
@@ -54,3 +52,5 @@ main().catch((err) => {
   console.error("The sample encountered an error:", err);
   process.exit(1);
 });
+
+module.exports = { main };

sdk/monitor/monitor-query/samples/v1/typescript/package.json

@@ -32,7 +32,8 @@
     "@azure/identity": "^2.0.1"
   },
   "devDependencies": {
-    "typescript": "~4.4.0",
+    "@types/node": "^12.0.0",
+    "typescript": "~4.6.0",
     "rimraf": "latest"
   }
 }

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

@@ -11,7 +11,7 @@ import {
   LogsQueryClient,
   LogsTable,
   LogsQueryOptions,
-  LogsQueryResultStatus
+  LogsQueryResultStatus,
 } from "@azure/monitor-query";
 import * as dotenv from "dotenv";
 dotenv.config();
@@ -32,10 +32,10 @@ export async function main() {
   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,
+    serverTimeoutInSeconds: 600, // sets the timeout to 10 minutes
     // optionally enable returning additional statistics about the query's execution.
     // (by default this is off)
-    includeQueryStatistics: true
+    includeQueryStatistics: true,
   };
 
   const result = await logsQueryClient.queryWorkspace(

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

@@ -25,25 +25,25 @@ export async function main() {
     {
       workspaceId: monitorWorkspaceId,
       query: kqlQuery,
-      timespan: { duration: "P1D" }
+      timespan: { duration: "P1D" },
     },
     {
       workspaceId: monitorWorkspaceId,
       query: "AzureActivity | summarize count()",
-      timespan: { duration: "PT1H" }
+      timespan: { duration: "PT1H" },
     },
     {
       workspaceId: monitorWorkspaceId,
       query:
         "AppRequests | take 10 | summarize avgRequestDuration=avg(DurationMs) by bin(TimeGenerated, 10m), _ResourceId",
-      timespan: { duration: "PT1H" }
+      timespan: { duration: "PT1H" },
     },
     {
       workspaceId: monitorWorkspaceId,
       query: "AppRequests | take 2",
       timespan: { duration: "PT1H" },
-      includeQueryStatistics: true
-    }
+      includeQueryStatistics: true,
+    },
   ];
 
   const result = await logsQueryClient.queryBatch(queriesBatch);