Skip to content

Commit ff96a13

Browse files
Merge pull request #277420 from Nagarjuna-Vipparthi/main
YAML updates for multi-region load tests
2 parents d9a8aec + 34a0126 commit ff96a13

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

articles/load-testing/reference-test-config-yaml.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ A load test configuration uses the following keys:
4141
| `keyVaultReferenceIdentity` | string | N | | Resource ID of the user-assigned managed identity for accessing the secrets from your Azure Key Vault. If you use a system-managed identity, this information isn't needed. Make sure to grant this user-assigned identity access to your Azure key vault. Learn more about [managed identities in Azure Load Testing](./how-to-use-a-managed-identity.md). |
4242
| `subnetId` | string | N | | Resource ID of the virtual network subnet for testing privately hosted endpoints. This subnet hosts the injected test engine VMs. For more information, see [how to load test privately hosted endpoints](./how-to-test-private-endpoint.md). |
4343
| `publicIPDisabled` | boolean | N | | Disable the deployment of a public IP address, load balancer, and network security group while testing a private endpoint. For more information, see [how to load test privately hosted endpoints](./how-to-test-private-endpoint.md). |
44+
| `regionalLoadTestConfig` | object | N | | Distribute load across regions to simulate user traffic from multiple regions. For more information, See [regional load test configuration](#regional-load-test-configuration) for more details. |
4445

4546
### Load test configuration sample
4647

@@ -329,6 +330,40 @@ The requests JSON file uses the following properties for defining the load confi
329330
| `spikeMultiplier` | integer | Spike | The factor to multiply the number of target users with during the spike duration. |
330331
| `spikeHoldTimeInSeconds` | integer | Spike | Total duration in seconds to maintain the spike load. |
331332

333+
### Regional load test configuration
334+
335+
You can distribute load across regions to better simulate real life traffic patterns. You can specify the regions that you want to generate the load from and the amount of load that you want to simulate from each region. You can do that by specifying the region name and the number of engine instances that you want in that region. Learn more about [generating load from multiple regions](./how-to-generate-load-from-multiple-regions.md).
336+
337+
| Key | Type | Default value | Description |
338+
| ----- | ----- | ----- | ---- |
339+
| `region` | string | | Name of the Azure region. |
340+
| `engineInstances` | integer | | Number of engine instances for that Azure region. |
341+
342+
#### Regional load test configuration sample
343+
344+
The following code snippet shows a load test configuration, which specifies two Azure regions `eastus` and `eastasia` and the number of engine instances for each region.
345+
346+
```yaml
347+
displayName: Sample Test
348+
testPlan: sampleScript.jmx
349+
description: 'Load test website home page'
350+
engineInstances: 4
351+
testId: SampleTest
352+
testType: Locust
353+
splitAllCSVs: False
354+
regionalLoadTestConfig:
355+
- region: eastus
356+
engineInstances: 2
357+
- region: eastasia
358+
engineInstances: 2
359+
failureCriteria:
360+
- p90(response_time_ms) > 10000
361+
autoStop:
362+
errorPercentage: 90
363+
timeWindow: 60
364+
```
365+
366+
332367
## Related content
333368

334369
- Learn how to build [automated regression testing in your CI/CD workflow](./quickstart-add-load-test-cicd.md).

0 commit comments

Comments
 (0)