创建和管理延后

本文档介绍了如何创建和管理延后。延后可防止 Cloud Monitoring 在特定时间段内创建突发事件和发出通知。每个 shuffle 都会指定它所应用到的资源。

如需了解概念性概览，请参阅暂停通知和提醒。

如需创建和管理延后，您可以使用 Google Cloud 控制台或 Cloud Monitoring API。

准备工作

确保您拥有所需的权限：
- 如需获得使用 Google Cloud 控制台查看和修改延后所需的权限，请让管理员授予您项目的 Monitoring Editor (roles/monitoring.editor) IAM 角色。如需详细了解如何授予角色，请参阅管理访问权限。
  
  您也可以通过自定义角色或其他预定义角色来获取所需的权限。
- 如需获得使用 Cloud Monitoring API 查看和修改延后所需的权限，请让管理员授予您项目的 Monitoring Pause Editor (roles/monitoring.snoozeEditor) IAM 角色。如需详细了解如何授予角色，请参阅管理访问权限。
  
  您也可以通过自定义角色或其他预定义角色来获取所需的权限。
如需详细了解 Cloud Monitoring 角色，请参阅使用 Identity and Access Management 控制访问权限。
如果您要使用本文档中的 Cloud Monitoring API 示例，请执行以下操作：
1. 创建一个环境变量 PROJECT_ID 来保存 Google Cloud 项目的 ID：
```
PROJECT_ID=PROJECT_ID
```
2. 向 Google Cloud CLI 进行身份验证：
```
gcloud auth login
```
3. 设置默认 Google Cloud 项目：
```
gcloud config set project ${PROJECT_ID}
```
4. 创建授权令牌：
```
ACCESS_TOKEN=`gcloud auth print-access-token`
```
  您必须定期刷新访问令牌。如果原来正常工作的命令突然报告您未通过身份验证，请重新发布该命令。

创建延后

为防止提醒政策创建突发事件和发送通知，请创建延后。

您可以使用 Google Cloud 控制台、gcloud CLI 或 Cloud Monitoring API 创建延后。

控制台

在 Google Cloud 控制台的导航面板中，选择 Monitoring，然后选择提醒：
进入提醒
如需根据未结突发事件创建延后，请执行以下操作：
1. 在“提醒”页面的突发事件窗格中，找到您的突发事件，然后点击其突发事件摘要。
2. 在突发事件详情页面上，点击延后，然后选择延后时长。您无法配置任何其他字段。
否则，请执行以下操作：
1. 在提醒页面上，点击创建延后。
2. 为延后输入描述性名称。此名称显示在提醒页面上。
3. 选择开始时间。您可以输入特定时间，也可以在创建延后时启动延后。
4. 输入时长。此字段的值决定了暂停持续的时长。
5. 填写延后条件部分。您可以使用提醒政策菜单选择应用延后的提醒政策。
  
  您最多可以向一个延后添加 16 个提醒政策。
  
  完成延后条件部分后，创建延后窗格会列出符合条件的过往突发事件。
6. 点击创建。

Cloud Monitoring API

如需创建延后，请向 Snooze 端点发出 POST 请求来调用 snoozes.create 方法。您必须提供一个 snooze 对象：

curl -d @my-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X POST https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes

该方法会返回 snooze 对象。"name" 字段（包含 Monitoring 生成的延后 ID）是返回的对象与 my-snooze.json 的内容之间的唯一区别：

{
  "name": "projects/my-project/snoozes/2986666341878464512",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/787884840895011889"
    ]
  },
  "interval": {
    "startTime": "2022-11-12T19:00:20Z",
    "endTime": "2022-11-12T19:05:20Z"
  },
  "displayName": "Snooze2"
}

gcloud CLI

如需创建延后，请运行 gcloud monitoring snoozes create 命令：

gcloud monitoring snoozes create --criteria-policies=LIST_OF_POLICIES --display-name=DISPLAY_NAME --start-time=START_TIME --end-time=END_TIME

在上一个命令中，end-time 必须至少比 start-time 晚一分钟。您必须遵循 ISO 8601 格式规则；不过，您可以指定绝对时间或相对时间。以下示例指定了绝对时间。如需在从当前时间起 30 分钟后开始延后，请使用 --start-time="+PTM30M"。

如果您指定了多个项目，请用英文逗号分隔这些项目。

例如，以下命令会创建显示名称为“维护周”的延后。此延后适用于两项提醒政策，并且跨越 3 月 1 日到 3 月 7 日的时间间隔：

gcloud monitoring snoozes create --display-name="Maintenance Week" \
    --criteria-policies="projects/my-project/alertPolicies/12345,projects/my-project/alertPolicies/23451" \
    --start-time="2023-03-01T03:00:00.0-0500" \
    --end-time="2023-03-07T23:59:59.5-0500"

上面的示例在 my-project 中创建以下延后：

{
 "name": "projects/my-project/snoozes/98765",
 "displayName": "Maintenance Week",
 "interval": {
   "startTime": "2023-03-01T08:00:00Z",
   "endTime": "2023-03-08T04:59:59Z"
 },
 "criteria": {
   "policies": [
     "projects/my-project/alertPolicies/12345",
     "projects/my-project/alertPolicies/23451",
   ]
 }
}

如果成功，此命令的响应类似于以下内容：

Created snooze [projects/my-project/snoozes/98765]

提醒政策的名称不会显示在 Google Cloud 控制台中。要确定提醒政策的名称，请执行以下任一操作：

运行 gcloud alpha monitoring policies list 命令。此命令的响应数据包含您的提醒政策的名称。
查看提醒政策的 JSON 表示形式。您可以使用政策详情页面上的选项，将 JSON 表示法下载到本地系统。

创建周期性延后

要创建在周期性时间间隔内发生的暂停，您可以编写一个脚本来为提醒政策创建暂停。然后，使用 cron 或 Cloud Scheduler 等作业调度器按您所需的时间表运行该脚本。

列出延后

创建延后时，系统会将其添加到项目的延后历史记录中。此记录显示已过期、活跃和即将到来的延后。您无法从此记录中移除条目，即无法删除延后。但是，在此视图中，您可以显示有关延后的详细信息，还可以执行修改或复制延后等操作。

控制台

如需查看延后列表，请执行以下操作：

在 Google Cloud 控制台的导航面板中，选择 Monitoring，然后选择提醒：
进入提醒
在延后窗格中点击查看所有延后。

延后页面会显示延后列表，以及以图形方式显示过去、即将开始和正在进行的延后的时间轴。
- 如需修改、复制、取消或结束延后，请使用相应延后的 更多选项菜单。延后状态决定可用的选项。
- 要列出所有延后，请启用显示过去的延后。默认情况下，系统只会列出活跃和即将执行的延后。
- 如需更改时间轴表格的显示时间段，请使用时间范围菜单。默认情况下，该表会显示下一个小时的数据；不过，您可以修改此字段，以指定过去或未来的时间范围。已到期的延后会保留 13 个月。
- 如要查看特定延后的详细信息，请点击查看详细信息。
- 如需查看活跃延后的摘要，请将指针放在时间轴表中活动行的阴影区域。提示会显示摘要信息。
- 如需查看活跃延后的图形表示，请展开时间轴表格的活跃行。

Cloud Monitoring API

如需列出属于某个 Google Cloud 项目的所有延后，请调用 snoozes.list 方法：

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes

该方法会返回 snooze 对象的列表。例如，当项目有一次延后时，对 snoozes.list 命令的响应如下所示：

{
  "snoozes": [
    {
      "name": "projects/my-project/snoozes/2986663705844383744",
      "criteria": {
        "policies": [
          "projects/my-project/alertPolicies/787884840895011889"
        ]
      },
      "interval": {
        "startTime": "2022-11-08T19:00:20Z",
        "endTime": "2022-11-08T19:05:20Z"
      },
      "displayName": "Snooze1"
    }
  ]
}

如需获取有关特定延后的信息，请调用 snoozes.get 方法并指定项目 ID 和延后 ID。在上一个响应中，延后 ID 为 2986663705844383744：

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}

该方法会返回单个 snooze 对象：

{
  "name": "projects/my-project/snoozes/2986663705844383744",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/787884840895011889"
    ]
  },
  "interval": {
    "startTime": "2022-11-08T19:00:20Z",
    "endTime": "2022-11-08T19:05:20Z"
  },
  "displayName": "Snooze1"
}

gcloud CLI

如需列出当前项目中的延后，请运行 gcloud monitoring snoozes list 命令：

gcloud monitoring snoozes list OPTIONAL_FLAGS

如需了解可选标志，请参阅 gcloud monitoring snoozes list 参考页面。

对此命令的响应是项目中采用 YAML 格式的延后名称列表。例如，对于 ID 为 my-project 的 Google Cloud 项目，此命令的响应为单个条目：

criteria:
  policies:
  - projects/my-project/alertPolicies/12345
  - projects/my-project/alertPolicies/23451
displayName: Maintenance Week
interval:
  endTime: '2023-03-08T04:59:59Z'
  startTime: '2023-03-01T08:00:00Z'
name: projects/my-project/snoozes/98765

如需列出特定延后的详细信息，请运行 gcloud monitoring snoozes describe 命令：

gcloud monitoring snoozes describe NAME

例如，如需显示名为 projects/my-project/snoozes/98765 的延后的详细信息，请运行以下命令：

gcloud monitoring snoozes describe projects/my-project/snoozes/98765

如果您向 describe 命令提供的 NAME 无效，则响应会包含错误代码 500 和以下消息：

Internal error encountered. Please retry after a few seconds. If internal errors persist, contact support at https://cloud.google.com/support/docs.

修改延后

您可以修改即将到来的延后的名称和时间段，也可以修改有效延后的名称和结束时间。例如，重新安排维护窗口时，您可能需要修改延后。

您无法修改过去的延后或任何延后的条件。但是，如果您想为将来的时间段安排过去的延后，则可以复制该延后并将更改应用于副本，然后再选择创建。

控制台

要修改延后，请执行以下操作：

在 Google Cloud 控制台的导航面板中，选择 Monitoring，然后选择提醒：
进入提醒
在延后窗格中点击查看所有延后。
在延后列表中，找到要修改的延后处理，然后在 更多选项菜单中选择修改延后。
完成更改后，点击保存。

Cloud Monitoring API

如需修改现有延后，请向 Snooze 端点发出 PATCH 请求来调用 snoozes.patch 方法。您必须提供修改后的 snooze 对象，并添加查询参数，以便标识要修改哪些字段。使用 curl 时，查询参数必须进行网址编码。

对于即将到来的暂停，您可以修改名称和时间段。对于处于活跃状态的延后，您可以修改其名称和结束时间。您无法修改过去的延后。

如需更新延后的 displayName，请创建一个 JSON 文件 my-updated-snooze.json，用于描述延后对象并更新显示名称。然后运行以下命令：

curl -d @my-updated-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X PATCH https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}?updateMask=displayName

该方法会返回一个 snooze 对象，该对象与文件 my-updated-snooze.json 的内容完全相同：

{
  "name": "projects/my-project/snoozes/2986665388391530496",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/7164333552684403347"
    ]
  },
  "interval": {
    "startTime": "2022-11-08T22:26:05Z",
    "endTime": "2022-11-08T22:31:05Z"
  },
  "displayName": "Updated snooze name"
}

gcloud CLI

如需修改延后，请运行 gcloud monitoring snoozes update 命令。您可以更新显示名称、开始时间和结束时间：

gcloud monitoring snoozes update NAME OPTIONAL_FLAGS

如需查看 update 命令的选项列表，请参阅 gcloud monitoring snoozes update 参考页面。

例如，如需将延后的显示名称更改为 projects/my-project/snoozes/98765，请运行以下命令：

gcloud monitoring snoozes update projects/my-project/snoozes/98765  --display-name="March Maintenance"

结束或取消延后

如果您想接收与有效延后中指定的条件匹配的资源的通知，请结束延后。例如，如果计划维护完成速度比预期更快，您可能需要结束暂停。

如果您不再需要某个即将到来的延后，可以取消该延后。取消操作将时长设置为零，并导致延后转换为过去状态。

控制台

如需结束正在进行的延后或取消即将开始的延后，请执行以下操作：

在 Google Cloud 控制台的导航面板中，选择 Monitoring，然后选择提醒：
进入提醒
在延后窗格中点击查看所有延后。
在延后列表中，找到要结束或取消的延后，然后执行以下操作之一：
- 如需结束正在进行的延后，请在 更多选项菜单中选择立即结束。
- 如需取消即将到来的延后，请在 更多选项菜单中选择取消延后。

Cloud Monitoring API

如需结束正在进行的延后，请修改延后并将结束时间设置为当前时间。有关详情，请参阅修改延后。

要取消即将到来的延后，请修改延后并将结束时间设置为延后开始时间。开始时间必须是将来的时间。有关详情，请参阅修改延后。

gcloud CLI

如需结束正在进行的延后或取消即将开始的延后，请运行 gcloud monitoring snoozes cancel 命令：

gcloud monitoring snoozes cancel NAME

例如，如需取消名为 projects/my-project/snoozes/98765 的延后，请运行以下命令：

gcloud monitoring snoozes cancel projects/my-project/snoozes/98765

复制延后

如要将现有暂停用作其他延后的模板，请创建副本。复制延后时，系统会打开延后编辑器，其中包含所有字段（开始时间除外），都会设置为原始延后中的值。您可以在点击创建之前修改所有字段。

要使用控制台复制延后，请执行以下操作：

在 Google Cloud 控制台的导航面板中，选择 Monitoring，然后选择提醒：
进入提醒
在延后窗格中点击查看所有延后。
在延后列表中，找到要修改的延后处理，然后在 更多选项菜单中选择复制延后。
将修改应用到副本，然后点击创建。

后续步骤

如需了解提醒概览，请参阅提醒概览。
如需了解通知延迟时间以及提醒政策参数的选择对通知发送时间的影响，请参阅基于指标的提醒政策的行为。
如需了解突发事件，请参阅以下文档：
- 基于指标的提醒的突发事件
- 针对基于日志的提醒的突发事件