[monitor-ingestion] Add perf tests (Azure#23056)

Author: timovv

common/config/rush/pnpm-lock.yaml

@@ -891,6 +891,11 @@
       "projectFolder": "sdk/monitor/perf-tests/monitor-query",
       "versionPolicyName": "test"
     },
+    {
+      "packageName": "@azure-tests/perf-monitor-ingestion",
+      "projectFolder": "sdk/monitor/perf-tests/monitor-ingestion",
+      "versionPolicyName": "test"
+    },
     {
       "packageName": "@azure-tests/perf-template",
       "projectFolder": "sdk/template/perf-tests/template",

rush.json

@@ -0,0 +1,14 @@
+# Perf tests for `monitor-ingestion`
+
+### Guide
+
+1. Build the monitor-ingestion perf tests package `rush build -t perf-monitor-ingestion`.
+2. Copy the `sample.env` file and name it as `.env`.
+3. Create the necessary test resources (either using the `New-TestResources.ps1` script or by following [this guide])
+4. Run the tests as follows:
+
+- upload logs
+  - `npm run perf-test:node -- UploadLogsTest --warmup 1 --iterations 1 --parallel 50 --duration 15`
+  - The option `--logsCount` can be used to specify the number of logs to upload.
+  - The option `--maxConcurrency` can be used to specify the maximum number of concurrent upload requests in the case that the
+    upload is split into multiple requests due to the size of the logs being uploaded exceeding 1MB.

sdk/monitor/perf-tests/monitor-ingestion/README.md

@@ -0,0 +1,48 @@
+{
+  "name": "@azure-tests/perf-monitor-ingestion",
+  "sdk-type": "perf-test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@azure/monitor-ingestion": "1.0.0-beta.2",
+    "@azure/test-utils-perf": "^1.0.0",
+    "dotenv": "^8.2.0",
+    "@azure/identity": "^2.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "^12.0.0",
+    "eslint": "^8.0.0",
+    "prettier": "^2.5.1",
+    "rimraf": "^3.0.0",
+    "tslib": "^2.2.0",
+    "ts-node": "^10.0.0",
+    "typescript": "~4.6.0"
+  },
+  "private": true,
+  "scripts": {
+    "perf-test:node": "npm run build && node dist-esm/index.spec.js",
+    "audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
+    "build": "npm run clean && tsc -p .",
+    "build:samples": "echo skipped",
+    "build:test": "echo skipped",
+    "check-format": "prettier --list-different --config ../../../../.prettierrc.json --ignore-path ../../../../.prettierignore \"test/**/*.ts\" \"*.{js,json}\"",
+    "clean": "rimraf dist dist-esm test-dist types *.tgz *.log",
+    "format": "prettier --write --config ../../../../.prettierrc.json --ignore-path ../../../../.prettierignore \"test/**/*.ts\" \"*.{js,json}\"",
+    "integration-test:browser": "echo skipped",
+    "integration-test:node": "echo skipped",
+    "integration-test": "echo skipped",
+    "lint:fix": "eslint --no-eslintrc -c ../../../.eslintrc.internal.json package.json test --ext .ts --fix --fix-type [problem,suggestion]",
+    "lint": "eslint --no-eslintrc -c ../../../.eslintrc.internal.json package.json test --ext .ts",
+    "pack": "npm pack 2>&1",
+    "unit-test:browser": "echo skipped",
+    "unit-test:node": "echo skipped",
+    "unit-test": "echo skipped",
+    "test:browser": "echo skipped",
+    "test:node": "echo skipped",
+    "test": "echo skipped"
+  }
+}

sdk/monitor/perf-tests/monitor-ingestion/package.json

@@ -0,0 +1,10 @@
+# Used to authenticate using Azure AD as a service principal for role-based authentication.
+#
+# See the documentation for `EnvironmentCredential` at the following link:
+# https://docs.microsoft.com/javascript/api/@azure/identity/environmentcredential
+AZURE_TENANT_ID=<AD tenant id or name>
+AZURE_CLIENT_ID=<ID of the user/service principal to authenticate as>
+AZURE_CLIENT_SECRET=<client secret used to authenticate to Azure AD>
+
+DATA_COLLECTION_RULE_ID=<The ID of the data collection rule>
+LOGS_INGESTION_ENDPOINT=<The logs ingestion endpoint to upload logs to>

sdk/monitor/perf-tests/monitor-ingestion/sample.env

@@ -0,0 +1,8 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { UploadLogsTest } from "./uploadLogs.spec";
+import { createPerfProgram } from "@azure/test-utils-perf";
+
+const perfProgram = createPerfProgram(UploadLogsTest);
+perfProgram.run();

sdk/monitor/perf-tests/monitor-ingestion/test/index.spec.ts

@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+import { PerfTest, getEnvVar } from "@azure/test-utils-perf";
+import { LogsIngestionClient } from "@azure/monitor-ingestion";
+import { DefaultAzureCredential } from "@azure/identity";
+
+// Expects the .env file at the same level
+import * as dotenv from "dotenv";
+dotenv.config();
+
+export abstract class MonitorIngestionPerfTest<TOptions> extends PerfTest<TOptions> {
+  client: LogsIngestionClient;
+
+  constructor() {
+    super();
+    const tokenCredential = new DefaultAzureCredential();
+    this.client = new LogsIngestionClient(getEnvVar("LOGS_INGESTION_ENDPOINT"), tokenCredential);
+  }
+}