管理合成监控工具

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

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

准备工作

列出合成监控工具

控制台

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

  1. 在 Google Cloud 控制台中,前往  Synthetic Monitoring 页面:

    前往合成监控

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

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

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

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

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

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

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

gcloud

如需列出您的拨测和合成监控工具,请运行 gcloud monitoring uptime list-configs 命令:

gcloud monitoring uptime list-configs

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

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

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

API

如需列出 Google Cloud 项目中的合成监视器(包括拨测),请调用 projects.uptimeCheckConfigs.list 方法:

  1. 点击projects.uptimeCheckConfigs.list
  2. 使用 API Explorer。

    将方法的父级设置为项目名称,确保您使用以下格式:

    projects/PROJECT_ID
    

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

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

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

控制台

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

  1. 在 Google Cloud 控制台中,前往  Synthetic Monitoring 页面:

    前往合成监控

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

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

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

gcloud

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

gcloud monitoring uptime describe CHECK_ID

在运行上一个命令之前,请将 CHECK_ID 替换为正常运行时间检查或合成监控器的标识符。您可以通过运行 gcloud monitoring uptime list-configs 命令并检查 name 字段来查找标识符。如需了解详情,请参阅查找合成监控器的唯一标识符

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

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

API

如需列出 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 函数,请执行以下操作:

  1. 在 Google Cloud 控制台中,前往  Synthetic Monitoring 页面:

    前往合成监控

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

  2. 找到要修改的合成监控器,点击 更多选项,然后选择修改
  3. 可选:如需修改 Cloud Run 函数,请点击修改函数,进行更改,然后点击应用函数

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

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

gcloud

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

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS

在运行上一个命令之前,请执行以下操作:

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

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

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

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

gcloud monitoring uptime update CHECK_ID --period=10

API

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

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

  1. 点击projects.uptimeCheckConfigs.patch
  2. 使用 API Explorer。

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

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
      

      在上述表达式中,PROJECT_ID 是您的 Google Cloud 项目 ID,CHECK_ID 是合成监控器 ID。

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

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

      updateMask=displayName
      

复制合成监控工具

控制台

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

  1. 在 Google Cloud 控制台中,前往  Synthetic Monitoring 页面:

    前往合成监控

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

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

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

  3. 点击创建函数,根据需要更新函数,然后点击应用函数

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

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

gcloud

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

API

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

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

删除合成监控

控制台

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

  1. 在 Google Cloud 控制台中,前往  Synthetic Monitoring 页面:

    前往合成监控

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

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

  3. 可选:如果您想删除 Cloud Run 函数,请选择 Code(代码)标签页,然后点击函数的名称。函数详情页面将在新窗口中打开。

  4. 合成监控器详情页面中,点击 Delete(删除),然后完成对话框。

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

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

gcloud

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

gcloud monitoring uptime delete CHECK_ID

在运行上一个命令之前,请将 CHECK_ID 替换为正常运行时间检查或合成监控器的标识符。您可以通过运行 gcloud monitoring uptime list-configs 命令并检查 name 字段来查找标识符。如需了解详情,请参阅查找合成监控器的唯一标识符

API

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

  1. 点击projects.uptimeCheckConfigs.delete
  2. 使用 API Explorer。

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

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
    

    在上述表达式中,PROJECT_ID 是您的 Google Cloud 项目 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 方法的响应中。

后续步骤