fixes and documentation

Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/ARMTemplate/README.md

@@ -0,0 +1,112 @@
+# Running benchmarks on ARM Tempaltes
+
+[ARM Templates](https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/) makes executing the Azure Cosmos DB SDK Benchmark extremely easy, with very few steps involved, and it's more cost-effective than using Virtual Machines for burst or single-use scenarios. Plus, it lets you test and evaluate performance quickly on multiple resource (CPU/RAM) configurations and across multiple Azure regions seamlessly.
+
+For the below steps, you will **need an Azure Subscription**.
+
+## Steps
+
+### Step 1 - Download Tempalte
+
+You **do not need** to clone this repository, just obtain a copy of the [benchmarkTemplate](./benchmarkTemplate.json) and [parameters](./parameters.json) file.
+
+### Step 2 - Customize the YAML file
+
+The Parameters JSON file contains a list of configuration options that you need to populate for the Azure Cosmos DB account you want to execute the benchmark tests on.
+
+```json
+ "ENDPOINT": {
+      "value": "<your-endpoint-here>"
+    },
+"KEY": {
+    "value": "<your-key-here>"
+},
+"THROUGHPUT": {
+    "value": "100000"
+},
+"DOCUMENTS": {
+    "value": "200000"
+},
+"PARALLELISM": {
+    "value": "-1"
+},
+"CLEANUPFINISH": {
+    "value": "false"
+}
+```
+
+Please populate the `ENDPOINT` and `KEY` for your Azure Cosmos DB account. You can [obtain these from the Azure Portal or through CLI](https://docs.microsoft.com/azure/cosmos-db/secure-access-to-data#master-keys).
+
+Optionally you can modify the other parameters, such as the `THROUGHPUT` for the container that will get created, the amount of `DOCUMENTS` to insert, the degree of `PARALLELISM`, and if you want the container to be deleted after the benchmark is run (`CLEANUPFINISH` `true/false`).
+
+Additionally, the file lets you customize the size of the instance, which you can make as similar as possible to the instance you will be running in production to simulate results.
+
+```json
+"cpuCores": {
+      "value": "4"
+    },
+"memoryInGb": {
+    "value": "8"
+}
+```
+
+For a complete reference of options, please visit the [official Azure container instance ARM Template refrence](https://learn.microsoft.com/en-us/azure/templates/microsoft.containerinstance/containergroups?pivots=deployment-language-arm-template).
+
+### Step 3 - Obtain Azure CLI
+
+We'll be using [Azure CLI](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest) to create the Azure Container Instance and execute the YAML file. Azure CLI is cross-platform.
+
+After installing the Azure CLI, you will need to [login](https://docs.microsoft.com/cli/azure/authenticate-azure-cli?view=azure-cli-latest) into the subscription you want to provision and execute the benchmark on.
+
+### Step 4 - Create Respurce Group
+
+The goal behind the benchmark is to simulate load. Ideally you want to co-locate the instance that will be executing the benchmark with your Azure Cosmos DB account, so the first step would be to **create a Resource Group** on the same location. For example, if your Azure Cosmos DB account is deployed on East US, we can use `az group create` to create this Resource Group:
+
+```bash
+$resourceGroupName = "CosmosDBBenchmark"
+az group create --name $resourceGroupName --location eastus
+```
+
+For a complete list of options see the [documentation for `az group create`](https://docs.microsoft.com/cli/azure/group?view=azure-cli-latest#az-group-create).
+
+### Step 5 - Execute the benchmark
+
+Once the Resource Group is created in the correct location, we can use the ARM template to provision the Azure Container Instance and execute the benchmark.
+
+Assuming your prompt is on the folder with the customized template file:
+
+```bash
+az deployment group create --resource-group <your-resource-group> --template-file benchmarkTemplate.json --parameters parameters.json
+```
+
+This command will start the provisioning:
+
+1. It will create a Linux container named `cosmosdbsdkperf` and provision an image with NET Core inside an instance with the configured CPU and RAM.
+![Provisioned Container Instance](./arm1.png)
+2. Clone the Azure Cosmos DB SDK repository with the required files
+3. Execute the benchmark and provide output logs
+4. Stop the instance
+
+While the container instance is running (or after), you can either use the Azure Portal or the Azure CLI to check the benchmark results with:
+
+```bash
+az container logs -g $resourceGroupName -n cosmosdbsdkperf
+```
+
+The logs will show the information, including the initial parameters:
+
+![Initial benchmark parameters](./arm2.png)
+
+And the results:
+
+![Benchmark results](./arm3.png)
+
+### Step 6 - Clean up
+
+If you want to remove the Benchmark instance, you can also do so from the Azure CLI:
+
+```bash
+az container delete -g $resourceGroupName -n cosmosdbsdkperf
+```
+
+**Remember to delete the Database and Container** that were created for the Benchmark in case you did not use the `CLEANUPFINISH` parameter as `true`.

Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/ARMTemplate/template.json → Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/ARMTemplate/benchmarkTemplate.json

@@ -38,7 +38,7 @@
     "CLEANUPFINISH": {
       "type": "string",
       "metadata": {
-        "description": "Whether to delete the contaienr after the document is run."
+        "description": "Whether to delete the contaianer after the document is run."
       },
       "defaultValue": "false"
     },
@@ -123,12 +123,13 @@
               "command": [
                 "/bin/bash",
                 "-c",
-                "[concat('cd /mnt/gitrepos/azure-cosmos-dotnet-v3/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/AzureContainerInstances;export ENDPOINT=\"', parameters('ENDPOINT'),'\";export KEY=\"', parameters('KEY'),'\";export THROUGHPUT=\"', parameters('THROUGHPUT'),'\";export DOCUMENTS=\"', parameters('DOCUMENTS'),'\";export PARALLELISM=\"', parameters('PARALLELISM'),'\";export CLEANUPFINISH=\"', parameters('CLEANUPFINISH'),'\";chmod +x run.sh;./run.sh')]"
+                "[concat('cd /mnt/gitrepos/azure-cosmos-dotnet-v3/Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/ARMTemplate;export ENDPOINT=\"', parameters('ENDPOINT'),'\";export KEY=\"', parameters('KEY'),'\";export THROUGHPUT=\"', parameters('THROUGHPUT'),'\";export DOCUMENTS=\"', parameters('DOCUMENTS'),'\";export PARALLELISM=\"', parameters('PARALLELISM'),'\";export CLEANUPFINISH=\"', parameters('CLEANUPFINISH'),'\";chmod +x run.sh;./run.sh')]"
               ]
             }
           }
         ],
         "osType": "Linux",
+        "restartPolicy": "Never",
         "ipAddress": {
           "type": "Public",
           "ports": [

Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/ARMTemplate/parameters.json

@@ -8,6 +8,18 @@
     "KEY": {
       "value": "<your-key-here>"
     },
+    "THROUGHPUT": {
+      "value": "100000"
+    },
+    "DOCUMENTS": {
+      "value": "200000"
+    },
+    "PARALLELISM": {
+      "value": "-1"
+    },
+    "CLEANUPFINISH": {
+      "value": "false"
+    },
     "containergroupname": {
       "value": "CosmosDBBenchmark"
     },
@@ -16,6 +28,12 @@
     },
     "volumename": {
       "value": "cosmosdbsdk"
+    },
+    "cpuCores": {
+      "value": "4"
+    },
+    "memoryInGb": {
+      "value": "8"
     }
   }
 }

Microsoft.Azure.Cosmos.Samples/Tools/Benchmark/ARMTemplate/run.sh

@@ -0,0 +1,2 @@
+cd ..
+dotnet run -c Release -e ${ENDPOINT} -k ${KEY} -t ${THROUGHPUT} -n ${DOCUMENTS} --pl ${PARALLELISM} --CleanupOnFinish ${CLEANUPFINISH} -w InsertV2BenchmarkOperation