Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Menulis skri Node.js p kenari menggunakan runtime Playwright

Mengemas file Node.js kenari Anda untuk runtime Playwright

Skrip kenari Anda terdiri dari file .js (sintaks CommonJS) atau .mjs (sintaks ES) yang berisi kode handler Synthetics Anda, bersama dengan paket dan modul tambahan yang bergantung pada kode Anda. Skrip yang dibuat dalam format ES (ECMAScript) harus menggunakan.mjs sebagai ekstensi atau menyertakan file package.json dengan set bidang “type”: “module”. Tidak seperti runtime lain seperti Node.js Puppeteer, Anda tidak diharuskan menyimpan skrip Anda dalam struktur folder tertentu. Anda dapat mengemas skrip Anda secara langsung. Gunakan zip utilitas pilihan Anda untuk membuat .zip file dengan file handler Anda di root. Jika script canary Anda bergantung pada paket atau modul tambahan yang tidak disertakan dalam runtime Synthetics, Anda dapat menambahkan dependensi ini ke file Anda.zip. Untuk melakukannya, Anda dapat menginstal pustaka yang diperlukan fungsi Anda di node_modules direktori dengan menjalankan npm install perintah. Contoh perintah CLI berikut membuat .zip file bernama my_deployment_package.zip berisi file index.js or index.mjs (Handler Synthetics) dan dependensinya. Dalam contoh, Anda menginstal dependensi menggunakan manajer npm paket.

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

Buat .zip file yang berisi konten folder proyek Anda di root. Gunakan opsi r (rekursif), seperti yang ditunjukkan pada contoh berikut, untuk memastikan bahwa mengom zip pres subfolder.

zip -r my_deployment_package.zip .

Tambahkan file konfigurasi Synthetics untuk mengkonfigurasi perilaku CloudWatch Synthetics. Anda dapat membuat synthetics.json file dan menyimpannya di jalur yang sama dengan titik masuk atau file handler Anda.

Secara opsional, Anda juga dapat menyimpan file titik masuk Anda dalam struktur folder pilihan Anda. Namun, pastikan bahwa jalur folder ditentukan dalam nama handler Anda.

Nama handler

Pastikan untuk mengatur titik masuk skrip kenari Anda (handler) myCanaryFilename.functionName agar sesuai dengan nama file titik masuk skrip Anda. Anda dapat menyimpan kenari secara opsional di folder terpisah seperti myFolder/my_canary_filename.mjs. Jika Anda menyimpannya di folder terpisah, tentukan jalur itu di titik entri skrip Anda, seperti myFolder/my_canary_filename.functionName.

Mengubah skrip Dramawan yang ada untuk digunakan sebagai kenari CloudWatch Synthetics

Anda dapat mengedit skrip yang ada untuk Node.js dan Penulis Naskah untuk digunakan sebagai kenari. Untuk informasi selengkapnya tentang Dramawan, lihat dokumentasi perpustakaan https://playwright.dev/docs/api/class-playwright Playwright.

Anda dapat menggunakan skrip Playwright berikut yang disimpan dalam 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();

Konversi skrip dengan melakukan langkah-langkah berikut:

Skrip Anda sekarang siap dijalankan sebagai kenari Synthetics. Berikut ini adalah skrip yang diperbarui:

Script yang diperbarui dalam format ES6

File skrip disimpan dengan .mjs ekstensi.

import { synthetics } from '@aws/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();
    }
};

Skrip yang diperbarui dalam format CommonJS

File skrip disimpan dengan .js ekstensi.

const { synthetics } = require('@aws/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 Konfigurasi sintetis

Anda dapat mengonfigurasi perilaku runtime Synthetics Playwright dengan menyediakan file konfigurasi JSON opsional bernama. synthetics.json File ini harus dikemas di lokasi yang sama dengan file handler. Meskipun file konfigurasi bersifat opsional, jika Anda tidak memberikan file konfigurasi, atau kunci konfigurasi hilang, CloudWatch mengasumsikan default.

Mengemas file konfigurasi Anda

Berikut ini adalah nilai konfigurasi yang didukung, dan defaultnya.

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

Konfigurasi langkah

Konfigurasi laporan

Termasuk semua laporan yang dihasilkan oleh CloudWatch Synthetics, seperti file HAR dan laporan langkah Synthetics. Bidang penyuntingan data sensitif restrictedHeaders dan restrictedUrlParameters juga berlaku untuk log yang dihasilkan oleh Synthetics.

Berikut ini adalah contoh file konfigurasi laporan.

"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

Konfigurasi logging

Berlaku untuk log yang dihasilkan oleh CloudWatch Synthetics. Mengontrol verbositas log permintaan dan respons.

Konfigurasi metrik HTTP

Konfigurasi untuk metrik yang terkait dengan jumlah permintaan jaringan dengan kode status HTTP yang berbeda, dipancarkan oleh CloudWatch Synthetics untuk burung kenari ini.

Konfigurasi metrik Canary

Konfigurasi untuk metrik lain yang dipancarkan oleh CloudWatch Synthetics.

Konfigurasi lainnya

CloudWatch Variabel lingkungan sintetis

Konfigurasikan level dan format logging dengan menggunakan variabel lingkungan.

Format log

Runtime CloudWatch Synthetics Playwright membuat CloudWatch log untuk setiap pengoperasian kenari. Log ditulis dalam format JSON untuk memudahkan kueri. Secara opsional, Anda dapat mengubah format log menjadiTEXT.

Tingkat log

Meskipun Debug mode mengaktifkan meningkatkan verbositas, ini dapat berguna untuk pemecahan masalah.