在 YAML 中配置负载测试

了解如何使用 YAML 在 Azure 负载测试中配置负载测试。 使用测试配置 YAML 文件可以从持续集成和持续交付 (CI/CD) 工作流创建和运行负载测试。

负载测试 YAML 语法

负载测试配置使用以下键：

负载测试配置示例

以下 YAML 代码片段包含一个示例负载测试配置。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
subnetId: /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/sample-rg/providers/Microsoft.Network/virtualNetworks/load-testing-vnet/subnets/load-testing
configurationFiles:
  - 'sampledata.csv'
  - 'testfragment.jmx'
zipArtifacts:
   - bigdata.zip
splitAllCSVs: True
failureCriteria:
  - avg(response_time_ms) > 300
  - percentage(error) > 50
  - GetCustomerDetails: avg(latency) >200
autoStop:
  errorPercentage: 80
  timeWindow: 60
secrets:
  - name: my-secret
    value: https://akv-contoso.vault.azure.net/secrets/MySecret/abc1234567890def12345
keyVaultReferenceIdentity: /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sample-identity

failureCriteria 配置

测试失败条件使你可以定义条件，以确定负载测试运行是否成功。 如果满足一个或多个失败条件，则测试将获取失败的测试结果。 详细了解 如何使用负载测试失败条件。 可以针对客户端指标（例如响应时间、延迟等）以及服务器端应用组件的服务器端指标定义故障条件。

客户端指标

可以定义应用于整个负载测试或应用于特定请求的失败条件。 失败条件采用以下结构：

• 负载测试级别的测试条件：Aggregate_function (client_metric) condition threshold。
• 应用于特定请求的测试条件： Request: Aggregate_function (client_metric) condition threshold。

Azure 负载测试支持以下客户端指标：

服务器端指标

可以在服务器端应用组件的服务器端指标上定义失败条件。

下表描述了配置中的 serverMetrics: 不同字段：

失败条件配置示例

以下代码片段显示了负载测试配置，该配置具有三个负载测试失败条件。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
failureCriteria:
  clientMetrics:
    - avg(responseTimeMs) > 300
    - percentage(error) > 50
    - getCustomerDetails: avg(latency) > 200
  serverMetrics:
    - resourceId: /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/sample-rg/providers/Microsoft.Compute/virtualMachines/sample-vm
      metricNamespace: Microsoft.Compute/virtualMachines
      metricName: Percentage CPU
      aggregation: Average
      condition: GreaterThan
      value: 80
    - resourceId: /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/sample-rg/providers/Microsoft.Compute/virtualMachines/sample-vm
      metricNamespace: Microsoft.Compute/virtualMachines
      metricName: Available Memory
      aggregation: Average
      condition: LessThan
      value: 20

appComponents 配置

可以在负载测试期间监视服务器端资源。 详细了解 如何监视服务器端资源。 为 Azure 托管的应用程序运行负载测试时，Azure 负载测试会收集应用程序组件的资源指标，并在负载测试仪表板中显示这些指标。

下表描述了配置中的 appComponents: 不同字段：

应用组件配置示例

以下代码片段显示了一个负载测试配置，其中包含两个应用组件。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
appComponents:
  - resourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appComponentResource"
    resourceName: appComponentResource #Optional
    kind: web # Optional
    metrics:
      - name: "requests/duration"
        namespace: microsoft.insights/components 
        aggregation: "Average"
      - name: "requests/count"
        aggregation: "Total"
        namespace: microsoft.insights/components   
  - resourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appComponentResource"
    resourceName: appComponentResource #Optional
    kind: web # Optional
    metrics:
      - name: "requests/duration"
        aggregation: "Average"
        namespace: microsoft.insights/components
      - name: "requests/count"
        aggregation: "Total"
        namespace: microsoft.insights/components

autoStop 配置

负载测试自动停止功能使你能够在给定时间范围内错误百分比超过特定阈值时自动停止负载测试。 详细了解 负载测试自动停止功能。

自动停止配置示例

以下代码片段显示了负载测试配置，该配置具有三个负载测试失败条件。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
autoStop:
  errorPercentage: 80
  timeWindow: 60

properties 配置

可以为负载测试指定 JMeter 用户属性文件。 用户属性文件与测试计划和其他文件一起上传。 详细了解如何在 Azure 负载测试中使用 JMeter 用户属性。

用户属性文件配置示例

以下代码片段显示了一个负载测试配置，该配置指定用户属性文件。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
properties:
  userPropertyFile: 'user.properties'

以下代码片段显示了一个负载测试配置，该配置指定了 Locust 配置文件。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.py
testType: Locust
engineInstances: 1
properties:
  userPropertyFile: 'locust.conf'

secrets 配置

可以在 Azure 密钥库中存储机密值，并在测试计划中引用它们。 详细了解如何将 机密与 Azure 负载测试配合使用。

机密配置示例

以下代码片段显示了一个负载测试配置，该配置引用 Azure 密钥库中的机密my-secret。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
secrets:
  - name: my-secret
    value: https://akv-contoso.vault.azure.net/secrets/MySecret/abc1234567890def12345

env 配置

可以在测试计划中指定环境变量并引用它们。 详细了解如何将 环境变量与 Azure 负载测试配合使用。

环境变量配置示例

以下代码片段显示了一个负载测试配置，该配置指定环境变量 my-variable 和值 my-value。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
env:
  - name: my-variable
    value: my-value

certificates 配置

可以将客户端证书传递给负载测试。 该证书存储在 Azure Key Vault 中。 详细了解如何将 客户端证书与 Azure 负载测试配合使用。

证书配置示例

以下代码片段演示负载测试配置，该配置引用 Azure 密钥库中的客户端证书。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
certificates:
  - name: my-certificate
    value: https://akv-contoso.vault.azure.net/certificates/MyCertificate/abc1234567890def12345

referenceIdentities 配置

可以在负载测试中对各种方案使用托管标识。 托管标识可用于在测试中访问 Azure Key Vault 中的机密或证书、获取服务器端故障条件的指标和终结点的身份验证。

下表描述了配置中的 referenceIdentities: 不同字段：

参考标识配置示例

以下代码片段显示了多个标识的负载测试配置。

version: v0.1
testId: SampleTest
displayName: Sample Test
description: Load test website home page
testPlan: SampleTest.jmx
testType: JMX
engineInstances: 1
secrets:
  - name: my-secret
    value: https://akv-contoso.vault.azure.net/secrets/MySecret/abc1234567890def12345
failureCriteria:
  serverMetrics:
    - resourceId: /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/sample-rg/providers/Microsoft.Compute/virtualMachines/sample-vm
      metricNamespace: Microsoft.Compute/virtualMachines
      metricName: Percentage CPU
      aggregation: Average
      condition: GreaterThan
      value: 80
referenceIdentities:
  - kind: KeyVault
    type: UserAssigned
    value: /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sample-identity
  - kind: Metrics
    type: SystemAssigned
  - kind: Engine
    type: UserAssigned
    value: /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sample-identity
  - kind: Engine
    type: UserAssigned
    value: /subscriptions/abcdef01-2345-6789-0abc-def012345678/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sample-identity1

请求 JSON 文件

如果使用基于 URL 的测试，则可以在 JSON 文件中指定 HTTP 请求，而不是使用测试脚本。 请确保在 testType 测试配置 YAML 文件中设置它 URL 并引用请求 JSON 文件。

HTTP 请求

请求 JSON 文件使用以下属性来定义属性中的 requests 请求：

以下 JSON 代码片段包含一个请求 JSON 文件的示例：

{
    "version": "1.0",
    "scenarios": {
        "requestGroup1": {
            "requests": [
                {
                    "requestName": "add",
                    "responseVariables": [],
                    "queryParameters": [
                        {
                            "key": "param1",
                            "value": "value1"
                        }
                    ],
                    "requestType": "URL",
                    "endpoint": "https://www.contoso.com/orders",
                    "headers": {
                        "api-token": "my-token"
                    },
                    "body": "{\r\n  \"customer\": \"Contoso\",\r\n  \"items\": {\r\n\t  \"product_id\": 321,\r\n\t  \"count\": 50,\r\n\t  \"amount\": 245.95\r\n  }\r\n}",
                    "method": "POST",
                    "requestBodyFormat": "JSON"
                },
                {
                    "requestName": "get",
                    "responseVariables": [],
                    "requestType": "CURL",
                    "curlCommand": "curl --request GET 'https://www.contoso.com/orders'"
                },
            ],
            "csvDataSetConfigList": []
        }
    },
    "testSetup": [
        {
            "virtualUsersPerEngine": 1,
            "durationInSeconds": 600,
            "loadType": "Linear",
            "scenario": "requestGroup1",
            "rampUpTimeInSeconds": 30
        }
    ]
}

加载配置

请求 JSON 文件使用以下属性来定义属性中的 testSetup 负载配置：

区域负载测试配置

可以跨区域分配负载，以更好地模拟现实生活中的流量模式。 可以指定要从中生成负载的区域以及要从每个区域模拟的负载量。 为此，可以指定区域中所需的区域名称和引擎实例数。 详细了解如何 从多个区域生成负载。

区域负载测试配置示例

以下代码片段显示了一个负载测试配置，该配置指定两个 Azure 区域 eastus 以及 eastasia 每个区域的引擎实例数。

displayName: Sample Test
testPlan: sampleScript.jmx
description: 'Load test website home page'
engineInstances: 4
testId: SampleTest
testType: Locust
splitAllCSVs: False
regionalLoadTestConfig:
- region: eastus
  engineInstances: 2
- region: eastasia
  engineInstances: 2
failureCriteria:
- p90(response_time_ms) > 10000
autoStop:
  errorPercentage: 90
  timeWindow: 60

相关内容

• 了解如何在 CI/CD 工作流中生成自动化回归测试。
• 了解如何使用机密和环境变量来参数化负载测试。
• 了解如何加载测试安全端点。