本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 Playwright 執行時間撰寫 Node.js Canary 指令碼

針對 Playwright 執行時間封裝 Node.js Canary 檔案

Canary 指令碼包含 .js(CommonJS 語法） 或 .mjs(ES 語法） 檔案，其中包含您的 Synthetics 處理常式程式碼，以及程式碼所依賴的任何其他套件和模組。以 ES (ECMAScript) 格式建立的指令碼應使用 .mjs 作為副檔名，或包含具有「類型」：「模組」欄位集的 package.json 檔案。與其他執行時間不同，例如 Node.js Puppeteer，您不需要將指令碼儲存在特定的資料夾結構中。您可以直接封裝指令碼。使用您偏好的zip公用程式，在根目錄建立包含處理常式.zip檔案的檔案。如果您的 Canary 指令碼取決於 Synthetics 執行時間中未包含的其他套件或模組，您可以將這些相依性新增至 .zip 檔案。若要這麼做，您可以執行 npm install命令，在 node_modules目錄中安裝函數所需的程式庫。下列範例 CLI 命令會建立名為 .zip的檔案，my_deployment_package.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檔案，並將其儲存在與進入點或處理常式檔案相同的路徑。

或者，您也可以將進入點檔案存放在您選擇的資料夾結構中。不過，請確定已在處理常式名稱中指定資料夾路徑。

處理常式名稱

請務必將 Canary 的指令碼進入點 (處理常式) 設定為 myCanaryFilename.functionName，以符合指令碼進入點的檔案名稱。您可以選擇將 Canary 存放在不同的資料夾中，例如 myFolder/my_canary_filename.mjs。如果將其存放在單獨的資料夾中，請在指令碼進入點中指定該路徑，例如 myFolder/my_canary_filename.functionName。

將現有的 Playwright 指令碼變更為用作 CloudWatch Synthetics Canary

您可以編輯 Node.js 和 Playwright 的現有指令碼，以用作 Canary。如需 Playwright 的詳細資訊，請參閱 Playwright 程式庫文件。

您可以使用下列儲存在檔案 中的 Playwright 指令碼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();

執行下列步驟來轉換指令碼：

您的指令碼現在已準備好以 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 組態

您可以提供名為 的選用 JSON 組態檔案，來設定 Synthetics Playwright 執行時間的行為synthetics.json。此檔案應與處理常式檔案封裝在相同的位置。雖然組態檔案是選用的，但如果您未提供組態檔案，或組態金鑰遺失，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模式會增加詳細程度，但對於故障診斷非常有用。