在本地测试 Canary
本节介绍如何直接在 Microsoft Visual Studio 代码编辑器或 JetBrains IDE 代码编辑器中修改、测试和调试 CloudWatch Synthetics Canary。本地调试环境使用无服务器应用程序模型（SAM）容器来模拟 Lambda 函数，从而模拟 Synthetics Canary 的行为。
注意
执行依赖于可视化监控的本地调试 Canary 是不切实际的。可视化监控依赖于在初始运行期间捕获基本屏幕截图，然后将这些屏幕截图与后续运行的屏幕截图进行比较。在本地开发环境中，运行不会被存储或跟踪，并且每次迭代都是独立的运行。由于缺少 Canary 运行历史记录，因此调试依赖可视化监控的 Canary 变得不切实际。
先决条件
选择或创建 Amazon S3 存储桶，以用于存储本地 Canary 测试运行的构件，例如 HAR 文件和屏幕截图。这要求您预调配 IAM。如果您跳过设置 Amazon S3 存储桶，您仍然可以在本地测试您的 Canary，但是您将看到一条关于丢失存储桶的错误消息，并且您将无法访问 Canary 构件。
如果您使用 Amazon S3 存储桶，我们建议您将存储桶生命周期设置为在几天后删除对象，以节省成本。有关更多信息，请参阅管理存储生命周期。
为您的 AWS 账户设置默认 AWS 配置文件。有关更多信息，请参阅配置和凭证文件设置。
将调试环境的默认 AWS 区域设置为您的首选区域，例如
us-west-2。安装 AWS SAM CLI。有关更多信息，请参阅安装 AWS SAM CLI。
安装 Visual Studio Code Editor 或 JetBrains IDE。有关更多信息，请参阅 Visual Studio Code
或 JetBrains IDE 。 安装 Docker 以使用 AWS SAM CLI。请务必启动 docker 进程守护程序。有关更多信息，请参阅安装 Docker 以用于 AWS SAM CLI。
或者，您可以安装其他容器管理软件，例如 Rancher，只要它使用 Docker 运行时即可。
为您的首选编辑器安装 AWS 工具包扩展。有关更多信息，请参阅安装 AWS Toolkit for Visual Studio Code 或安装 AWS Toolkit for JetBrains。
主题
设置测试和调试环境
首先，通过输入以下命令克隆 AWS 提供的 Github 存储库。该存储库包含 Node.js Canary 和 Python Canary 的代码示例。
git clone https://github.com/aws-samples/synthetics-canary-local-debugging-sample.git
然后根据您的 Canary 的语言执行以下操作之一。
对于 Node.js Canary
通过输入以下命令转到 Node.js Canary 源目录。
cd synthetics-canary-local-debugging-sample/nodejs-canary/src运行以下命令，以安装 Canary 依赖项。
npm install
对于 Python Canary
通过输入以下命令转到 Python Canary 源目录。
cd synthetics-canary-local-debugging-sample/python-canary/src运行以下命令，以安装 Canary 依赖项。
pip3 install -r requirements.txt -t .
使用 Visual Studio Code IDE
Visual Studio 启动配置文件位于 .vscode/launch.json。它包含允许 Visual
Studio 代码发现模板文件的配置。它定义了一个 Lambda 有效负载，其中包含成功调用 Canary 所需的参数。以下是 Node.js Canary 的启动配置：
{ ... ... "lambda": { "payload": { "json": { // Canary name. Provide any name you like. "canaryName": "LocalSyntheticsCanary", // Canary artifact location "artifactS3Location": { "s3Bucket": "cw-syn-results-123456789012-us-west-2", "s3Key": "local-run-artifacts", }, // Your canary handler name "customerCanaryHandlerName": "heartbeat-canary.handler" } }, // Environment variables to pass to the canary code "environmentVariables": {} } } ] }
您也可以选择在有效负载 JSON 中提供以下字段：
s3EncryptionMode有效值：SSE_S3|SSE_KMSs3KmsKeyArn有效值：KMS 密钥 ARNactiveTracing有效值：true|falsecanaryRunId有效值：UUID如果启用了主动跟踪，则需要此参数。
要在 Visual Studio 中调试 Canary，请在要暂停执行的 Canary 代码中添加断点。要添加断点，请选择编辑器边距，然后在编辑器中进入运行和调试模式。点击播放按钮运行 Canary。当 Canary 运行时，将在调试控制台中跟踪日志，从而为您提供有关 Canary 行为的实时见解。如果您添加了断点，则 Canary 执行将在每个断点处暂停，从而使您可以逐步浏览代码并检查变量值、实例方法、对象属性和函数调用堆栈。
除了存储在 Amazon S3 存储桶中的构件和每次本地运行生成的 CloudWatch 指标外，在本地运行和调试 Canary 不会产生任何费用。
使用 JetBrains IDE
安装 AWS Toolkit for JetBrains 扩展程序后，如果您正在调试 Node.js Canary，请确保启用 Node.js 插件和 JavaScript 调试器运行。然后，按照以下步骤执行操作。
使用 JetBrains IDE 调试 Canary
在 JetBrains IDE 的左侧导航窗格中，选择 Lambda，然后选择本地配置模板。
为运行配置输入名称，例如
LocalSyntheticsCanary选择来自模板，在模板字段中选择文件浏览器，然后从 nodejs 目录或 python 目录中在项目中选择 template.yml 文件。
在输入部分，输入 Canary 的有效负载，如以下屏幕所示。
{ "canaryName": "LocalSyntheticsCanary", "artifactS3Location": { "s3Bucket": "cw-syn-results-123456789012-us-west-2", "s3Key": "local-run-artifacts" }, "customerCanaryHandlerName": "heartbeat-canary.handler" }您也可以在有效负载 JSON 中设置其他环境变量，如 使用 Visual Studio Code IDE 中所列。
使用 SAM CLI 在本地运行 Canary
使用以下过程之一，使用无服务器应用程序模型（SAM）CLI 在本地运行 Canary。请务必在 event.json 中为 s3Bucket 指定您自己的 Amazon S3 存储桶名称
要使用 SAM CLI 运行 Node.js Canary
通过输入以下命令转到源目录。
cd synthetics-canary-local-debugging-sample/nodejs-canary输入以下命令。
sam build sam local invoke -e ../event.json
要使用 SAM CLI 运行 Python Canary
通过输入以下命令转到源目录。
cd synthetics-canary-local-debugging-sample/python-canary输入以下命令。
sam build sam local invoke -e ../event.json
将您的本地测试环境集成到现有的 Canary 包中
您可以通过复制三个文件将本地 Canary 调试集成到现有的 Canary 包中：
将
template.yml文件复制到您的 Canary 包根目录中。请务必修改CodeUri的路径以指向您的 Canary 代码所在的目录。如果您使用的是 Node.js Canary，请将
cw-synthetics.js文件复制到您的 Canary 源目录。如果您使用的是 Python Canary，请将cw-synthetics.py复制到您的 Canary 源目录。复制启动配置文件。
vscode/launch.json进入包根目录。确保将其放在.vscode目录中；如果目录尚不存在，请创建目录。
更改 CloudWatch Synthetics 运行时
在调试的过程中，您可能需要尝试使用不同的 CloudWatch Synthetics 运行时来运行 Canary，而不是最新的运行时。为此，请从下表之一中找到要使用的运行时。务必为正确的区域选择运行时。然后，将该运行时的 ARN 粘贴到 template.yml 文件中的相应位置，然后运行 Canary。
Node.js 运行时
syn-nodejs-puppeteer-7.0 的 ARN
下表列出了要在各个 AWS 区域中用于 syn-nodejs-puppeteer-7.0 版本 CloudWatch Synthetics 运行时的适用 ARN。
| 区域 | ARN |
|---|---|
|
美国东部（弗吉尼亚州北部） |
|
|
美国东部（俄亥俄州） |
|
|
美国西部（加利福尼亚北部） |
|
|
美国西部（俄勒冈州） |
|
|
非洲（开普敦） |
|
|
亚太地区（香港） |
|
|
亚太地区（海得拉巴） |
|
|
亚太地区（雅加达） |
|
|
亚太地区（墨尔本） |
|
|
亚太地区（孟买） |
|
|
亚太地区（大阪） |
|
|
亚太地区（首尔） |
|
|
亚太地区（新加坡） |
|
|
亚太地区（悉尼） |
|
|
亚太地区（东京） |
|
|
加拿大（中部） |
|
|
加拿大西部（卡尔加里） |
|
|
中国（北京） |
|
|
中国（宁夏）； |
|
|
欧洲地区（法兰克福） |
|
|
欧洲地区（爱尔兰） |
|
|
欧洲地区（伦敦） |
|
|
欧洲地区（米兰） |
|
|
欧洲地区（巴黎） |
|
|
欧洲（西班牙） |
|
|
欧洲地区（斯德哥尔摩） |
|
|
欧洲（苏黎世） |
|
|
以色列（特拉维夫） |
|
|
中东（巴林） |
|
|
中东（阿联酋） |
|
|
南美洲（圣保罗） |
|
|
AWS GovCloud（美国东部） |
|
|
AWS GovCloud（美国西部） |
|
syn-nodejs-puppeteer-6.2 的 ARN
下表列出了要在各个 AWS 区域中用于 syn-nodejs-puppeteer-6.2 版本 CloudWatch Synthetics 运行时的适用 ARN。
| 区域 | ARN |
|---|---|
|
美国东部（弗吉尼亚州北部） |
|
|
美国东部（俄亥俄州） |
|
|
美国西部（加利福尼亚北部） |
|
|
美国西部（俄勒冈州） |
|
|
非洲（开普敦） |
|
|
亚太地区（香港） |
|
|
亚太地区（海得拉巴） |
|
|
亚太地区（雅加达） |
|
|
亚太地区（墨尔本） |
|
|
亚太地区（孟买） |
|
|
亚太地区（大阪） |
|
|
亚太地区（首尔） |
|
|
亚太地区（新加坡） |
|
|
亚太地区（悉尼） |
|
|
亚太地区（东京） |
|
|
加拿大（中部） |
|
|
加拿大西部（卡尔加里） |
|
|
中国（北京） |
|
|
中国（宁夏）； |
|
|
欧洲地区（法兰克福） |
|
|
欧洲地区（爱尔兰） |
|
|
欧洲地区（伦敦） |
|
|
欧洲地区（米兰） |
|
|
欧洲地区（巴黎） |
|
|
欧洲（西班牙） |
|
|
欧洲地区（斯德哥尔摩） |
|
|
欧洲（苏黎世） |
|
|
以色列（特拉维夫） |
|
|
中东（巴林） |
|
|
中东（阿联酋） |
|
|
南美洲（圣保罗） |
|
|
AWS GovCloud（美国东部） |
|
|
AWS GovCloud（美国西部） |
|
syn-nodejs-puppeteer-5.2 的 ARN
下表列出了要在各个 AWS 区域中用于 syn-nodejs-puppeteer-5.2 版本 CloudWatch Synthetics 运行时的适用 ARN。
| 区域 | ARN |
|---|---|
|
美国东部（弗吉尼亚州北部） |
|
|
美国东部（俄亥俄州） |
|
|
美国西部（加利福尼亚北部） |
|
|
美国西部（俄勒冈州） |
|
|
非洲（开普敦） |
|
|
亚太地区（香港） |
|
|
亚太地区（海得拉巴） |
|
|
亚太地区（雅加达） |
|
|
亚太地区（墨尔本） |
|
|
亚太地区（孟买） |
|
|
亚太地区（大阪） |
|
|
亚太地区（首尔） |
|
|
亚太地区（新加坡） |
|
|
亚太地区（悉尼） |
|
|
亚太地区（东京） |
|
|
加拿大（中部） |
|
|
加拿大西部（卡尔加里） |
|
|
中国（北京） |
|
|
中国（宁夏）； |
|
|
欧洲地区（法兰克福） |
|
|
欧洲地区（爱尔兰） |
|
|
欧洲地区（伦敦） |
|
|
欧洲地区（米兰） |
|
|
欧洲地区（巴黎） |
|
|
欧洲（西班牙） |
|
|
欧洲地区（斯德哥尔摩） |
|
|
欧洲（苏黎世） |
|
|
以色列（特拉维夫） |
|
|
中东（巴林） |
|
|
中东（阿联酋） |
|
|
南美洲（圣保罗） |
|
|
AWS GovCloud（美国东部） |
|
|
AWS GovCloud（美国西部） |
|
Python 运行时
syn-python-selenium-3.0 的 ARN
下表列出了要在各个 AWS 区域中用于 syn-python-selenium-3.0 版本 CloudWatch Synthetics 运行时的适用 ARN。
| 区域 | ARN |
|---|---|
|
美国东部（弗吉尼亚州北部） |
|
|
美国东部（俄亥俄州） |
|
|
美国西部（加利福尼亚北部） |
|
|
美国西部（俄勒冈州） |
|
|
非洲（开普敦） |
|
|
亚太地区（香港） |
|
|
亚太地区（海得拉巴） |
|
|
亚太地区（雅加达） |
|
|
亚太地区（墨尔本） |
|
|
亚太地区（孟买） |
|
|
亚太地区（大阪） |
|
|
亚太地区（首尔） |
|
|
亚太地区（新加坡） |
|
|
亚太地区（悉尼） |
|
|
亚太地区（东京） |
|
|
加拿大（中部） |
|
|
加拿大西部（卡尔加里） |
|
|
中国（北京） |
|
|
中国（宁夏）； |
|
|
欧洲地区（法兰克福） |
|
|
欧洲地区（爱尔兰） |
|
|
欧洲地区（伦敦） |
|
|
欧洲地区（米兰） |
|
|
欧洲地区（巴黎） |
|
|
欧洲（西班牙） |
|
|
欧洲地区（斯德哥尔摩） |
|
|
欧洲（苏黎世） |
|
|
以色列（特拉维夫） |
|
|
中东（巴林） |
|
|
中东（阿联酋） |
|
|
南美洲（圣保罗） |
|
|
AWS GovCloud（美国东部） |
|
|
AWS GovCloud（美国西部） |
|
syn-python-selenium-2.1 的 ARN
下表列出了要在各个 AWS 区域中用于 syn-python-selenium-2.1 版本 CloudWatch Synthetics 运行时的适用 ARN。
| 区域 | ARN |
|---|---|
|
美国东部（弗吉尼亚州北部） |
|
|
美国东部（俄亥俄州） |
|
|
美国西部（加利福尼亚北部） |
|
|
美国西部（俄勒冈州） |
|
|
非洲（开普敦） |
|
|
亚太地区（香港） |
|
|
亚太地区（海得拉巴） |
|
|
亚太地区（雅加达） |
|
|
亚太地区（墨尔本） |
|
|
亚太地区（孟买） |
|
|
亚太地区（大阪） |
|
|
亚太地区（首尔） |
|
|
亚太地区（新加坡） |
|
|
亚太地区（悉尼） |
|
|
亚太地区（东京） |
|
|
加拿大（中部） |
|
|
加拿大西部（卡尔加里） |
|
|
中国（北京） |
|
|
中国（宁夏）； |
|
|
欧洲地区（法兰克福） |
|
|
欧洲地区（爱尔兰） |
|
|
欧洲地区（伦敦） |
|
|
欧洲地区（米兰） |
|
|
欧洲地区（巴黎） |
|
|
欧洲（西班牙） |
|
|
欧洲地区（斯德哥尔摩） |
|
|
欧洲（苏黎世） |
|
|
以色列（特拉维夫） |
|
|
中东（巴林） |
|
|
中东（阿联酋） |
|
|
南美洲（圣保罗） |
|
|
AWS GovCloud（美国东部） |
|
|
AWS GovCloud（美国西部） |
|
常见错误
错误：在本地运行 AWS SAM 项目需要 Docker。您是否已安装并正在运行它？
请务必在计算机上启动 Docker。
SAM 本地调用失败：调用 GetLayerVersion 操作时发生错误（ExpiredTokenException）：请求中包含的安全令牌已过期
确保已设置 AWS 默认配置文件。
更常见的错误
有关 SAM 常见错误的更多信息，请参阅 AWS SAM CLI 故障排除。
