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 eines kanarischen Skripts für Node.js mit der Playwright-Laufzeit

Ihre kanarischen Dateien vom Typ Node.js für die Playwright-Laufzeit verpacken

Ihr kanarisches Skript besteht aus einer Datei .js (CommonJS-Syntax) oder .mjs (ES-Syntax), die Ihren Synthetics-Handler-Code enthält, zusammen mit allen zusätzlichen Paketen und Modulen, von denen Ihr Code abhängt. Skripte, die im ES (ECMAScript) -Format erstellt wurden, sollten entweder .mjs als Erweiterung verwenden oder eine package.json-Datei mit dem Feldsatz „type“: „module“ enthalten. Im Gegensatz zu anderen Runtimes wie Node.js Puppeteer müssen Sie Ihre Skripts nicht in einer bestimmten Ordnerstruktur speichern. Sie können Ihre Skripte direkt verpacken. Verwenden Sie Ihr bevorzugtes zip Hilfsprogramm, um eine .zip Datei mit Ihrer Handler-Datei im Stammverzeichnis zu erstellen. Wenn Ihr Canary-Skript von zusätzlichen Paketen oder Modulen abhängt, die nicht in der Synthetics-Laufzeit enthalten sind, können Sie diese Abhängigkeiten zu Ihrer .zip Datei hinzufügen. Dazu können Sie die für Ihre Funktion erforderlichen Bibliotheken im node_modules Verzeichnis installieren, indem Sie den npm install Befehl ausführen. Die folgenden CLI-Beispielbefehle erstellen eine .zip Datei my_deployment_package.zip mit dem Namen, die die index.js index.mjs OR-Datei (Synthetics-Handler) und ihre Abhängigkeiten enthält. In dem Beispiel installieren Sie Abhängigkeiten mit dem npm Paketmanager.

~/my_function
├── index.mjs
├── synthetics.json
├── myhelper-util.mjs    
└── node_modules
    ├── mydependency

Erstellen Sie eine .zip Datei, die den Inhalt Ihres Projektordners im Stammverzeichnis enthält. Verwenden Sie die Option r (rekursiv), wie im folgenden Beispiel gezeigt, um sicherzustellen, dass die zip Unterordner komprimiert werden.

zip -r my_deployment_package.zip .

Fügen Sie eine Synthetics-Konfigurationsdatei hinzu, um das Verhalten von CloudWatch Synthetics zu konfigurieren. Sie können eine synthetics.json Datei erstellen und sie unter demselben Pfad wie Ihren Einstiegspunkt oder Ihre Handler-Datei speichern.

Optional können Sie Ihre Einstiegspunktdatei auch in einer Ordnerstruktur Ihrer Wahl speichern. Stellen Sie jedoch sicher, dass der Ordnerpfad in Ihrem Handlernamen angegeben ist.

Handlername

Legen Sie den Skript-Eintrittspunkt Ihres Canary (Handler) als myCanaryFilename.functionName fest, damit er mit dem Dateinamen des Skript-Eintrittspunkts übereinstimmt. Sie können den Canary optional in einem separaten Ordner speichern, z. myFolder/my_canary_filename.mjs B. Wenn Sie ihn in einem separaten Ordner speichern, geben Sie den entsprechenden Pfad in Ihrem Skript-Eintrittspunkt an (z. B. myFolder/my_canary_filename.functionName).

Änderung eines vorhandenen Playwright-Skripts zur Verwendung als CloudWatch Synthetics Canary

Sie können ein vorhandenes Skript für Node.js und Playwright bearbeiten, um es als Kanariensystem zu verwenden. Weitere Informationen zu Playwright finden Sie in der Dokumentation zur Playwright-Bibliothek.

Sie können das folgende Playwright-Skript verwenden, das in einer Datei gespeichert ist. exampleCanary.mjs

import { chromium } from 'playwright';
import { expect } from '@playwright/test';

const browser = await chromium.launch();
const page = await browser.newPage();
await page.goto('https://example.com', {timeout: 30000});
await page.screenshot({path: 'example-home.png'});

const title = await page.title();
expect(title).toEqual("Example Domain");
 
await browser.close();

Konvertieren Sie das Skript, indem Sie die folgenden Schritte ausführen:

Ihr Skript ist jetzt bereit, als Synthetics Canary ausgeführt zu werden. Das Folgende ist das aktualisierte Skript:

Das ES6 Format des Skripts wurde aktualisiert

Die Skriptdatei wurde mit einer .mjs Erweiterung gespeichert.

import { synthetics } from '@amzn/synthetics-playwright';
import { expect } from '@playwright/test';

export const handler = async (event, context) => {
  try {
        // Launch a browser
        const browser = await synthetics.launch();
        
        // Create a new page
        const page = await synthetics.newPage(browser);
        
        // Navigate to a website
        await page.goto('https://www.example.com', {timeout: 30000});
        
        // Take screenshot
        await page.screenshot({ path: '/tmp/example.png' });
        
        // Verify the page title
        const title = await page.title();
        expect(title).toEqual("Example Domain");
    } finally {
        // Ensure browser is closed
        await synthetics.close();
    }
};

Das Skript im CommonJS-Format wurde aktualisiert

Die Skriptdatei wurde mit einer .js Erweiterung gespeichert.

const { synthetics } = require('@amzn/synthetics-playwright');
const { expect } = require('@playwright/test');

exports.handler = async (event) => {
  try {
    const browser = await synthetics.launch();
    const page = await synthetics.newPage(browser);
    await page.goto('https://www.example.com', {timeout: 30000});
    await page.screenshot({ path: '/tmp/example.png' });
    const title = await page.title();
    expect(title).toEqual("Example Domain");
  } finally {
    await synthetics.close();
  }
};

CloudWatch Synthetics Konfigurationen

Sie können das Verhalten der Synthetics Playwright-Laufzeit konfigurieren, indem Sie eine optionale JSON-Konfigurationsdatei mit dem Namen bereitstellen. synthetics.json Diese Datei sollte am selben Speicherort wie die Handler-Datei gepackt werden. Eine Konfigurationsdatei ist zwar optional, wenn Sie jedoch keine Konfigurationsdatei angeben oder ein Konfigurationsschlüssel fehlt, wird von Standardwerten CloudWatch ausgegangen.

Verpacken Sie Ihre Konfigurationsdatei

Im Folgenden sind die unterstützten Konfigurationswerte und ihre Standardwerte aufgeführt.

{
    "step": {
        "screenshotOnStepStart": false,
        "screenshotOnStepSuccess": false,
        "screenshotOnStepFailure": false,
        "stepSuccessMetric": true,
        "stepDurationMetric": true,
        "continueOnStepFailure": true,
        "stepsReport": true
    },
    "report": {
        "includeRequestHeaders": true,
        "includeResponseHeaders": true,
        "includeUrlPassword": false,
        "includeRequestBody": true,
        "includeResponseBody": true,
        "restrictedHeaders": ['x-amz-security-token', 'Authorization'], // Value of these headers is redacted from logs and reports
        "restrictedUrlParameters": ['Session', 'SigninToken'] // Values of these url parameters are redacted from logs and reports
    },
    "logging": {
        "logRequest": false,
        "logResponse": false,
        "logResponseBody": false,
        "logRequestBody": false,
        "logRequestHeaders": false,
        "logResponseHeaders": false
    },
    "httpMetrics": {
        "metric_2xx": true,
        "metric_4xx": true,
        "metric_5xx": true,
        "failedRequestsMetric": true,
        "aggregatedFailedRequestsMetric": true,
        "aggregated2xxMetric": true,
        "aggregated4xxMetric": true,
        "aggregated5xxMetric": true
    },
    "canaryMetrics": {
        "failedCanaryMetric": true,
        "aggregatedFailedCanaryMetric": true
    },
    "userAgent": "",
    "har": true
}

Schrittweise Konfigurationen

Konfigurationen melden

Beinhaltet alle von CloudWatch Synthetics generierten Berichte, z. B. eine HAR-Datei und einen Synthetics-Schrittbericht. Felder zur Schwärzung sensibler Daten restrictedHeaders und gelten restrictedUrlParameters auch für von Synthetics generierte Protokolle.

Im Folgenden finden Sie ein Beispiel für eine Berichtskonfigurationsdatei.

"includeRequestHeaders": true,
"includeResponseHeaders": true,
"includeUrlPassword": false,
"includeRequestBody": true,
"includeResponseBody": true,
"restrictedHeaders": ['x-amz-security-token', 'Authorization'], // Value of these headers is redacted from logs and reports
"restrictedUrlParameters": ['Session', 'SigninToken'] // Values of these URL parameters are redacted from logs and reports

Konfigurationen protokollieren

Gilt für von CloudWatch Synthetics generierte Protokolle. Steuert die Ausführlichkeit von Anfrage- und Antwortprotokollen.

Konfigurationen von HTTP-Metriken

Konfigurationen für Metriken, die sich auf die Anzahl der Netzwerkanfragen mit unterschiedlichen HTTP-Statuscodes beziehen, die von CloudWatch Synthetics für diesen Kanarienvogel ausgegeben wurden.

Kanarische metrische Konfigurationen

Konfigurationen für andere von CloudWatch Synthetics ausgegebene Metriken.

Andere Konfigurationen

CloudWatch Synthetics-Umgebungsvariablen

Konfigurieren Sie die Protokollierungsebene und das Format mithilfe von Umgebungsvariablen.

Format des Protokolls

Die CloudWatch Synthetics Playwright Runtime erstellt CloudWatch Protokolle für jeden Canary-Run. Die Protokolle werden zur bequemen Abfrage im JSON-Format geschrieben. Optional können Sie das Protokollformat in ändern. TEXT

Protokollebenen

DebugDer Aktivierungsmodus erhöht zwar die Ausführlichkeit, kann aber bei der Problembehandlung nützlich sein.