規劃維護時段
維護時段涵蓋預期資源會出現異常的一段時間:修補之夜、容錯移轉測試、遷移。在時段內,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 記錄規劃時使用的時區。