使用 Playwright 运行时编写 Node.js Canary 脚本

将 Node.js Canary 文件打包用于 Playwright 运行时

Canary 脚本包含一个 .js（CommonJS 语法）或 .mjs（ES 语法）文件，其中包含您的 Synthetics 处理程序代码，以及代码所依赖的任何其他包和模块。以 ES（ECMAScript）格式创建的脚本应使用 .mjs 作为扩展名，或者包含一个设置了 "type": "module" 字段的 package.json 文件。与 Node.js Puppeteer 等其他运行时不同，您无需将脚本保存在特定的文件夹结构中。您可以直接打包脚本。使用您的首选 zip 实用工具创建一个 .zip 文件，并将处理程序文件置于根目录中。如果您的 Canary 脚本依赖未包含在 Synthetics 运行时中的其他包或模块，您可以将这些依赖项添加到 .zip 文件中。为此，您可以通过运行 npm install 命令将函数所需的库安装到 node_modules 目录中。以下示例 CLI 命令将创建名为 my_deployment_package.zip 的 .zip 文件，其中包含 index.js 或 index.mjs 文件（Synthetics 处理程序）及其依赖项。在示例中，您要使用 npm 程序包管理器来安装依赖项。

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

在根目录下创建一个包含您的项目文件夹内容的 .zip 文件。使用 r（递归）选项，如以下示例所示，确保 zip 压缩子文件夹。

zip -r my_deployment_package.zip .

添加 Synthetics 配置文件来配置 CloudWatch Synthetics 的行为。您可以创建 synthetics.json 文件并将其保存在与入口点或处理程序文件相同的路径下。

或者，您也可以将入口点文件存储在您选择的文件夹结构中。但是，请确保在您的处理程序名称中指定了文件夹路径。

处理程序名称

请务必将您的金丝雀脚本入口点（处理程序）设置为 myCanaryFilename.functionName，以匹配脚本入口点的文件名。您也可以选择将 Canary 存储在单独的文件夹中，例如 myFolder/my_canary_filename.mjs。如果将其存储在单独的文件夹中，请在脚本入口点中指定该路径，例如 myFolder/my_canary_filename.functionName。

更改现有 Playwright 脚本以将其用作 CloudWatch Synthetics Canary

您可以编辑 Node.js 和 Playwright 的现有脚本以用作 Canary。有关 Playwright 的更多信息，请参阅 Playwright 库文档。

您可以使用保存在文件 exampleCanary.mjs 中的以下 Playwright 脚本。

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

执行以下步骤转换脚本：

您的脚本现已准备好作为 Synthetics Canary 运行。以下是更新的脚本：

更新了 ES6 格式的脚本

脚本文件以 .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();
    }
};

更新的 CommonJS 格式的脚本

脚本文件以 .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();
  }
};

CloudWatch Synthetics 配置

您可以通过提供一个名为 synthetics.json 的可选 JSON 配置文件来配置 Synthetics Playwright 运行时的行为。此文件应与处理程序文件打包在相同的位置。尽管配置文件是可选的，但如果您未提供配置文件或缺少配置密钥，CloudWatch 将采用默认值。

打包您的配置文件

以下是支持的配置值及其默认值。

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

步骤配置

报告配置

包括 CloudWatch Synthetics 生成的所有报告，例如 HAR 文件和 Synthetics 步骤报告。敏感数据编辑字段 restrictedHeaders 和 restrictedUrlParameters 也适用于 Synthetics 生成的日志。

下面是报告配置文件的示例：

"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

日志记录配置

适用于 CloudWatch Synthetics 生成的日志。控制请求和响应日志的详细程度。

HTTP 指标配置

与 CloudWatch Synthetics 针对此 Canary 发出的具有不同 HTTP 状态代码的网络请求数量相关的指标的配置。

Canary 指标配置

对 CloudWatch Synthetics 发出的其他指标的配置。

其他配置

CloudWatch Synthetics 环境变量

使用环境变量配置日志记录级别和格式。

日志格式

CloudWatch Synthetics Playwright 运行时会为每一次 Canary 运行创建 CloudWatch 日志。日志以 JSON 格式编写，便于查询。您还可以将日志格式更改为 TEXT。

日志级别

尽管启用 Debug 模式会增加详细程度，但对于故障排除很有用。