规划维护时段
维护时段涵盖预期资源会出现异常行为的一段时间:补丁之夜、故障转移测试、迁移。在该时段内,Excubius 会继续监视和记录,但不会通知任何人。本指南介绍创建维护时段的三种方式,包括通过控制台和通过 API。
开始之前
- 你需要在该实体上具有 Operator 角色或更高角色。查看者可以看到维护时段,但不能创建。
- 确定范围:整个实体(其中及其下级的所有内容),或部分资源(以及在它们下面发现的所有内容,例如实例的可用性组和数据库)。
选择开始方式
| 需求 | 使用 |
|---|---|
| 工作立即开始 | Start maintenance now:从 1 分钟到 7 天 |
| 计划好的夜间维护 | Schedule a window › Once:开始和结束时间按浏览器时间设置,时长最长一年 |
| 例行时段 | Schedule a window › Every week:星期几、本地开始时间、时长和时区 |
安排每周维护时段
- 打开 Settings › Maintenance windows,在选取器中选择实体,例如 高密物流 › Production。
- 选择 Schedule a window。
- 填写 Reason。它是内部信息:会显示在控制台、警报时间线和审核日志中,绝不会显示在状态页上。
- 选择 Every week。
- 选取 Days、Local start time、Duration (minutes) 和 Time zone,例如每周六 23:00 开始,持续 180 分钟,时区为
America/Santo_Domingo。 - 在 Covers 下,保留 All of Production(其中的名称是你所选实体的名称),或选择 Only some resources 并选取资源。
- 还可以选择 Announce on the status page,并填写 Public title 和 Public description。只会发布这两项文本。
- 选择 Save window。该维护时段会显示在 Next 14 days 下。
对于一次性维护时段,请在第 4 步中选择 Once,并按浏览器时间输入其 Starts 和 Ends。
立即开始维护
- 打开 Settings › Maintenance windows 并选择实体。
- 在 Start maintenance now 下,输入 For (minutes) 和 Reason,例如 45 分钟和 修补 sql-ventas-02(变更 CHG-2231)。
- 在 Covers 下,保留整个实体(例如 All of Production),或选择 Only some resources 并选取资源。
- 选择 Start now。
该时段会连同其结束时间显示在 Active now 下。如果工作提前完成,请在其上选择 End now。
维护时段涵盖的内容
| 范围 | 涵盖 |
|---|---|
| 实体 | 该实体及其下级每个实体的所有资源,以每一时刻的树结构为准:稍后添加或移入该分支的资源也会被涵盖 |
| 部分资源 | 所选的资源(属于该实体或其下级),以及在它们下面发现的所有内容:实例的可用性组、数据库和链接服务器 |
在实例上触发的、与其某个数据库或链接服务器相关的警报,在该子项被涵盖时也被涵盖。针对某个数据库的维护时段,只会让该数据库的警报保持安静,不会影响实例的其余部分。
维护时段期间会发生什么
- 被涵盖的资源会在仪表板卡片、资源列表和资源页面上显示 维护中 状态,而不是其运行状况。
- 检查继续运行,指标继续存储,因此历史记录保持完整,并且在时段结束的那一刻就会恢复真实状态。
- 此时打开的警报会标记该时段,并且不会发送任何内容。其时间线会说明它是在维护期间打开的。
- 在时段结束前清除的警报会悄然解决,因为没有发布过任何通知。
- 时段结束时仍处于打开状态的警报,会在那时发布,就像它刚刚打开一样,并经过常规的路由、静默期和静默。
- 资源的时间线会记录每个时段的开始和结束时间,以及是否有人提前结束了它。
维护时段不是静默。静默会在一段时间内让一条现有警报保持安静;维护时段会在一段时间内让一组资源的所有内容保持安静,包括尚不存在的警报。
每周维护时段和夏令时
- 拨快时钟时,不存在的开始时间会在跳变之后立即开始。
- 拨慢时钟时,出现两次的开始时间使用第一次。
- 时长是实际经过的时间,因此跨越时钟变化的时段,在墙上时钟上会提前或推迟一小时结束。
- 时段可以跨越午夜或一周的结束:星期日 23:00 开始、持续三小时的时段,会在星期一 02:00 结束。每一次最长可持续一周。
- 在每周时段上选择 End now 只会终止当前这一次;后续各次照常进行。编辑计划会清除该效果。
更改或删除维护时段
All windows 列出该实体自己的时段、其下级实体的时段,以及从其上级继承的时段,后者标有 From 和实体名称。每个时段都有编辑和删除操作。
删除正在生效的时段会先结束它,其时间线会保留开始和结束时间。它曾标记过的警报会保留其时间线条目,但会失去指向已删除时段的链接。
角色和审核
| 操作 | 在时段所属实体上的角色 |
|---|---|
| 查看时段(生效中和即将到来的) | Viewer |
| 创建、立即开始、编辑、结束或删除 | Operator |
每项更改都会写入审核日志:maintenance.create、maintenance.start_now、maintenance.update、maintenance.end 和 maintenance.delete。
通过 API
$BASE 是 https://<your server>/api/v1,$TOKEN 是你的访问令牌;参阅快速入门:使用 API 添加 SQL Server 实例。
# a two-hour weekly slot for the whole Production branch
curl -sS -X POST "$BASE/maintenance-windows" -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' -d '{
"entity_id": "'"$PROD"'", "kind": "weekly", "reason": "Weekly index maintenance",
"weekly": {"days": ["sun"], "start_time": "02:00", "duration_minutes": 120,
"timezone": "America/Santo_Domingo"}}'
# sql-ventas-02 is being patched now, for 45 minutes
curl -sS -X POST "$BASE/maintenance-windows/now" -H "Authorization: Bearer $TOKEN" \
-H 'Content-Type: application/json' -d '{
"entity_id": "'"$PROD"'", "resource_ids": ["'"$SQL02"'"], "minutes": 45,
"reason": "Patching sql-ventas-02 (change CHG-2231)"}'
# done early
curl -sS -X POST "$BASE/maintenance-windows/$WINDOW/end" -H "Authorization: Bearer $TOKEN"
| 请求 | 用途 |
|---|---|
GET /maintenance-windows?entity={id} | 实体的时段,包括其下级的时段和继承的时段;可使用 state=active,scheduled,ended 过滤 |
GET /maintenance-windows/active 和 /upcoming | 当前处于维护中的内容,以及接下来的内容 |
POST /maintenance-windows | 创建时段:kind 为 once(带 starts_at 和 ends_at)或 weekly(带 weekly);scope 为 entity 或 resources(带 resource_ids) |
POST /maintenance-windows/now | 立即开始一个持续 minutes 的时段,作用于实体或 resource_ids |
PATCH /maintenance-windows/{id} | 更改任意字段 |
POST /maintenance-windows/{id}/end | 立即结束当前生效的这一次 |
DELETE /maintenance-windows/{id} | 删除时段;如果正在生效,会先结束它 |
若要在状态页上发布某个时段,请添加 "public": true 以及 public_title,还可以选择添加 public_description。每周时段可以用可选的 starts_at 和 ends_at 限定范围:只有在二者之间开始的各次才算数。一次性时段可以用 timezone 记录其计划时所用的时区。