Configurar um teste de carga YAML

Saiba como configurar seu teste de carga no Teste de Carga do Azure usando o YAML. Use o arquivo YAML de configuração de teste para criar e executar testes de carga do fluxo de trabalho de CI/CD (integração contínua e entrega contínua).

Sintaxe YAML do teste de carga

Uma configuração de teste de carga usa as seguintes chaves:

Exemplo de configuração de teste de carga

O snippet yaml a seguir contém uma configuração de teste de carga de exemplo.

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 configuração

Os critérios de falha de teste permitem que você defina condições para determinar se uma execução de teste de carga foi bem-sucedida ou não. Se um ou mais critérios de reprovação forem atendidos, o teste obterá um resultado de teste com falha. Saiba mais sobre como usar critérios de falha no teste de carga. Você pode definir critérios de falha em métricas do cliente, como tempo de resposta, latência etc., e em métricas do lado do servidor para os componentes do aplicativo do lado do servidor.

Métricas do cliente

Você pode definir critérios de reprovação que se aplicam a todo o teste de carga ou que se aplicam a uma solicitação específica. Os critérios de falha têm a seguinte estrutura:

• Critérios de teste no nível do teste de carga: Aggregate_function (client_metric) condition threshold.
• Critérios de teste aplicados a solicitações específicas: Request: Aggregate_function (client_metric) condition threshold.

O Teste de Carga do Azure dá suporte às seguintes métricas de cliente:

Métricas do lado do servidor

Você pode definir critérios de falha em métricas do lado do servidor para seus componentes de aplicativo do lado do servidor.

A tabela a seguir descreve os diferentes campos na serverMetrics: configuração:

Exemplo de configuração de critérios de falha

O snippet de código a seguir mostra uma configuração de teste de carga, que tem três critérios de falha de teste de carga.

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 configuração

Você pode monitorar recursos do lado do servidor durante o teste de carga. Saiba mais sobre como monitorar recursos do lado do servidor. Quando você executa um teste de carga para um aplicativo hospedado no Azure, o Teste de Carga do Azure coleta métricas de recursos para seus componentes de aplicativo e as apresenta no painel de teste de carga.

A tabela a seguir descreve os diferentes campos na appComponents: configuração:

Exemplo de configuração de Componentes de Aplicativo

O snippet de código a seguir mostra uma configuração de teste de carga, que tem dois componentes de aplicativo.

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 configuração

A funcionalidade de parada automática do teste de carga permite que você pare automaticamente um teste de carga quando a porcentagem de erro excede um limite específico durante uma determinada janela de tempo. Saiba mais sobre a funcionalidade de parada automática do teste de carga.

Exemplo de configuração de parada automática

O snippet de código a seguir mostra uma configuração de teste de carga, que tem três critérios de falha de teste de carga.

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 configuração

Você pode especificar um arquivo de propriedades do usuário JMeter para o teste de carga. O arquivo de propriedades do usuário é carregado junto com o plano de teste e outros arquivos. Saiba mais sobre como usar as propriedades de usuário do JMeter no Teste de Carga do Azure.

Exemplo de configuração do arquivo de propriedades do usuário

O snippet de código a seguir mostra uma configuração de teste de carga, que especifica um arquivo de propriedades do usuário.

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'

O snippet de código a seguir mostra uma configuração de teste de carga, que especifica um arquivo de configuração do 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 configuração

Você pode armazenar valores secretos no Azure Key Vault e referenciá-los em seu plano de teste. Saiba mais sobre como usar segredos com o Teste de Carga do Azure.

Exemplo de configuração de segredos

O snippet de código a seguir mostra uma configuração de teste de carga, que faz referência a um segredo my-secret no 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 configuração

Você pode especificar variáveis de ambiente e referenciá-las em seu plano de teste. Saiba mais sobre como usar variáveis de ambiente com o Teste de Carga do Azure.

Exemplo de configuração de variável de ambiente

O snippet de código a seguir mostra uma configuração de teste de carga, que especifica uma variável my-variable de ambiente e um valor 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 configuração

Você pode passar certificados de cliente para o teste de carga. O certificado é armazenado no Azure Key Vault. Saiba mais sobre como usar certificados de cliente com o Teste de Carga do Azure.

Exemplo de configuração de certificado

O snippet de código a seguir mostra uma configuração de teste de carga, que faz referência a um certificado de cliente no 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 configuração

Você pode usar identidades gerenciadas para vários cenários em seu teste de carga. As identidades gerenciadas podem ser usadas no teste para acessar os segredos ou certificados do Azure Key Vault, buscando métricas para critérios de falha do servidor e autenticação de seus pontos de extremidade.

A tabela a seguir descreve os diferentes campos na referenceIdentities: configuração:

Exemplo de configuração de identidades de referência

O snippet de código a seguir mostra uma configuração de teste de carga para várias identidades.

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

Arquivo JSON de solicitações

Se você usar um teste baseado em URL, poderá especificar as solicitações HTTP em um arquivo JSON em vez de usar um script de teste. Certifique-se de definir o testType to URL no arquivo YAML de configuração de teste e faça referência ao arquivo JSON de solicitações.

Solicitações HTTP

O arquivo JSON de solicitações usa as seguintes propriedades para definir solicitações na requests propriedade:

O snippet JSON a seguir contém um exemplo de arquivo JSON de solicitações:

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

Configuração de carga

O arquivo JSON requests usa as seguintes propriedades para definir a configuração de carregamento na testSetup propriedade:

Configuração de teste de carga regional

Você pode distribuir a carga entre regiões para simular melhor os padrões de tráfego da vida real. Você pode especificar as regiões das quais deseja gerar a carga e a quantidade de carga que deseja simular de cada região. Você pode fazer isso especificando o nome da região e o número de instâncias do mecanismo que deseja nessa região. Saiba mais sobre como gerar carga de várias regiões.

Exemplo de configuração de teste de carga regional

O snippet de código a seguir mostra uma configuração de teste de carga, que especifica duas regiões eastus do Azure e eastasia o número de instâncias de mecanismo para cada região.

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

Conteúdo relacionado

• Saiba como criar testes de regressão automatizados em seu fluxo de trabalho de CI/CD.
• Saiba como parametrizar testes de carga com segredos e variáveis de ambiente.
• Saiba como realizar o teste de carga de pontos de extremidade protegidos.