Escrever uma configuração JSON para o esquema de múltiplas verificações do Node.js

O esquema de múltiplas verificações do Node.js permite criar canários que realizam múltiplas verificações de validação em uma única execução de canário. Esse esquema é útil quando você deseja testar vários endpoints, validar diferentes aspectos da aplicação ou realizar uma série de verificações relacionadas em sequência.

Estrutura da configuração primária

A configuração primária define a estrutura geral do canário do esquema de API avançado.

Exemplo do

{
  "globalSettings": {
    "stepTimeout": 30000,
    "userAgent": "CloudWatch-Synthetics-Advanced/1.0"
  },
  "variables": {
    "baseUrl": "https://api.example.com",
    "apiVersion": "v1"
  },
  "steps": {
    "1": {
      "stepName": "healthCheck",
      "checkerType": "HTTP",
      "url": "${baseUrl}/health",
      "httpMethod": "GET"
    }
  }
}
      

Regras de validação

Configurações globais

As definições globais fornecem configurações padrão que se aplicam a todas as etapas, a menos que sejam substituídas no nível da etapa.

Propriedades

Exemplo do

{
  "globalSettings": {
    "stepTimeout": 60000,
    
  }
}
      

Gerenciamento de variáveis e dados

As variáveis permitem definir valores reutilizáveis que podem ser referenciados em toda a configuração usando a sintaxe ${variableName}.

Propriedades variáveis

Limitações

Exemplo do

{
  "variables": {
    "baseUrl": "https://api.example.com",
    "apiKey": "${AWS_SECRET:my-api-key}",
    "timeout": "30000",
    "userEmail": "test@example.com"
  }
}
      

Uso da configuração

{
  "steps": {
    "1": {
      "url": "${baseUrl}/users",
      "timeout": "${timeout}",
      "headers": {
        "Authorization": "Bearer ${apiKey}"
      }
    }
  }
}

      

Definições de etapas

As etapas definem operações de monitoramento individuais. Cada etapa é numerada de 1 a 10 e contém um tipo específico de verificação.

Propriedades das etapas comuns

Validação de nome de etapa

Numeração das etapas

Exemplo do

{
  "steps": {
    "1": {
      "stepName": "loginAPI",
      "checkerType": "HTTP",
      "url": "https://api.example.com/login",
      "httpMethod": "POST"
    },
    "2": {
      "stepName": "dnsCheck",
      "checkerType": "DNS",
      "domain": "example.com"
    }
  }
}

Tipos de verificação

Verificações HTTP

Monitore endpoints e APIs Web com validação abrangente de solicitações e respostas.

Propriedades necessárias

Propriedades opcionais

Exemplo do

{
  "stepName": "createUser",
  "checkerType": "HTTP",
  "url": "https://api.example.com/users",
  "httpMethod": "POST",
  "timeout": 15000,
  "headers": {
    "Content-Type": "application/json",
    "X-API-Version": "v1"
  },
  "body": "{\"name\":\"John Doe\",\"email\":\"john@example.com\"}",
  "authentication": {
    "type": "API_KEY",
    "apiKey": "${AWS_SECRET:api-credentials}",
    "headerName": "X-API-Key"
  },
  "assertions": [
    {
      "type": "STATUS_CODE",
      "operator": "EQUALS",
      "value": 201
    }
  ]
}
        

Verificações do DNS

Valide a resolução do DNS e registre as informações.

Propriedades necessárias

Propriedades opcionais

Exemplo do

{
  "stepName": "dnsResolution",
  "checkerType": "DNS",
  "domain": "example.com",
  "recordType": "A",
  "nameserver": "8.8.8.8",
  "timeout": 10000,
  "assertions": [
    {
      "type": "RECORD_VALUE",
      "operator": "CONTAINS",
      "value": "192.168"
    }
  ]
}

Verificações SSL

Monitore a integridade e a configuração dos certificados SSL.

Propriedades necessárias

Propriedades opcionais

Exemplo do

{
  "stepName": "sslCertCheck",
  "checkerType": "SSL",
  "hostname": "secure.example.com",
  "port": 443,
  "sni": true,
  "verifyHostname": true,
  "assertions": [
    {
      "type": "CERTIFICATE_EXPIRY",
      "operator": "GREATER_THAN",
      "value": 30,
      "unit": "DAYS"
    }
  ]
}

Verificações TCP

Teste a conectividade e a validação de resposta da porta TCP.

Propriedades necessárias

Propriedades opcionais

Exemplo do

{
  "stepName": "databaseConnection",
  "checkerType": "TCP",
  "hostname": "db.example.com",
  "port": 3306,
  "connectionTimeout": 5000,
  "sendData": "SELECT 1",
  "expectedResponse": "1",
  "assertions": [
    {
      "type": "CONNECTION_SUCCESSFUL",
      "value": true
    }
  ]
}

Métodos de autenticação

Sem autenticação

{
  "type": "NONE"
}
      

Autenticação básica

Exemplo do

{
  "type": "BASIC",
  "username": "admin",
  "password": "${AWS_SECRET:basic-auth:password}"
}

Autenticação de chave de API

Exemplo do

{
  "type": "API_KEY",
  "apiKey": "${AWS_SECRET:api-credentials}",
  "headerName": "Authorization"
}

Credenciais de cliente OAuth

Exemplo do

{
  "type": "OAUTH_CLIENT_CREDENTIALS",
  "tokenUrl": "https://auth.example.com/oauth/token",
  "clientId": "${AWS_SECRET:oauth-creds:client_id}",
  "clientSecret": "${AWS_SECRET:oauth-creds:client_secret}",
  "scope": "read write",
  "tokenCacheTtl": 7200
}

AWS Signature (versão 4)

Exemplo do

{
  "type": "SIGV4",
  "service": "execute-api",
  "region": "us-east-1",
  "roleArn": "arn:aws:iam::123456789012:role/SyntheticsRole"
}

Asserções e validação

Asserções HTTP

Asserções de código de status

{
  "type": "STATUS_CODE",
  "operator": "EQUALS",
  "value": 200
}

Asserções de tempo de resposta

{
  "type": "RESPONSE_TIME",
  "operator": "LESS_THAN",
  "value": 500,
  "unit": "MILLISECONDS"
}

Asserções de cabeçalho

{
  "type": "HEADER",
  "headerName": "Content-Type",
  "operator": "CONTAINS",
  "value": "application/json"
}

Asserções de corpo

{
  "type": "BODY",
  "target": "JSON",
  "path": "$.users[0].name",
  "operator": "EQUALS",
  "value": "John Doe"
}

Asserções DNS

Registrar asserções de valor

Asserções de contagem de registros

Asserções autoritativas

Asserções TTL

Asserções SSL

Asserções de expiração do certificado

Asserções de assunto do certificado

Asserções de emissor de certificado

Asserções TCP

Asserções de sucesso de conexão

Asserções de dados de resposta

Extração de dados

Os extratores permitem que você capture dados das respostas para uso em etapas subsequentes ou para relatórios.

Propriedades de extração

Validação de nome de extração

Limitação: a substituição não se aplica aos campos do esquema com valores ENUM específicos

Tipos de extração

{
  "name": "userId",
  "type": "BODY",
  "path": "$.user.id"
}

{
  "stepName": "loginAndExtract",
  "checkerType": "HTTP",
  "url": "https://api.example.com/login",
  "httpMethod": "POST",
  "body": "{\"username\":\"test\",\"password\":\"pass\"}",
  "extractors": [
    {
      "name": "textVariable",
      "type": "BODY",
      "path": "$.myvalue"
    }
  ]
},
{
  "stepName": "substituteVariable",
  "checkerType": "HTTP",
  "url": "https://api.example.com/get/${textVariable}",
  "httpMethod": "GET",
  "assertions": [
    {
    "type": "BODY",
    "target": "JSON",
    "path": "$.users[0].name",
    "operator": "EQUALS",
    "value": "${textVariable}"
    }
  ]
}