创建 Canary - Amazon CloudWatch
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

创建 Canary

重要

确保使用 Synthetics Canary 来仅监控您拥有所有权或权限的终端节点和 API。根据 Canary 运行频率设置,这些端点可能会面临流量增加的情况。

当您使用 CloudWatch 控制台创建 Canary 时,您可以使用 CloudWatch 提供的蓝图创建您的 Canary,也可以编写您自己的脚本。有关更多信息,请参阅 使用 Canary 蓝图

如果使用的是您自己的 Canary 脚本,您还可以使用 Amazon CloudFormation 创建 Canary。有关更多信息,请参阅 Amazon CloudFormation 用户指南中的 AWS::Synthetics::Canary

如果您正在编写自己的脚本,则可以使用 CloudWatch Synthetics 已内置在库中的多个函数。有关更多信息,请参阅 Synthetics 运行时版本

创建 Canary

  1. 访问 https://console.aws.amazon.com/cloudwatch/,打开 CloudWatch 控制台。

  2. 在导航窗格中,选择 Canaries

  3. 选择 Create Canary (创建 Canary)

  4. 选择以下选项之一:

    • 要将某个蓝图脚本作为 Canary 的基础,请选择 Use a blueprint (使用蓝图),然后选择要创建的 Canary 的类型。有关每种类型的蓝图执行的操作的更多信息,请参阅使用 Canary 蓝图

    • 要上传您自己的 node.js 脚本以创建自定义 Canary,请选择 Upload a script (上传脚本)

      然后,您可以将脚本拖入 Script (脚本) 区域,或者选择 Browse files (浏览文件),在文件系统中浏览找到该脚本。

    • 要从 S3 存储桶导入脚本,请选择 Import from S3 (从 S3 导入)。然后,在 Source location (源位置) 下,输入 Canary 的完整路径或选择 Browse S3 (浏览 S3)

      您必须对您使用的 S3 存储桶具有 s3:GetObjects3:GetObjectVersion 权限。存储桶必须位于您在其中创建 Canary 的同一 Amazon 区域内。

  5. Name (名称) 下,输入 Canary 的名称。此名称将用于许多页面,因此,我们建议您为该 Canary 提供一个描述性名称,以将它与其他 Canary 区分开来。

  6. Application or endpoint URL (应用程序或终端节点 URL) 下,输入您希望 Canary 测试的 URL。此 URL 必须包含协议(例如 https://)。

    如果您希望 Canary 测试 VPC 上的终端节点,还必须在此过程随后的步骤中输入有关 VPC 的信息。

  7. 如果您将自己的脚本用于 Canary,请在 Lambda handler (Lambda 处理程序) 下,输入您希望 Canary 开始的入口点。如果您使用 syn-nodejs-puppeteer-3.4syn-python-selenium-1.1 之前版本的运行时,则您输入的字符串必须以 .handler 结尾。如果您使用 syn-nodejs-puppeteer-3.4syn-python-selenium-1.1 或之后版本的运行时,则此限制不适用。

  8. 如果在脚本中使用环境变量,请选择 Environment variables(环境变量),然后为脚本中定义的每个环境变量指定值。有关更多信息,请参阅 环境变量

  9. Schedule(计划)下,选择是运行此 Canary 一次、使用 rate 表达式连续运行,还是使用 cron 表达式对其进行计划。

    • 当您使用 CloudWatch 控制台创建连续运行的 Canary 时,您可以在每分钟一次到每小时一次之间的范围内选择一个运行速率。

  10. (可选)要为 canary 设置超时值,请选择 Additional configuration(其它配置),然后指定该超时值。此值不要短于 15 秒钟,以预留 Lambda 冷启动以及启动 canary 工具的时间。

  11. Data retention (数据保留) 下,指定保留有关失败和成功的 Canary 运行的信息的时间。范围为 1 - 455 天。

  12. Data Storage (数据存储) 下,选择要用于存储来自 Canary 运行的数据的 S3 存储桶。存储桶名称不能包含句点 (.)。如果将此选项保留空白,将使用或创建默认 S3 存储桶。

    如果您使用的是 syn-nodejs-puppeteer-3.0 或更高版本的运行时,在文本框中输入存储桶的 URL 时,您可以指定当前区域或其他区域中的存储桶。如果您使用的是较早版本的运行时,则存储桶必须位于当前区域中。

  13. (可选)默认情况下,Canary 将自己的构件存储在 Amazon S3 上,并使用 Amazon 托管式 Amazon KMS 密钥将构件静态加密。您可以通过选择 Data Storage(数据存储)部分的 Additional configuration(其他配置)来使用不同的加密选项。然后,您可以选择用于加密的密钥类型。有关更多信息,请参阅 加密 Canary 构件

  14. Access permissions(访问权限)下,选择是创建 IAM 角色来运行 Canary,还是使用现有角色。

    如果您使用 CloudWatch Synthetics 创建角色,则其会自动包含所有必要的权限。如果您要自己创建角色,请参阅 Canary 的必需角色和权限 获取有关必要权限的信息。

    如果您在创建 Canary 时使用 CloudWatch 控制台为 Canary 创建角色,则无法将该角色重新用于其他 Canary,因为这些角色仅特定于一个 Canary。如果您已手动创建了适用于多个 Canary 的角色,则可以使用现有角色。

    若要使用现有角色,您必须具有 iam:PassRole 权限,以将角色传递到 Synthetics 和 Lambda。您还必须拥有 iam:GetRole 权限。

  15. (可选)在 Alarms(告警)下,选择是否要为此 Canary 创建默认 CloudWatch 告警。如果选择创建告警,则会按照以下命名约定创建告警:Synthetics-Alarm-canaryName-index

    index 是一个数字,代表为此 Canary 创建的各个不同的告警。第一个告警的索引为 1,第二个告警的索引为 2,依此类推。

  16. (可选)要让此 Canary 测试 VPC 上的终端节点,请选择 VPC settings (VPC 设置),并执行以下操作:

    1. 选择托管终端节点的 VPC。

    2. 选择 VPC 上的一个或多个子网。您必须选择私有子网,因为在执行过程中无法为 Lambda 实例分配 IP 地址时,无法将 Lambda 实例配置为在公有子网中运行。有关更多信息,请参阅配置 Lambda 函数以访问 VPC 中的资源

    3. 在 VPC 上选择一个或多个安全组。

    如果端点位于 VPC 上,则必须启用您的 Canary 才能向 CloudWatch 和 Amazon S3 发送信息。有关更多信息,请参阅 在 VPC 上运行 Canary

  17. (可选)在 Tags (标签) 下,添加一个或多个键/值对作为此 Canary 的标签。标签可帮助您识别和组织 Amazon 资源并跟踪 Amazon 成本。有关更多信息,请参阅 标记 Amazon CloudWatch 资源

  18. (可选)在 Active tracing(活动跟踪)下,选择是否启用此 Canary 的活动 X-Ray 跟踪。仅当 Canary 使用 syn-nodejs-2.0 或更高的运行时版本时,此选项才可用。有关更多信息,请参阅 Canary 和 X-Ray 跟踪

为 Canary 创建的资源

创建 Canary 时,将创建以下资源:

  • 一个名为 CloudWatchSyntheticsRole-canary-name-uuid 的 IAM 角色(如果您使用 CloudWatch 控制台创建 Canary 并指定为 Canary 创建新角色)

  • 一个名为 CloudWatchSyntheticsPolicy-canary-name-uuid 的 IAM 策略。

  • 一个名为 cw-syn-results-accountID-region 的 S3 存储桶。

  • 名为 Synthetics-Alarm-MyCanaryName 的警报(如果您为要为 Canary 创建警报)。

  • Lambda 函数和层(如果您使用蓝图创建 Canary)。这些资源具有前缀 cwsyn-MyCanaryName

  • 名为 /aws/lambda/cwsyn-MyCanaryName 的 CloudWatch Logs 日志组。