管理合成监控工具

本文档介绍了如何管理合成监控器。您可以查看合成监视器列表，并且对于每个合成监视器，您都可以查看和修改配置、查看执行历史记录，以及查看每次执行的详细信息。您可以使用 Google Cloud 控制台或 Cloud Monitoring API 管理合成监视器。

如需了解如何探索合成监控工具的执行结果以及指标和日志，请参阅探索合成监控工具结果。

只有 Google Cloud 项目支持此功能。

准备工作

在存储合成监视器的 Google Cloud 项目中完成以下操作：

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

  • Monitoring Editor (roles/monitoring.editor)
  • Cloud Functions Developer (roles/cloudfunctions.developer)

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

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

• 本页中的 API 说明适用于 API Explorer。不过，您也可以发出 curl 命令。API Explorer 提供了 curl 语法。

• Select the tab for how you plan to use the samples on this page:

  Console

  When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

  gcloud

  In the Google Cloud console, activate Cloud Shell.

  Activate Cloud Shell

  At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  REST

  如需在本地开发环境中使用本页面上的 REST API 示例，请使用您提供给 gcloud CLI 的凭据。

  Install the Google Cloud CLI, then initialize it by running the following command:

  gcloud init

  如需了解详情，请参阅 Google Cloud 身份验证文档中的使用 REST 时进行身份验证。

列出合成监控工具

控制台

如需列出 Google Cloud 项目中的合成监视器，请执行以下操作：

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

   前往合成监控

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

2. 在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。

3. 可选：如需限制列出的哪些合成监控器，请添加过滤条件。

   每个过滤条件都由名称和值组成。 您可以将该值设置为与合成监控器名称完全匹配或部分匹配。匹配不区分大小写。例如，如需列出名称包含 default 的所有合成监视器，请执行以下操作：

   • 点击过滤表格，然后选择显示名称。
   • 输入 default，然后按回车键。

   如果您有多个过滤条件，则除非您插入 OR 过滤条件，否则这些过滤条件会由逻辑 AND 自动联接。前一示例使用 OR 过滤条件，以便在拨测名称与 default 或 Testing check 匹配时列出拨测。

合成监控工具页面会针对每个合成监控工具显示以下信息：

• 最近一次执行的状态。
• 指向该合成监控工具详细信息的链接。
• 成功率和平均执行时间。
• 提醒政策的数量。
• 如需修改、复制或删除合成监控器，以及创建提醒政策，请使用 更多选项菜单。

gcloud

如需列出您的正常运行时间检查和合成监控工具，请运行 gcloud monitoring uptime list-configs 命令：

gcloud monitoring uptime list-configs --project=PROJECT_ID

在运行上一个命令之前，请替换以下内容：

• PROJECT_ID：项目的标识符。

返回的数据包括以下内容：

• 名称和显示名称。
• 检查标识符。
• 受监控的资源。
• 两次检查之间的间隔。

您可以配置 Google Cloud CLI 命令来过滤和排序结果。

REST

如需列出 Google Cloud 项目中的合成监视器（包括正常运行时间检查），请调用 projects.uptimeCheckConfigs.list 方法：

1. 点击projects.uptimeCheckConfigs.list。

2. 使用 API Explorer。

   将方法的 parent 设置为项目名称，确保您使用以下格式：

   projects/PROJECT_ID
   

   在上述表达式中，PROJECT_ID 是您的 Google Cloud 项目 ID。

对于合成监控工具，结果包含一个标记为 syntheticMonitor 的字段。

查看合成监控工具的详细信息

控制台

如需在 Google Cloud 项目中查看合成监控工具的详细信息，请执行以下操作：

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

   前往合成监控

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

2. 在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。

3. 如需打开合成监控器详情页面，请找到要查看的合成监控器，然后点击其名称。

   如果您想通过 Cloud Run functions 提供的函数详情页面查看 Cloud Run 函数，请选择代码标签页，然后点击函数的名称。函数详情页面将在新窗口中打开。您可以通过此页面上的标签页查看指标、日志和配置信息。

gcloud

如需列出正常运行时间检查或合成监视器的详细信息，请运行 gcloud monitoring uptime describe 命令：

gcloud monitoring uptime describe CHECK_ID --project=PROJECT_ID

在运行上一个命令之前，请替换以下内容：

• PROJECT_ID：项目的标识符。
• CHECK_ID：正常运行时间检查或合成监控工具的标识符。您可以通过运行 gcloud monitoring uptime list-configs 命令并检查 name 字段来找到标识符。如需了解详情，请参阅查找合成监控器的唯一标识符。

为正常运行时间检查返回的数据包括以下内容：

• 名称和显示名称。
• 检查标识符。
• 受监控的资源。
• 两次检查之间的间隔。

REST

如需列出 Google Cloud 项目中特定合成监控工具的详细信息，请调用 projects.uptimeCheckConfigs.get 方法：

1. 点击projects.uptimeCheckConfigs.get。

2. 使用 API Explorer。

   将该方法的父级设置为合成监视器的标识符，确保您使用以下格式：

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
   

   在上面的表达式中：

   • PROJECT_ID 是您的 Google Cloud 项目 ID。
   • CHECK_ID 是合成监控器的 ID。

   例如，父级字段的值可能是：

   projects/my-project/uptimeCheckConfigs/10863117100295372627
   

   如需查找 CHECK_ID 的值，您可以发出 projects.uptimeCheckConfigs.list 方法。如需减少返回的结果数量，请添加过滤条件。例如，添加过滤条件 displayName="MySyntheticMonitor"。

修改合成监视器或 Cloud Run 函数

控制台

注意 ：如果您只想修改 Cloud Run 函数，则可以使用函数详情页面或合成监控器详情页面。在上述两种情况下，您都必须选择“修改”选项，进行更改，然后部署经过修改的 Cloud Run 函数。

如需使用合成监控工具详情页面修改合成监控工具或其 Cloud Run 函数，请执行以下操作：

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

   前往合成监控

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

2. 在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。
3. 找到要修改的合成监控器，点击 更多选项，然后选择修改。

4. 可选：如需修改 Cloud Run 函数，请点击修改函数，进行更改，然后点击应用函数。

   对于链接断开检查工具，如需修改源 URI 或用于定义要测试哪些链接的选项，请修改 Cloud Run 函数，然后更新 index.js 文件中的 options 对象。如需了解此对象的字段和语法，请参阅 broken-links-ok/index.js。

5. 如需保留所做的修改，请点击保存。否则，请点击取消。

gcloud

如需修改正常运行时间检查或合成监控器，请运行 gcloud monitoring uptime update 命令：

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS --project=PROJECT_ID

在运行上一个命令之前，请替换以下内容：

• PROJECT_ID：项目的标识符。

• CHECK_ID：正常运行时间检查或合成监控工具的标识符。您可以通过运行 gcloud monitoring uptime list-configs 命令并检查 name 字段来找到标识符。如需了解详情，请参阅查找拨测的唯一标识符。

• 指定要修改的字段。对于合成监视器，您只能更新以下字段：

  • 时段
  • 显示名称
  • 超时
  • 用户标签

例如，如需将合成监控器的周期设置为 10 分钟，请运行以下命令：

gcloud monitoring uptime update CHECK_ID --period=10 --project=PROJECT_ID

REST

合成监控器不包含提醒政策和函数，因此无法通过本部分中介绍的步骤进行修改：

• 如需修改提醒政策，请使用 Google Cloud 控制台或调用 alertPolicies.patch 方法。如需了解详情，请参阅使用 API 管理提醒政策。

• 如需修改 Cloud Run 函数，您必须在更新函数源代码后重新部署该函数。如需了解详情，请参阅部署 Cloud Run 函数。

如需修改合成监控工具，请调用 projects.uptimeCheckConfigs.patch 方法：

1. 点击projects.uptimeCheckConfigs.patch。

2. 使用 API Explorer。

   1. 将该方法的父级设置为合成监视器的标识符，该标识符的格式如下：

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
      

      在上面的表达式中：

      • PROJECT_ID 是您的项目 ID。
      • CHECK_ID 是合成监控器的 ID。

      如需查找 CHECK_ID 的值，您可以发出 projects.uptimeCheckConfigs.list 方法。如需减少返回的结果数量，请添加过滤条件。例如，添加过滤条件 displayName="MySyntheticMonitor"。

   2. 设置该方法的查询参数 updateMask，以确定要修改对象中的哪些字段。例如，如需更新 displayName 的值，则查询参数如下所示：

      updateMask=displayName
      

复制合成监控工具

控制台

如需在 Google Cloud 项目中复制合成监控器，请执行以下操作：

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

   前往合成监控

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

2. 在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。

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

   系统会打开复制合成检查对话框，其中会预先填充字段，包括 Cloud Run 函数的副本。

4. 点击创建函数，根据需要更新函数，然后点击应用函数。

5. 如需保留修改内容，请点击创建。否则，请点击取消。

   点击创建后，系统会创建并部署 Cloud Run 函数，然后创建合成监视器。

gcloud

没有任何 Google Cloud CLI 方法可用于复制合成监控器。

REST

没有任何 API 方法可让您复制合成监控工具。不过，您可以通过执行以下步骤创建副本：

1. 调用 projects.uptimeCheckConfigs.get 方法并保存响应。如需了解详情，请参阅查看合成监控工具的详细信息。
2. 修改回答。
3. 调用 projects.uptimeCheckConfigs.create 方法，并将修改后的响应传递给该方法。

删除合成监控工具

控制台

注意 ：使用 Google Cloud 控制台删除正常运行时间检查或合成监控器时，您也会删除关联的提醒政策。不过，删除合成监控工具不会删除 Cloud Run 函数。

如需删除合成监控器和任何关联的提醒政策，请执行以下操作：

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

   前往合成监控

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

2. 在 Google Cloud 控制台的工具栏中，选择您的 Google Cloud 项目。

3. 找到要删除的合成监控器，然后点击其名称。

4. 可选：如果您想删除 Cloud Run 函数，请选择 Code（代码）标签页，然后点击函数名称。函数详情页面将在新窗口中打开。

5. 在合成监控器详情页面中，点击 Delete（删除），然后完成对话框。

   您现在已删除合成监控工具。

6. 如需删除 Cloud Run 函数，请前往函数详情页面，点击 删除，然后完成对话框。

gcloud

注意 ：如果有提醒政策与正常运行时间检查或合成监控器相关联，您将无法使用 Google Cloud CLI 或 Cloud Monitoring API 删除正常运行时间检查或合成监控器。您必须先删除提醒政策。删除合成监控工具不会删除 Cloud Run 函数。

如需删除正常运行时间检查或合成监控器，请运行 gcloud monitoring uptime delete 命令：

gcloud monitoring uptime delete CHECK_ID  --project=PROJECT_ID

在运行上一个命令之前，请替换以下内容：

• PROJECT_ID：项目的标识符。
• CHECK_ID：正常运行时间检查或合成监控工具的标识符。您可以通过运行 gcloud monitoring uptime list-configs 命令并检查 name 字段来找到标识符。如需了解详情，请参阅查找合成监控器的唯一标识符。

REST

注意 ：如果有提醒政策与正常运行时间检查或合成监控器相关联，您将无法使用 Google Cloud CLI 或 Cloud Monitoring API 删除正常运行时间检查或合成监控器。您必须先删除提醒政策。删除合成监控工具不会删除 Cloud Run 函数。

如需删除合成监控工具和关联的提醒政策，请调用 projects.uptimeCheckConfigs.delete 方法：

1. 点击projects.uptimeCheckConfigs.delete。

2. 使用 API Explorer。

   将该方法的父级设置为合成监视器的标识符，确保您使用以下格式：

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
   

   在上面的表达式中：

   • PROJECT_ID 是您的项目 ID。
   • CHECK_ID 是合成监控器的 ID。

   如需查找 CHECK_ID 的值，您可以发出 projects.uptimeCheckConfigs.list 方法。如需减少返回的结果数量，请添加过滤条件。例如，添加过滤条件 displayName="MySyntheticMonitor"。

查找合成监控器的唯一标识符

创建合成监控工具后，Monitoring 会为其分配一个标识符。此标识符可嵌入合成监控器的资源名称中，格式为：

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

CHECK_ID 包含在能够创建或列出合成监视器的 Google Cloud CLI 和 Cloud Monitoring API 方法的响应中。

后续步骤

• 创建合成监控
• 探索合成监控工具的结果