Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Scrittura di una configurazione JSON per il blueprint Multi Checks Node.js

Il blueprint dei controlli Node.js multipli consente di creare canarini che eseguono più controlli di convalida in una singola esecuzione di canary. Questo modello è utile quando si desidera testare più endpoint, convalidare diversi aspetti dell'applicazione o eseguire una serie di controlli correlati in sequenza.

Struttura di configurazione principale

La configurazione root definisce la struttura generale del tuo blueprint API avanzato Canary.

Esempio

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

Regole di convalida

Impostazioni globali

Le impostazioni globali forniscono configurazioni predefinite che si applicano a tutti i passaggi a meno che non vengano sovrascritte a livello di fase.

Proprietà

Esempio

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

Gestione delle variabili e dei dati

Le variabili consentono di definire valori riutilizzabili a cui è possibile fare riferimento in tutta la configurazione utilizzando ${variableName} la sintassi.

Proprietà delle variabili

Limitazioni

Esempio

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

Utilizzo della configurazione

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

      

Definizioni dei passaggi

Le fasi definiscono le singole operazioni di monitoraggio. Ogni fase è numerata da 1 a 10 e contiene un tipo specifico di controllo.

Proprietà comuni dei passaggi

Convalida del nome del passaggio

Numerazione dei passaggi

Esempio

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

Tipi di controllo

Controlli HTTP

Monitora gli endpoint web e le API con una convalida completa di richieste e risposte.

Proprietà obbligatorie

Proprietà opzionali

Esempio

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

Controlli DNS

Convalida la risoluzione DNS e registra le informazioni.

Proprietà obbligatorie

Proprietà opzionali

Esempio

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

Controlli SSL

Monitora lo stato e la configurazione del certificato SSL.

Proprietà obbligatorie

Proprietà opzionali

Esempio

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

Controlli TCP

Verifica la connettività della porta TCP e la convalida della risposta.

Proprietà obbligatorie

Proprietà opzionali

Esempio

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

Metodi di autenticazione

Nessuna autenticazione

{
  "type": "NONE"
}
      

Autenticazione di base

Esempio

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

Autenticazione con chiave API

Esempio

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

Credenziali del client OAuth

Esempio

{
  "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 Firma (versione 4)

Esempio

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

Asserzioni e convalida

Asserzioni HTTP

Asserzioni relative al codice di stato

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

Asserzioni sui tempi di risposta

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

Affermazioni principali

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

Asserzioni corporee

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

Asserzioni DNS

Asserzioni di valore da record

Asserzioni sul conteggio dei record

Asserzioni autorevoli

Asserzioni TTL

Asserzioni SSL

Asserzioni sulla scadenza del certificato

Dichiarazioni relative all'oggetto del certificato

Asserzioni dell'emittente del certificato

Asserzioni TCP

Asserzioni di successo della connessione

Asserzioni sui dati di risposta

Estrazione dei dati

Extractors consente di acquisire dati dalle risposte per utilizzarli nei passaggi successivi o per scopi di reporting.

Proprietà di estrazione

Convalida del nome di estrazione

Limitazione: la sostituzione non si applica ai campi dello schema che hanno valori ENUM specifici

Tipi di estrazione

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