Scrittura di uno script canary Node.js utilizzando il runtime Playwright

Creazione di pacchetti dei file canary Node.js per il runtime di Playwright

Il tuo script canary comprende un file .js (sintassi CommonJS) o .mjs (sintassi ES) contenente il codice del gestore Synthetics, insieme a tutti i pacchetti e moduli aggiuntivi da cui dipende il codice. Gli script creati in formato ES (ECMAScript) devono utilizzare l'estensione .mjs o includere un file package.json con il campo “type”: “module” impostato. A differenza di altri runtime come Node.js Puppeteer, non è necessario salvare gli script in una struttura di cartelle specifica. Puoi direttamente creare pacchetti dei tuoi script. Utilizza il tuo strumento di compressione zip preferito per creare un file .zip con il file gestore nella directory root. Se il tuo script canary dipende da pacchetti o moduli aggiuntivi non inclusi nel runtime Synthetics, puoi aggiungere queste dipendenze al tuo file .zip. A tale scopo, puoi installare le librerie richieste dalla tua funzione nella directory node_modules eseguendo il comando npm install. I seguenti comandi della CLI di esempio creano un file .zip denominato my_deployment_package.zip, contenente il file index.js o index.mjs (gestore Synthetics) e le relative dipendenze. Nell'esempio, installi le dipendenze utilizzando il gestore di pacchetti npm.

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

Crea un file .zip dei contenuti della cartella di progetto della directory root. Utilizza l'opzione r (ricorsiva), come illustrato nell'esempio seguente, per assicurarti che zip comprima le sottocartelle.

zip -r my_deployment_package.zip .

Aggiungi un file di configurazione Synthetics per configurare il comportamento di CloudWatch Synthetics. Puoi creare un file synthetics.json e salvarlo nello stesso percorso del punto di ingresso o del file del gestore.

Facoltativamente, puoi anche archiviare il file del punto di ingresso in una struttura di cartelle a tua scelta. Tuttavia, assicurati che il percorso della cartella sia specificato nel nome del gestore.

Nome del gestore

Assicurati di impostare il punto di ingresso dello script del tuo canary (gestore) in modo che myCanaryFilename.functionName corrisponda al nome del file del punto di ingresso dello script. Facoltativamente, puoi anche archiviare il canary in una cartella separata, ad esempio myFolder/my_canary_filename.mjs. Se lo archivi in una cartella separata, definisci il percorso nel punto di ingresso dello script, ad esempio myFolder/my_canary_filename.functionName.

Modifica di uno script Playwright esistente da utilizzare come canary di CloudWatch Synthetics

Puoi modificare uno script esistente per Node.js e Playwright da utilizzare come canary. Per ulteriori informazioni su Playwright, consulta la documentazione Playwright library.

Puoi utilizzare il seguente script Playwright salvato nel file 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();

Converti lo script seguendo i passaggi di seguito:

Il tuo script è ora pronto per essere eseguito come canary di Synthetics. Di seguito è riportato lo script aggiornato:

Script aggiornato in formato ES6

Il file di script salvato con un'estensione .mjs.

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();
    }
};

Script aggiornato in formato CommonJS

Il file di script salvato con un'estensione .js.

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();
  }
};

Configurazioni di CloudWatch Synthetics

Puoi configurare il comportamento del runtime Synthetics Playwright fornendo un file di configurazione JSON facoltativo denominato synthetics.json. Questo file dovrebbe essere incluso nella stessa posizione del file gestore. Sebbene un file di configurazione sia facoltativo, se non fornisci un file di configurazione o manca una chiave di configurazione, CloudWatch impiega i valori predefiniti.

Creazione di un pacchetto del file di configurazione

Di seguito sono riportati i valori di configurazione supportati e i relativi valori predefiniti.

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

Configurazioni di passaggio

Configurazioni dei report

Include tutti i report generati da CloudWatch Synthetics, come un file HAR e un report dei passaggi di Synthetics. Anche i campi di redazione dei dati sensibili restrictedHeaders e restrictedUrlParameters si applicano ai log generati da Synthetics.

Di seguito è riportato un esempio di file di configurazioni del 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

Configurazioni di registrazione

Si applica ai log generati da CloudWatch Synthetics. Controlla la verbosità dei log di richieste e risposte.

Configurazioni delle metriche HTTP

Configurazioni per metriche relative al conteggio delle richieste di rete con codici di stato HTTP diversi, emesse da CloudWatch Synthetics per questo canary.

Configurazioni delle metriche del canary

Configurazioni per altre metriche emesse da CloudWatch Synthetics.

Altre configurazioni

Variabili di ambiente di CloudWatch Synthetics

Configura il livello e il formato di registrazione utilizzando le variabili di ambiente.

Formato dei log

Il runtime Playwright di CloudWatch Synthetics crea log CloudWatch per ogni esecuzione canary. I log sono scritti in formato JSON per facilitare le interrogazioni. Facoltativamente, puoi modificare il formato del log in TEXT.

Livelli di log

Sebbene l'attivazione della modalità Debug aumenti la verbosità, può essere utile per la risoluzione dei problemi.