Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Schreiben einer JSON-Konfiguration für den Blueprint mit Node.js mehreren Checks

Mit dem Node.js Multichecks-Blueprint können Sie Canaries erstellen, die innerhalb eines einzigen Canary-Durchlaufs mehrere Validierungsprüfungen durchführen. Dieser Blueprint ist nützlich, wenn Sie mehrere Endpunkte testen, verschiedene Aspekte Ihrer Anwendung validieren oder eine Reihe verwandter Prüfungen nacheinander durchführen möchten.

Struktur der Stammkonfiguration

Die Root-Konfiguration definiert die Gesamtstruktur Ihres erweiterten API-Blueprint-Canary.

Beispiel

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

Regeln für die Validierung

Globale Einstellungen

Globale Einstellungen bieten Standardkonfigurationen, die für alle Schritte gelten, sofern sie nicht auf Schrittebene außer Kraft gesetzt werden.

Eigenschaften

Beispiel

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

Variablen und Datenmanagement

Mithilfe von Variablen können Sie wiederverwendbare Werte definieren, auf die in Ihrer gesamten Konfiguration mithilfe der ${variableName} Syntax verwiesen werden kann.

Eigenschaften von Variablen

Einschränkungen

Beispiel

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

Verwendung der Konfiguration

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

      

Definitionen der Schritte

Schritte definieren einzelne Überwachungsvorgänge. Jeder Schritt ist von 1 bis 10 nummeriert und enthält eine bestimmte Art der Prüfung.

Allgemeine Schritteigenschaften

Validierung des Schrittnamens

Schritt Nummerierung

Beispiel

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

Typen überprüfen

HTTP-Prüfungen

Überwachen Sie Web-Endpunkte und APIs mit einer umfassenden Anfrage- und Antwortvalidierung.

Erforderliche Eigenschaften

Optionale Eigenschaften

Beispiel

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

DNS-Prüfungen

Überprüfen Sie die DNS-Auflösung und zeichnen Sie die Informationen auf.

Erforderliche Eigenschaften

Optionale Eigenschaften

Beispiel

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

SSL-Prüfungen

Überwachen Sie den Zustand und die Konfiguration des SSL-Zertifikats.

Erforderliche Eigenschaften

Optionale Eigenschaften

Beispiel

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

TCP-Prüfungen

Testen Sie die TCP-Port-Konnektivität und die Antwortvalidierung.

Erforderliche Eigenschaften

Optionale Eigenschaften

Beispiel

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

Authentifizierungsmethoden

Keine Authentifizierung

{
  "type": "NONE"
}
      

Grundlegende Authentifizierung

Beispiel

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

API-Schlüssel-Authentifizierung

Beispiel

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

OAuth-Client-Anmeldeinformationen

Beispiel

{
  "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 Signatur (Version 4)

Beispiel

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

Assertionen und Validierung

HTTP-Assertionen

Zusicherungen im Statuscode

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

Assertionen zur Antwortzeit

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

Hauptaussagen

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

Hauptaussagen

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

DNS-Assertionen

Wertezusicherungen aufzeichnen

Anzahl der Assertionen

Maßgebliche Behauptungen

TTL-Assertionen

SSL-Zusicherungen

Assertionen zum Ablauf des Zertifikats

Behauptungen über den Betreff des Zertifikats

Behauptungen des Zertifikatsausstellers

TCP-Assertionen

Bestätigungen, dass die Verbindung erfolgreich war

Bestätigungen der Antwortdaten

Datenextraktion

Extraktoren ermöglichen es Ihnen, Daten aus Antworten zu erfassen, um sie in nachfolgenden Schritten oder für Berichtszwecke zu verwenden.

Eigenschaften der Extraktion

Validierung des Extraktionsnamens

Einschränkung — Die Ersetzung gilt nicht für Felder im Schema, die bestimmte ENUM-Werte haben

Extraktionstypen

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