YAML でのロード テストを構成する

YAML を使用して Azure Load Testing でロード テストを構成する方法について説明します。 テスト構成 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 構成

テストの失敗条件を使用すると、ロード テストの実行が成功したかどうかを判断する条件を定義できます。 1 つ以上の不合格条件が満たされた場合、テストは失敗したテスト結果を取得します。 ロード テストの失敗条件 使用する方法の詳細についてはを参照してください。 応答時間、待機時間などのクライアント メトリックと、サーバー側アプリ コンポーネントのサーバー側メトリックに対して、エラー条件を定義できます。

クライアント メトリック

ロード テスト全体に適用される、または特定の要求に適用される失敗条件を定義できます。 不合格条件の構造は次のとおりです。

• ロード テスト レベルでのテスト条件: Aggregate_function (client_metric) condition threshold。
• 特定の要求に適用されるテスト条件: Request: Aggregate_function (client_metric) condition threshold。

Azure Load Testing では、次のクライアント メトリックがサポートされています。

サーバー側のメトリック

サーバー側アプリ コンポーネントのサーバー側メトリックで失敗条件を定義できます。

次の表では、 serverMetrics: 構成のさまざまなフィールドについて説明します。

エラー条件の構成サンプル

次のコード スニペットは、ロード テストの失敗条件が 3 つのロード テスト構成を示しています。

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 Load Testing によって、アプリケーション コンポーネントのリソース メトリックが収集され、負荷テスト ダッシュボードに表示されます。

次の表では、 appComponents: 構成のさまざまなフィールドについて説明します。

アプリ コンポーネントの構成サンプル

次のコード スニペットは、2 つのアプリ コンポーネントを含むロード テスト構成を示しています。

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 構成

ロード テストの自動停止機能を使用すると、特定の時間枠内にエラーの割合が特定のしきい値を超えたときに、ロード テストを自動的に停止できます。 自動停止のテスト機能の 読み込みの詳細については。

Autostop 構成サンプル

次のコード スニペットは、ロード テストの失敗条件が 3 つのロード テスト構成を示しています。

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 Load Testing での 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'

次のコード スニペットは、ロード テストの構成を示しています。この構成では、子の構成ファイルを指定します。

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 Key Vault に格納し、テスト 計画で参照できます。 Azure Load Testing でのシークレットの使用 の詳細。

シークレット構成のサンプル

次のコード スニペットは、Azure Key Vault 内のシークレット 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 Load Testing を使用した環境変数の使用 の詳細。

環境変数の構成サンプル

次のコード スニペットは、環境変数の 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 Load Testing を使用したクライアント証明書の使用 の詳細。

証明書構成のサンプル

次のコード スニペットは、Azure Key Vault のクライアント証明書を参照するロード テスト構成を示しています。

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 構成

ロード テストでは、さまざまなシナリオでマネージド ID を使用できます。 マネージド ID は、Azure Key Vault からシークレットまたは証明書にアクセスし、サーバー側の障害条件とエンドポイントの認証のメトリックをフェッチするために、テストで使用できます。

次の表では、 referenceIdentities: 構成のさまざまなフィールドについて説明します。

参照 ID の構成サンプル

次のコード スニペットは、複数の ID のロード テスト構成を示しています。

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 要求を指定できます。 テスト構成 YAML ファイルでtestTypeするように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 プロパティで読み込み構成を定義するために、次のプロパティを使用します。

リージョンロード テストの構成

リージョン間で負荷を分散して、実際のトラフィック パターンをより適切にシミュレートできます。 負荷を生成するリージョンと、各リージョンからシミュレートする負荷の量を指定できます。 そのためには、リージョン名と、そのリージョンに必要なエンジン インスタンスの数を指定します。 複数のリージョンから負荷を する方法について説明します。

リージョンロード テストの構成サンプル

次のコード スニペットは、 eastus と eastasia の 2 つの Azure リージョンと、各リージョンのエンジン インスタンスの数を指定するロード テスト構成を示しています。

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 ワークフローで自動回帰テストをビルドする方法について説明します。
• シークレットと環境変数を使用してロード テストをパラメーター化する方法について説明します。
• セキュリティで保護されたエンドポイントをロード テストする方法について説明します。