本文档介绍了如何管理合成监控工具。您可以查看合成监控工具的列表;对于每个合成监控工具,您可以查看和修改配置、查看执行历史记录以及查看有关每次执行的详细信息。您可以使用 Google Cloud 控制台或使用 Cloud Monitoring API 来管理合成监控工具。
如需了解如何探索合成监控工具的执行结果以及指标和日志,请参阅探索合成监控工具结果。
准备工作
-
如需获取使用 Google Cloud 控制台查看和修改合成监控工具所需的权限,请让管理员授予您项目的以下 IAM 角色:
-
Monitoring Editor (
roles/monitoring.editor
) -
Cloud Functions Developer (
roles/cloudfunctions.developer
)
如需详细了解如何授予角色,请参阅管理访问权限。
-
Monitoring Editor (
本页中的 API 说明适用于 API Explorer。不过,您也可以发出 curl 命令。API Explorer 提供了 curl 语法。
列出合成监控工具
控制台
如需列出 Google Cloud 项目中的合成监控工具,请执行以下操作:
-
在 Google Cloud 控制台的导航面板中,选择 Monitoring,然后选择 综合监控:
可选:要限制列出的合成监控工具,请添加过滤条件。
每个过滤条件都由名称和值组成。 您可以将该值设置为合成监控工具名称的完全匹配或部分匹配。匹配不区分大小写。例如,如需列出名称中包含
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 控制台的导航面板中,选择 Monitoring,然后选择 综合监控:
如需打开合成监控工具详细信息页面,请找到要查看的合成监控工具,然后点击其名称。
如果您要从 Cloud Functions 提供的函数详情页面查看您的 Cloud Functions 函数,请选择代码标签页,然后点击该函数的名称。函数详情页面将在新窗口中打开。通过该页面上的标签页,您可以查看指标、日志以及配置信息。
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。
将该方法的 parent 设为合成监控工具的标识符,并务必使用以下格式:
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 Function
控制台
如需使用合成监控工具详细信息页面修改合成监控工具或其 Cloud Function,请执行以下操作:
-
在 Google Cloud 控制台的导航面板中,选择 Monitoring,然后选择 综合监控:
- 找到要修改的合成监控工具,点击 more_vert 更多选项,然后选择 Edit。
可选:如需修改 Cloud Function,请点击修改函数,进行更改,然后点击应用函数。
对于损坏链接检查工具,如需修改来源 URI 或用于定义要测试的链接的选项,请修改 Cloud Functions 函数,然后更新
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 Function,在更新函数来源后,您必须重新部署该函数。如需了解详情,请参阅部署 Cloud Functions 函数。
如需修改合成监控工具,请调用 projects.uptimeCheckConfigs.patch
方法:
- 点击“
projects.uptimeCheckConfigs.patch
”。 使用 APIs Explorer。
将该方法的 parent 设为合成监控工具的标识符,并务必使用以下格式:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
在前面的表达式中,
PROJECT_ID
是您的 Google Cloud 项目 ID,CHECK_ID
是合成监控工具的 ID。如需查找 CHECK_ID 的值,您可以发出
projects.uptimeCheckConfigs.list
方法。如需减少返回结果的数量,请添加一个过滤条件。 例如,添加过滤条件displayName="MySyntheticMonitor"
。设置方法的查询参数 updateMask,用于标识正在修改对象中的哪些字段。例如,如需更新
displayName
的值,查询参数如下所示:updateMask=displayName
复制合成监控工具
控制台
如需在 Google Cloud 项目中复制合成监控工具,请执行以下操作:
-
在 Google Cloud 控制台的导航面板中,选择 Monitoring,然后选择 综合监控:
找到要修改的合成监控工具,点击 more_vert 更多选项,然后选择 Copy。
此时会打开 Copy Synthetic Check 对话框,其中预先填充了字段,包括 Cloud Function 的副本。
点击创建函数,根据需要更新函数,然后点击应用函数。
如需保留修改,请点击创建。否则,请点击取消。
点击创建后,系统会创建并部署您的 Cloud Function,然后创建合成监控工具。
gcloud
没有可让您复制合成监控工具的 Google Cloud CLI 方法。
API
没有任何 API 方法可让您复制合成监控工具。不过,您可以通过执行以下步骤创建副本:
- 调用
projects.uptimeCheckConfigs.get
方法并保存响应。如需了解详情,请参阅查看合成监控工具的详细信息。 - 修改回答。
- 调用
projects.uptimeCheckConfigs.create
方法并将修改后的响应传递给该方法。
删除合成监控工具
控制台
如需删除合成监控工具及任何关联的提醒政策,请执行以下操作:
-
在 Google Cloud 控制台的导航面板中,选择 Monitoring,然后选择 综合监控:
找到要删除的合成监控工具,然后点击其名称。
可选:如果要删除 Cloud Function,请选择代码标签页,然后点击该函数的名称。函数详情页面将在新窗口中打开。
在合成监控工具详细信息页面中,点击
删除,然后完成对话框。您现在已删除该合成监控工具。
如需删除 Cloud Functions 函数,请转到函数详情页面,点击
删除,然后完成对话框。
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。
将该方法的 parent 设为合成监控工具的标识符,并务必使用以下格式:
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 方法的响应中。