创建损坏链接检查工具

本文档介绍了如何通过创建合成监视器来配置对 URI 中包含的链接的定期测试。您可以指定测试选项（例如来源 URI、要测试的链接数量和重试次数），然后部署预配置的 Cloud Run 函数。为了帮助您排查问题和进行调试，合成监视器会保存有关每项测试的详细信息，包括屏幕截图。借助屏幕截图，您可以查看应用客户看到的确切响应。

如需详细了解合成监控工具，请参阅合成监控工具简介。

关于链接损坏检查工具

每个断开链接检查工具都会串行测试链接，并且有一个可配置的整体合成超时。

默认情况下，断开的链接检查工具会执行以下操作：

  • 在来源 URI 中搜索具有 href 属性的 HTML 锚链接元素。
  • 测试在来源 URI 上找到的前 10 个链接。
  • 对于每个链接，检查工具都会发出请求，然后最多等待 30 秒以接收响应。收到响应后，检查器会验证 HTTP 响应状态是否为 200，这表示响应成功。检查器不会执行重试。

您可以指定来源 URI。您可以配置断开链接检查工具要搜索的 HTML 元素、要测试的元素的数量上限、每次测试的超时时间，以及是否执行重试。您还可以配置断开链接检查工具，让其等待选择器显示。

链接损坏检查工具使用 broken-links-ok 模板。断链检查器的配置由 index.js 文件的 options 对象指定。如果您使用 Google Cloud 控制台创建检查器，系统会提示您输入每个配置选项，并为您更新 Cloud Run 函数。但是，如果您使用的是 Cloud Monitoring API 或 Terraform，则必须填充此对象。

创建断开链接检查器后，如需修改配置，请更新 options 对象并重新部署 Cloud Run 函数。

准备工作

  1. 如需获得使用 Google Cloud 控制台查看和修改合成监视器所需的权限，请让管理员向您授予项目的以下 IAM 角色：

    如需详细了解如何授予角色，请参阅管理对项目、文件夹和组织的访问权限。

    您也可以通过自定义角色或其他预定义角色来获取所需的权限。

  2. Enable the Cloud Monitoring API, Artifact Registry API, Cloud Build API, Cloud Functions API, Cloud Logging API, Pub/Sub API, and Cloud Run Admin API APIs.

    Enable the APIs

  3. 验证您的 Google Cloud 项目是否包含默认的 Compute Engine 服务账号。此服务账号会在您启用 Compute Engine API 时创建，并且名称类似于 12345-compute@developer.gserviceaccount.com。

    在 Google Cloud 控制台中，前往服务账号页面：

    前往服务账号

    如果您使用搜索栏查找此页面，请选择子标题为 IAM 和管理的结果。

    如果默认的 Compute Engine 服务账号不存在，请点击创建服务账号，然后完成对话框。

  4. 确保默认的 Compute Engine 服务账号或您创建的服务账号已被授予“编辑者”(roles/editor) 角色。

    如需查看授予服务账号的角色，请执行以下操作：

    1. 在 Google Cloud 控制台中，进入 IAM 页面：

      前往 IAM

      如果您使用搜索栏查找此页面，请选择子标题为 IAM 和管理的结果。

    2. 选择包括 Google 提供的角色授权。
    3. 如果您的合成监控器使用的服务账号未列出，或者未被授予包含 Cloud Trace Agent (roles/cloudtrace.agent) 角色权限的角色，请向您的服务账号授予此角色。
  5. 配置您要用于接收通知的通知渠道。我们建议您创建多种类型的通知渠道。如需了解详情，请参阅创建和管理通知渠道以及使用 API 创建和管理通知渠道。

创建损坏链接检查工具

控制台

使用 Google Cloud 控制台创建合成监控器时，系统会部署一个新的 Cloud Run 函数（第 2 代），并创建该 Cloud Run 函数的监控器。您无法创建用于监控现有 Cloud Run 函数的合成监控器。

  1. 确保您已启用所需的 API，您的项目包含默认 Compute Engine 服务账号，并且此账号已被授予“Editor”（roles/editor）角色。如需了解详情，请参阅开始前须知。

  2. 在 Google Cloud 控制台中，前往  Synthetic Monitoring 页面：

    前往合成监控

    如果您使用搜索栏查找此页面，请选择子标题为监控的结果。

  3. 选择创建合成监控工具。
  4. 选择链接断开检查工具作为模板。
  5. 输入合成监控器的名称。

  6. 可选：更新响应超时、检查频率，并添加用户定义的标签。

  7. 配置要测试的 URI 和元素：

    1. 点击来源 URI，然后输入要测试的 URI。您输入的值必须是 HTTP 或 HTTPS 端点。例如，您可以输入 https://mywebsite.example.com。

    2. 可选：在要跟踪的链接数量中，更新要测试的链接数量上限。此字段的默认值为 10。

    3. 可选：在 HTML 元素选择器字段中，以英文逗号分隔列表的形式输入要匹配的 HTML 元素。您输入的值会转换为字符串，然后传递给 Document: querySelectorAll() 方法。

      默认情况下，此字段设置为 a，与锚点匹配。如果您想同时匹配锚点和图片，可以输入 a, img 等值。

    4. 可选：在要跟踪的 HTML 属性字段中，输入要匹配的 HTML 属性。您输入的以英文逗号分隔的值会单独传递给 getAttribute() 方法。

      默认情况下，此字段设置为 href，用于指定链接的 URI。您可以输入多个属性，例如，您可以输入 href, src。在此示例中，代码会搜索属性 href，然后搜索属性 src。

    5. 可选：配置等待选择器、每个 URI 超时、重试次数和预期状态代码：

      1. 点击显示更多选项。

      2. 如需配置断开的链接检查工具，使其在抓取任何链接之前等待特定选择器出现在 URI 中，请在等待元素选择器字段中输入 CSS 选择器。您输入的值会转换为字符串，然后传递给 page.waitForSelector() 方法。

        如果选择器未在超时期限结束前显示，系统会在日志中记录失败情况。

      3. 更新选择要用于测试的链接的顺序。

      4. 配置重试。

        默认情况下，系统会向每个关联发送一个请求，如果初始请求因任何原因（例如命令超时或 HTTP 状态代码不是 200）而失败，则相应关联会被标记为失败。

        此字段指定在将链接标记为失败之前，断开链接检查工具可以向链接发出 HTTP 请求的次数。

      5. 配置适用于每个 URI 的超时设置。默认情况下，此值设置为 30 秒。

      6. 如需为特定 URI 指定预期状态代码和超时时间，请点击添加按链接选项，然后完成对话框。

  8. 可选：配置是否收集和保存回答的屏幕截图。如果您使用默认设置，系统不会保存屏幕截图。如果您启用屏幕截图收集功能，则可以为所有测试或仅为失败的测试收集屏幕截图。Cloud Monitoring 使用以下惯例为 Cloud Storage 存储桶命名：

    gcm-PROJECT_ID-synthetics-LOCATION

    在上面的表达式中：

    • PROJECT_ID：您的 Google Cloud 项目的 ID。
    • LOCATION：Cloud Storage 存储桶的位置。

    您可以选择使用现有的 Cloud Storage 存储桶。

  9. 检查您的配置，确保其正确无误且完整无缺，然后创建 Cloud Run 函数：

    1. 点击创建函数。

      当您点击创建函数时，URI 配置字段中的值会复制到 index.js 文件中的 Options 对象。点击创建函数后，如需更改配置，请修改 Options 对象。

    2. 输入显示名称，然后选择一个区域。名称在一个区域内必须是唯一的。

    3. 在运行时、构建、连接和安全设置部分中，执行以下操作：

      • 在连接标签页中，确保已选择允许所有流量。

      • 查看默认设置，并根据需要进行更新。

      • 在运行时服务账号字段中，选择一个服务账号。

    4. 点击应用函数。

  10. 配置提醒政策：

    1. 可选：更新提醒政策名称和发送通知前的失败时长。

    2. 添加通知渠道。

  11. 点击创建。

    您定义的 Cloud Run 函数会构建并部署为第 2 代，系统会创建合成监控工具。

API

使用 Cloud Monitoring API 创建断开链接检查器的过程与创建任何其他合成监视器的过程相同。如需了解如何使用 Cloud Monitoring API 创建合成监控工具，请参阅创建合成监控工具，然后选择“Cloud Monitoring”标签页。

链接损坏检查工具使用 broken-links-ok 模板。断链检查器的配置由 index.js 文件的 options 对象指定。

定义 options.screenshot_options 结构后，损坏的链接检查工具会收集屏幕截图并将其保存到 Cloud Storage 存储桶中。如果未定义 screenshot_options.storage_location 字段或其值为空字符串，则“监控”会创建一个 Cloud Storage 存储桶，并将屏幕截图保存到该存储桶中。Monitoring 使用以下惯例为 Cloud Storage 存储桶命名：

gcm-PROJECT_ID-synthetics-LOCATION

在上面的表达式中：

  • PROJECT_ID：您的 Google Cloud 项目的 ID。
  • LOCATION：Cloud Storage 存储桶的位置。

Terraform

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。 如需了解详情，请参阅 Terraform 提供程序参考文档。

使用 Terraform 创建断开链接检查器的过程与创建任何其他合成监视器的过程完全相同。如需了解如何使用 Terraform 创建合成监控工具，请参阅创建合成监控工具，然后选择“Terraform”标签页。

链接损坏检查工具使用 broken-links-ok 模板。断链检查器的配置由 index.js 文件的 options 对象指定。

定义 options.screenshot_options 结构后，损坏的链接检查工具会收集屏幕截图并将其保存到 Cloud Storage 存储桶中。如果未定义 screenshot_options.storage_location 字段或其值为空字符串，则“监控”会创建一个 Cloud Storage 存储桶，并将屏幕截图保存到该存储桶中。Monitoring 使用以下惯例为 Cloud Storage 存储桶命名：

gcm-PROJECT_ID-synthetics-LOCATION

在上面的表达式中：

  • PROJECT_ID：您的 Google Cloud 项目的 ID。
  • LOCATION：Cloud Storage 存储桶的位置。

探索结果

对于每次执行，断开链接检查工具都会执行以下操作：

  • 生成一个表格，其中每一行都提供有关特定 URI 的测试信息。摘要信息包括目标 URI、延迟时间、状态和 HTML 元素标识符。例如，测试 HTML 锚点元素时，此列会列出 a。如果行对应于起始 URI，则 HTML 元素标识符的值为 -。

  • 收集指标、跟踪记录数据和日志数据。

  • 收集屏幕截图（如果已配置）。

如需详细了解如何探索收集的数据，请参阅探索合成监控结果。

问题排查

本部分提供了一些信息，可帮助您排查断开链接检查工具的问题。

无法修改断开链接检查工具的配置

您使用 Google Cloud 控制台创建了断开链接检查工具，现在想要更改要测试的 HTML 元素，或者修改 URI 超时、重试、等待选择器和每个链接选项。但是，当您修改断开链接检查工具时，Google Cloud 控制台不会显示配置字段。

如需解决此失败问题，请执行以下操作：

  1. 在 Google Cloud 控制台中，前往  Synthetic Monitoring 页面：

    前往合成监控

    如果您使用搜索栏查找此页面，请选择子标题为监控的结果。

  2. 找到要修改的合成监控器，点击 更多选项，然后选择修改。
  3. 点击修改函数。

  4. 修改 index.js 文件中的 options 对象，然后点击应用函数。

    如需了解此对象的字段和语法，请参阅 broken-links-ok/index.js。

  5. 点击保存。

Google Cloud 控制台显示屏幕截图保存失败

您创建了一个链接损坏检查工具，并将其配置为保存屏幕截图。不过，Google Cloud 控制台会显示以下某条警告消息以及更详细的信息：

  • InvalidStorageLocation
  • StorageValidationError
  • BucketCreationError
  • ScreenshotFileUploadError

如需解决这些失败问题，请尝试执行以下操作：

  • 如果您看到 InvalidStorageLocation 消息，请验证名为 options.screenshot_options.storage_location 的字段中指定的 Cloud Storage 存储桶是否存在。

  • 查看与您的 Cloud Run 函数相关的日志。如需了解详情，请参阅查找日志。

  • 验证相应 Cloud Run 函数中使用的服务账号是否具有 Identity and Access Management 角色，以便其创建、访问和写入 Cloud Storage 存储分区。

后续步骤