[service-bus] Make stress/perf easier to run with separate scripts and improve telemetry (Azure#13475)

* Fixing a few problems and making telemetry better:
* The summary events now show all the individual counts as queryable fields in customDimensions
* Fixed a bug in runContainer.js and also made it easier to launch a container for any arbitrary script
* Added in an additional testName field to make it simpler to group telemetry by run

Author: richardpark-msft

sdk/servicebus/service-bus/test/stress/runcontainer.js

@@ -1,26 +1,45 @@
 const dotenv = require("dotenv");
+const minimist = require("minimist");
+const fs = require("fs");
+const path = require("path");
 const { spawnSync } = require("child_process");
 
 dotenv.config();
 
 const serviceBusConnectionString = process.env.SERVICEBUS_CONNECTION_STRING;
 const appInsightsInstrumentationKey = process.env.APPINSIGHTS_INSTRUMENTATIONKEY;
 const resourceGroup = process.env.RESOURCE_GROUP;
-const registryUserName = process.env.REGISTRY_USERNAME
-const registryPassword = process.env.REGISTRY_PASSWORD
+const registryUserName = process.env.REGISTRY_USERNAME;
+const registryPassword = process.env.REGISTRY_PASSWORD;
 const registryName = process.env.REGISTRY_NAME;
 
 const imageName = `${registryName}/sb-stressperf:test`;
-const containerInstanceName = `${resourceGroup}-sb-stressperf`;
 
 function spawn(command) {
-    const ret = spawnSync(command, { shell: true, stdio: "inherit" });
+  const ret = spawnSync(command, { shell: true, stdio: "inherit" });
 
-    if (ret.status !== 0) {
-        throw new Error(`${command} failed with exit code ${ret.status}`);
-    }
+  if (ret.status !== 0) {
+    throw new Error(`${command} failed with exit code ${ret.status}`);
+  }
 }
 
+// which script do we want to run?
+/** @type {{testToRun: string}} */
+const options = minimist(process.argv, {
+  string: ["testToRun"]
+});
+
+if (!options.testToRun || !fs.existsSync(path.join("dist", options.testToRun))) {
+  console.error("Usage: runcontainer.js --testToRun <name of file in `dist`>");
+  process.exit(1);
+}
+
+const { name: testFileNameWithoutExtension } = path.parse(options.testToRun);
+const containerInstanceName = `${resourceGroup}-sb-stressperf-${testFileNameWithoutExtension.toLowerCase()}`;
+
+console.log(`Running \`npm run build\``);
+spawn(`npm run build`);
+
 console.log(`Building container image: ${imageName}...`);
 spawn(`docker build -t "${imageName}" --no-cache .`);
 
@@ -30,19 +49,29 @@ spawn(`docker push "${imageName}"`);
 console.log(`Deleting Azure Container Instance (if exists)`);
 spawn(`az container delete --resource-group "${resourceGroup}" --name "${containerInstanceName}"`);
 
-console.log(`Creating Azure Container Instance for stress/perf...`);
-spawn(`az container create --resource-group "${resourceGroup}" --name "${containerInstanceName}" ` +
-    `--image ${registryName}/sb-perfstress:test ` +
+console.log(`Creating Azure Container Instance for stress/perf that runs ${options.testToRun}`);
+spawn(
+  `az container create --resource-group "${resourceGroup}" --name "${containerInstanceName}" ` +
+    `--image ${imageName}  ` +
     "--cpu 1 --memory 0.7 " +
     "--restart-policy Never " +
     `--registry-username ${registryUserName} ` +
     `--registry-password "${registryPassword}" ` +
-    `--command-line "node /src/scenarioBatchReceive.js" ` +
-    `--secure-environment-variables "SERVICEBUS_CONNECTION_STRING=${serviceBusConnectionString}" "APPINSIGHTS_INSTRUMENTATIONKEY=${appInsightsInstrumentationKey}"`);
+    `--command-line "node /src/${options.testToRun}" ` +
+    `--secure-environment-variables "SERVICEBUS_CONNECTION_STRING=${serviceBusConnectionString}" "APPINSIGHTS_INSTRUMENTATIONKEY=${appInsightsInstrumentationKey}"`
+);
 
-console.log(`Done - there will be a new Azure Container Instance named '${containerInstanceName}' in the '${resourceGroup}' resource group.\n`);
+console.log(
+  `Done - there will be a new Azure Container Instance named '${containerInstanceName}' in the '${resourceGroup}' resource group.\n`
+);
 
 console.log(`Some other commands you might find useful to manage your container:\n`);
-console.log(`az container stop --resource-group "${resourceGroup}" --name "${containerInstanceName}"`);
-console.log(`az container delete --resource-group "${resourceGroup}" --name "${containerInstanceName}"`);
-console.log(`az container logs --resource-group "${resourceGroup}" --name "${containerInstanceName}" --follow`);
+console.log(
+  `az container stop --resource-group "${resourceGroup}" --name "${containerInstanceName}"`
+);
+console.log(
+  `az container delete --resource-group "${resourceGroup}" --name "${containerInstanceName}"`
+);
+console.log(
+  `az container logs --resource-group "${resourceGroup}" --name "${containerInstanceName}" --follow`
+);

sdk/servicebus/service-bus/test/stress/scenarioBatchReceive.ts

@@ -1,4 +1,8 @@
-import { ServiceBusClient, ServiceBusReceiver, ServiceBusReceiverOptions } from "@azure/service-bus";
+import {
+  ServiceBusClient,
+  ServiceBusReceiver,
+  ServiceBusReceiverOptions
+} from "@azure/service-bus";
 import { SBStressTestsBase } from "./stressTestsBase";
 import { delay } from "rhea-promise";
 import parsedArgs from "minimist";
@@ -71,6 +75,7 @@ export async function scenarioReceiveBatch() {
   const startedAt = new Date();
 
   const stressBase = new SBStressTestsBase({
+    testName: "batchAndReceive",
     snapshotFocus: ["send-info", "receive-info"]
   });
   const sbClient = new ServiceBusClient(connectionString);

sdk/servicebus/service-bus/test/stress/scenarioCloseOpen.ts

@@ -49,6 +49,7 @@ export async function scenarioClose() {
   const startedAt = new Date();
 
   const stressBase = new SBStressTestsBase({
+    testName: "closeOpen",
     snapshotFocus: ["send-info", "receive-info", "close-info"]
   });
   let sbClient = new ServiceBusClient(connectionString);

sdk/servicebus/service-bus/test/stress/scenarioPeekMessages.ts

@@ -50,6 +50,7 @@ export async function scenarioPeekMessages() {
   const startedAt = new Date();
 
   const stressBase = new SBStressTestsBase({
+    testName: "peekMessages",
     snapshotFocus: ["send-info", "receive-info"]
   });
   const sbClient = new ServiceBusClient(connectionString);

sdk/servicebus/service-bus/test/stress/scenarioRenewMessageLock.ts

@@ -58,6 +58,7 @@ export async function main() {
   const startedAt = new Date();
 
   const stressBase = new SBStressTestsBase({
+    testName: "renewMessageLock",
     snapshotFocus: ["send-info", "receive-info", "message-lock-renewal-info"]
   });
   const sbClient = new ServiceBusClient(connectionString);

sdk/servicebus/service-bus/test/stress/scenarioRenewSessionLock.ts

@@ -73,6 +73,7 @@ export async function scenarioRenewSessionLock() {
   const startedAt = new Date();
 
   const stressBase = new SBStressTestsBase({
+    testName: "renewSessionLock",
     snapshotFocus: ["send-info", "receive-info", "session-lock-renewal-info"]
   });
 

sdk/servicebus/service-bus/test/stress/scenarioSend.ts

@@ -42,7 +42,7 @@ async function main() {
     totalNumberOfMessagesToSend,
     useScheduleApi
   } = testOptions;
-  const stressBase = new SBStressTestsBase({ snapshotFocus: ["send-info"] });
+  const stressBase = new SBStressTestsBase({ testName: "send", snapshotFocus: ["send-info"] });
   const sbClient = new ServiceBusClient(connectionString);
 
   await stressBase.init(undefined, undefined, testOptions);

sdk/servicebus/service-bus/test/stress/scenarioStreamingReceive.ts

@@ -1,4 +1,8 @@
-import { ServiceBusClient, ServiceBusReceiver, ServiceBusReceiverOptions } from "@azure/service-bus";
+import {
+  ServiceBusClient,
+  ServiceBusReceiver,
+  ServiceBusReceiverOptions
+} from "@azure/service-bus";
 import { SBStressTestsBase } from "./stressTestsBase";
 import { delay } from "rhea-promise";
 import parsedArgs from "minimist";
@@ -74,6 +78,7 @@ export async function scenarioStreamingReceive() {
   const startedAt = new Date();
 
   const stressBase = new SBStressTestsBase({
+    testName: "streamingReceive",
     snapshotFocus: ["send-info", "receive-info", "message-lock-renewal-info"]
   });
   const sbClient = new ServiceBusClient(connectionString);