本文档介绍了如何管理合成监控工具。您可以 查看您的合成监控工具列表,而对于每个合成监控工具,您 可以查看和修改配置、查看执行历史记录以及 每个执行作业的详细信息您可以使用 或使用 Cloud Monitoring API Google Cloud 控制台。
有关如何浏览执行结果和 指标和日志,请参阅 探索合成监控工具的结果。
准备工作
-
如需获取使用 Google Cloud 控制台查看和修改合成监控工具所需的权限, 请让管理员授予您 项目的以下 IAM 角色:
-
Monitoring Editor (
roles/monitoring.editor
) -
Cloud Functions Developer (
roles/cloudfunctions.developer
)
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
-
Monitoring Editor (
本页面上的 API 说明适用于 APIs Explorer。不过, 您也可以发出 curl 命令。API Explorer 提供了 curl 语法。
列出合成监控工具
控制台
如需列出 Google Cloud 项目中的合成监控工具,请执行以下操作:
-
在 Google Cloud 控制台中,前往 合成监控页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
可选:如需限制列出的哪些合成监控器,请添加过滤条件。
每个过滤条件都由名称和值组成。 您可以将该值设为与合成监控工具名称完全匹配 或部分匹配。匹配不区分大小写。例如,要列出 合成监控工具(名称包含
default
),请执行以下操作:- 点击过滤表格,然后选择显示名称。
- 输入
default
,然后按回车键。
如果您有多个过滤条件,则除非您插入
OR
过滤条件,否则这些过滤条件会由逻辑AND
自动联接。前一示例使用OR
过滤条件,以便在拨测名称与default
或Testing check
匹配时列出拨测。
合成监控工具页面会显示各数据来源的以下信息: 合成监控工具:
- 最近一次执行的状态。
- 指向该合成监控工具详细信息的链接。
- 成功率和平均执行时间。
- 提醒政策的数量。
- 要修改、复制或删除合成监控工具,以及创建 提醒政策,请使用 more_vert 更多选项菜单。
gcloud
要列出拨测和合成监控工具,请运行以下命令:
gcloud monitoring uptime list-configs
命令:
gcloud monitoring uptime list-configs
返回的数据包括以下内容:
- 名称和显示名称。
- 检查标识符。
- 受监控的资源。
- 两次检查之间的间隔时间。
您可以配置 Google Cloud CLI 命令来过滤和排序结果。
API
列出 Google Cloud 项目中的合成监控工具,包括
拨测时,调用
projects.uptimeCheckConfigs.list
方法:
- 点击“
projects.uptimeCheckConfigs.list
”。 使用 APIs Explorer。
将该方法的 parent 设置为项目的名称,务必确保 请使用以下格式:
projects/PROJECT_ID
在前面的表达式中,
PROJECT_ID
是您的 Google Cloud 项目 ID。
对于合成监控工具,结果中包含一个名为 syntheticMonitor
的字段。
查看合成监控工具的详细信息
控制台
如需查看 Google Cloud 项目中的合成监控工具的详细信息,请执行以下操作: 执行以下操作:
-
在 Google Cloud 控制台中,前往 合成监控页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
如需打开合成监控器详情页面,请找到要查看的合成监控器,然后点击其名称。
如果您想从以下位置查看 Cloud Run 函数: 函数详情页面 选择 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
方法:
- 点击“
projects.uptimeCheckConfigs.get
”。 使用 APIs Explorer。
将该方法的父级设置为合成监控工具的标识符。 请确保使用以下格式:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
在前面的表达式中,
PROJECT_ID
是您的 Google Cloud 项目 IDCHECK_ID
是合成监控工具 ID。例如,父字段的值可能是:
projects/my-project/uptimeCheckConfigs/10863117100295372627
如需查找 CHECK_ID 的值,您可以发出
projects.uptimeCheckConfigs.list
方法。 如需减少返回结果的数量,请添加一个过滤条件。 例如,添加过滤条件displayName="MySyntheticMonitor"
。
修改合成监控工具或 Cloud Run 函数
控制台
如需修改合成监控工具或其 Cloud Run 函数,请执行以下操作: 使用合成监控工具详情页面,执行以下操作:
-
在 Google Cloud 控制台中,前往 合成监控页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
- 找到您要修改的合成监控工具, 点击 more_vert 更多选项,然后选择修改。
可选:如需修改 Cloud Run 函数,请点击修改函数,进行更改,然后点击应用函数。
对于损坏的链接检查工具,为了修改原始 URI 或 定义要测试的关联,修改 Cloud Run 函数,然后 更新
index.js
文件中的options
对象。有关 有关此对象的字段和语法,请参阅broken-links-ok/index.js
。要保留修改,请点击保存。否则,请点击取消。
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
合成监控工具不包含提醒政策和函数,并且 因此无法按照本部分所述的步骤对其进行修改:
如需修改提醒政策,请使用 Google Cloud 控制台或调用
alertPolicies.patch
方法。如需更多信息 请参阅使用 API 管理提醒政策。如需修改 Cloud Run 函数,请在更新函数来源后执行 您必须重新部署该函数。如需了解详情,请参阅 部署 Cloud Run 函数。
要修改合成监控工具,请调用
projects.uptimeCheckConfigs.patch
方法:
- 点击“
projects.uptimeCheckConfigs.patch
”。 使用 APIs Explorer。
将该方法的父级设置为合成监控工具的标识符。 请确保使用以下格式:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
在前面的表达式中,
PROJECT_ID
是您的 Google Cloud 项目 IDCHECK_ID
是合成监控工具 ID。如需查找 CHECK_ID 的值,您可以发出
projects.uptimeCheckConfigs.list
方法。 如需减少返回结果的数量,请添加一个过滤条件。 例如,添加过滤条件displayName="MySyntheticMonitor"
。设置该方法的查询参数 updateMask,以确定要修改对象中的哪些字段。例如,要更新
displayName
的值,则查询参数如下所示:updateMask=displayName
复制合成监控工具
控制台
如需在 Google Cloud 项目中复制合成监控工具,请执行以下操作:
-
在 Google Cloud 控制台中,前往 合成监控页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
找到要修改的合成监控器,点击 more_vert 更多选项,然后选择复制。
系统随即会打开 Copy Synthetic Check 对话框,其中已预先填充了字段, 包括 Cloud Run 函数的副本。
点击创建函数,根据需要更新函数,然后 点击应用函数。
要保留您的修改,请点击创建。否则,请点击取消。
点击创建后,系统即会创建您的 Cloud Run 函数, 然后创建了合成监控工具
gcloud
没有任何 Google Cloud CLI 方法可用于复制合成监控器。
API
没有能让您复制合成监控工具的 API 方法。不过,您可以 执行以下操作进行复制:
- 调用
projects.uptimeCheckConfigs.get
方法 然后保存响应如需了解详情,请参阅 查看合成监控工具的详细信息。 - 修改回答。
- 调用
projects.uptimeCheckConfigs.create
方法,并将修改后的响应传递给该方法。
删除合成监控工具
控制台
要删除合成监控工具以及任何关联的提醒政策, 执行以下操作:
-
在 Google Cloud 控制台中,前往 合成监控页面:
如果您使用搜索栏查找此页面,请选择子标题为监控的结果。
找到您要删除的合成监控工具,然后点击 名称。
可选:如果要删除 Cloud Run 函数, 然后选择代码标签页 点击函数的名称。函数详情页面将打开 新窗口中
在合成监控工具详情页面中, 点击
删除,然后完成对话框。您现在已删除合成监控工具。
如需删除 Cloud Run 函数,请前往函数详情页面。 点击
Delete,然后完成对话框。
gcloud
要删除拨测或合成监控工具,
运行gcloud monitoring uptime delete
命令:
gcloud monitoring uptime delete CHECK_ID
在运行上一个命令之前,请将 CHECK_ID 替换为
拨测或合成监控器的标识符。您可以
方法是运行 gcloud monitoring uptime list-configs
命令,并
检查 name 字段。如需了解详情,请参阅
查找合成监控工具的唯一标识符。
API
要删除合成监控工具和关联的提醒政策,请调用
projects.uptimeCheckConfigs.delete
方法:
- 点击“
projects.uptimeCheckConfigs.delete
”。 使用 APIs Explorer。
将该方法的父级设置为合成监控工具的标识符。 请确保使用以下格式:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
在前面的表达式中,
PROJECT_ID
是您的 Google Cloud 项目 IDCHECK_ID
是合成监控工具 ID。如需查找 CHECK_ID 的值,您可以发出
projects.uptimeCheckConfigs.list
方法。 如需减少返回结果的数量,请添加一个过滤条件。 例如,添加过滤条件displayName="MySyntheticMonitor"
。
查找合成监控器的唯一标识符
合成监控工具创建后,Monitoring 为其分配一个 标识符。此标识符嵌入到 合成监控工具的资源名称,格式如下:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
CHECK_ID 包含在 Google Cloud CLI 的响应中 以及创建或列出合成监控工具的 Cloud Monitoring API 方法。