Konfigurowanie testu obciążeniowego w języku YAML

Dowiedz się, jak skonfigurować test obciążeniowy w usłudze Azure Load Testing przy użyciu języka YAML. Plik YAML konfiguracji testu służy do tworzenia i uruchamiania testów obciążeniowych z przepływu pracy ciągłej integracji i ciągłego dostarczania (CI/CD).

Składnia YAML testu obciążeniowego

Konfiguracja testu obciążeniowego używa następujących kluczy:

Przykład konfiguracji testu obciążeniowego

Poniższy fragment kodu YAML zawiera przykładową konfigurację testu obciążeniowego.

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 konfiguracja

Kryteria testu niepowodzenia umożliwiają zdefiniowanie warunków w celu określenia, czy przebieg testu obciążeniowego zakończył się pomyślnie, czy nie. Jeśli zostanie spełniony co najmniej jeden kryteria niepowodzenia, test otrzyma wynik testu, który zakończył się niepowodzeniem. Dowiedz się więcej o korzystaniu z kryteriów niepowodzenia testu obciążeniowego. Można zdefiniować kryteria niepowodzenia dotyczące metryk klienta, takich jak czas odpowiedzi, opóźnienie itp., oraz metryki po stronie serwera dla składników aplikacji po stronie serwera.

Metryki klienta

Można zdefiniować kryteria niepowodzenia, które mają zastosowanie do całego testu obciążeniowego lub które mają zastosowanie do określonego żądania. Kryteria niepowodzenia mają następującą strukturę:

• Kryteria testu na poziomie testu obciążeniowego: Aggregate_function (client_metric) condition threshold.
• Kryteria testu stosowane do określonych żądań: Request: Aggregate_function (client_metric) condition threshold.

Testowanie obciążenia platformy Azure obsługuje następujące metryki klienta:

Metryki po stronie serwera

Kryteria niepowodzenia można zdefiniować w metrykach po stronie serwera dla składników aplikacji po stronie serwera.

W poniższej serverMetrics: tabeli opisano różne pola w konfiguracji:

Przykład konfiguracji kryteriów niepowodzenia

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która ma trzy kryteria niepowodzenia testu obciążeniowego.

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 konfiguracja

Zasoby po stronie serwera można monitorować podczas testu obciążeniowego. Dowiedz się więcej o monitorowaniu zasobów po stronie serwera. Po uruchomieniu testu obciążeniowego dla aplikacji hostowanej na platformie Azure usługa Azure Load Testing zbiera metryki zasobów dla składników aplikacji i przedstawia je na pulpicie nawigacyjnym testu obciążeniowego.

W poniższej appComponents: tabeli opisano różne pola w konfiguracji:

Przykład konfiguracji składników aplikacji

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która ma dwa składniki aplikacji.

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 konfiguracja

Funkcja automatycznego zatrzymywania testów obciążeniowych umożliwia automatyczne zatrzymywanie testu obciążeniowego, gdy wartość procentowa błędu przekracza określony próg w danym przedziale czasu. Dowiedz się więcej na temat funkcji automatycznego zatrzymania testu obciążeniowego.

Przykład konfiguracji automatycznego zatrzymania

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która ma trzy kryteria niepowodzenia testu obciążeniowego.

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 konfiguracja

Możesz określić plik właściwości użytkownika JMeter dla testu obciążeniowego. Plik właściwości użytkownika jest przekazywany wraz z planem testu i innymi plikami. Dowiedz się więcej o korzystaniu z właściwości użytkownika JMeter w usłudze Azure Load Testing.

Przykład konfiguracji pliku właściwości użytkownika

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która określa plik właściwości użytkownika.

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'

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która określa plik konfiguracji 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 konfiguracja

Wartości wpisów tajnych można przechowywać w usłudze Azure Key Vault i odwoływać się do nich w planie testu. Dowiedz się więcej na temat używania wpisów tajnych z usługą Azure Load Testing.

Przykład konfiguracji wpisów tajnych

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która odwołuje się do wpisu tajnego my-secret w usłudze Azure Key Vault.

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 konfiguracja

Zmienne środowiskowe można określić i odwołać się do nich w planie testu. Dowiedz się więcej na temat używania zmiennych środowiskowych z usługą Azure Load Testing.

Przykład konfiguracji zmiennej środowiskowej

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która określa zmienną środowiskową my-variable i wartość 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 konfiguracja

Certyfikaty klienta można przekazać do testu obciążeniowego. Certyfikat jest przechowywany w usłudze Azure Key Vault. Dowiedz się więcej na temat używania certyfikatów klienta z usługą Azure Load Testing.

Przykład konfiguracji certyfikatu

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która odwołuje się do certyfikatu klienta w usłudze 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 konfiguracja

Tożsamości zarządzane można używać w różnych scenariuszach w teście obciążeniowym. Tożsamości zarządzane mogą być używane w teście na potrzeby uzyskiwania dostępu do wpisów tajnych lub certyfikatów z usługi Azure Key Vault, pobierania metryk dla kryteriów niepowodzenia po stronie serwera i uwierzytelniania punktów końcowych.

W poniższej referenceIdentities: tabeli opisano różne pola w konfiguracji:

Przykład konfiguracji tożsamości odwołań

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego dla wielu tożsamości.

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

Żądanie pliku JSON

Jeśli używasz testu opartego na adresach URL, możesz określić żądania HTTP w pliku JSON zamiast używać skryptu testowego. Pamiętaj, aby ustawić wartość testType na URL w pliku YAML konfiguracji testu i odwołać się do pliku JSON żądań.

Żądania HTTP

Plik JSON żądań używa następujących właściwości do definiowania żądań we requests właściwości :

Poniższy fragment kodu JSON zawiera przykładowy plik JSON żądań:

{
    "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
        }
    ]
}

Ładowanie konfiguracji

Plik JSON żądań używa następujących właściwości do zdefiniowania konfiguracji ładowania we testSetup właściwości :

Konfiguracja regionalnego testu obciążeniowego

Obciążenie można dystrybuować między regionami, aby lepiej symulować rzeczywiste wzorce ruchu. Możesz określić regiony, z których chcesz wygenerować obciążenie, oraz ilość obciążenia, które chcesz symulować z każdego regionu. Można to zrobić, określając nazwę regionu i liczbę wystąpień aparatu, które mają być w tym regionie. Dowiedz się więcej na temat generowania obciążenia z wielu regionów.

Przykład konfiguracji testu obciążenia regionalnego

Poniższy fragment kodu przedstawia konfigurację testu obciążeniowego, która określa dwa regiony eastus platformy Azure i eastasia liczbę wystąpień aparatu dla każdego regionu.

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

Treści powiązane

• Dowiedz się, jak utworzyć zautomatyzowane testowanie regresji w przepływie pracy ciągłej integracji/ciągłego wdrażania.
• Dowiedz się, jak sparametryzować testy obciążeniowe przy użyciu wpisów tajnych i zmiennych środowiskowych.
• Dowiedz się, jak załadować zabezpieczone punkty końcowe.