設定公開狀態頁
每個實體都可以為沒有帳戶的人發佈一個狀態頁:客戶的顧客、分公司的員工、合作夥伴。它回答一個問題:我使用的服務正常嗎?,並採用該實體自己的名稱、標誌和顏色。本指南說明如何建立頁面、建立元件、發佈事故,以及發佈頁面。
開始之前
- 你需要在該頁面所代表的實體上具備 Entity admin 角色。
- 功能
ui.public_status_page必須已開啟。關閉時,頁面無法開啟,畫面也會說明這一點;超級管理員可在 Settings › Instance 中切換。 - 決定訪客應該辨認出什麼:例如 Customer portal 或 Card payments 這類服務,而不是伺服器名稱。
訪客看到的內容,以及他們絕不會看到的內容
頁面是根據允許清單逐個欄位建立的,絕不是篩選內部數據而成。
| 頁面上有 | 頁面上絕對沒有 |
|---|---|
| 標題、簡介、標誌、主題及強調色 | 資源名稱、主機名稱、類型、標記或 ID |
| 你命名的元件,按群組並依你的順序排列 | 檢查、指標、數值或閾值 |
| 每個元件的狀態及其 90 天可用性長條 | 警報、其標題、嚴重程度或數量 |
| 你發佈的事故,連同每次更新及其時間 | 發佈者、負責人,以及警報收件匣中的任何內容 |
| 你選擇公告的維護,連同其公開標題和說明 | 維護時段的內部原因 |
| RSS、Atom 和 JSON Feed 的連結,以及低調的 Sign in 連結 | 實體路徑、其他實體,或產品的名稱和標誌 |
建立頁面
-
開啟 Settings › Status page,並在選擇器中選擇實體,例如桃花島物流。
-
選取 Create a status page for 桃花島物流。頁面建立後處於未發佈狀態。
-
在 Page 下填寫設定:
設定 備註 Title 同時用作瀏覽器分頁及訂閱源的名稱 Introduction 標題下方的簡短文字 Logo address https://…,或此伺服器上的路徑,例如/logos/ciguapa.svg。留空時,若該分支有標誌則使用分支的標誌;絕不使用產品的標誌Theme 控制台的任何一個主題;預設為 Daylight Accent colour 用於連結及焦點框的顏色,或 Use the theme's Time zone of the daily bars 可用性長條中每一天的開始和結束位置。事故和維護的時間,會以每位訪客自己的時區顯示 Own domain 可選,例如 status.ciguapa.example;見下文 -
選取 Save。
Public address 是 https://<server>/status/<entity short name>。Open the public page 會開啟該頁面;Show preview 會在此處顯示預覽,無論頁面是否已發佈。
新增元件
元件是訪客能夠辨認的項目。它會追蹤該頁面所屬實體或其下實體的資源:整個資源,或者當只有某項檢查對服務有意義時,追蹤資源的單一檢查。
- 在 Components 下,選取 Add a component。
- 輸入 Name(例如 Card payments),並可選擇輸入 Description 和 Group。相同群組的元件會顯示在一起。
- 在 Follows 下,選擇一個 Resource,以及 The whole resource 或其中一項 Check,然後選取 Follow。對服務所依賴的每個資源重複此步驟。
- 保持選取 Show the 90-day availability bar,除非百分比對這個元件沒有多大意義。
- 將 Status shown 保持為 From what it follows。
- 選取 Save component。
使用箭頭可以變更順序。畫面會在每個元件旁邊顯示它所追蹤的資源的狀態,因此很容易發現已過時的手動狀態。
| 它所追蹤的項目顯示 | 元件狀態 |
|---|---|
| 所有被追蹤的資源都正常;info 層級的檢查視為正常 | Operational(運作正常) |
| 其中一個處於警告 | Degraded performance(效能降級) |
| 部分處於嚴重或無法連線 | Partial outage(部分中斷) |
| 所有有回報的資源都處於嚴重 | Major outage(嚴重中斷) |
| 全部都處於維護時段內 | Under maintenance(維護中) |
| 尚未有任何回報 | 頁面上為 Operational,長條中為 No data |
處於維護中的資源既不加分也不扣分:一個數據庫節點處於維護中、另一個正常時,狀態為 Operational。已靜音的資源按其檢查的真實狀態計算,因為靜音改變的是通知,而不是服務。
若要手動覆寫狀態,例如在你比檢查掌握更多資訊時選擇 Major outage,請在 Status shown 中選擇它。之後再把它改回 From what it follows。
發佈頁面
- 使用 Show preview 檢查頁面。
- 在 Page 下,選取 Published,然後選取 Save。
頁面未發佈時,其位址會回應 not found;預覽仍然可以使用。
回報事故
- 在 Incidents 下,選取 Report an incident。
- 輸入 Title、Impact(No impact、Minor impact、Major impact 或 Critical impact)、Affected components、Status 及第一則 Message。
- 選取 Report。事故及其第一次更新會連同時間顯示在頁面及訂閱源中。
- 隨著掌握更多資訊,請使用 Post update 發佈更新,每次更新都附帶狀態(Investigating(調查中)、Identified(已識別)、Monitoring(監察中)或 Resolved(已解決))及訊息。
開啟中的事故會把其所影響元件的狀態至少提高到與其影響相符的程度:minor 對應 Degraded performance,major 對應 Partial outage,critical 對應 Major outage。發佈 Resolved 會關閉事故;它會在 Past incidents 下保留 30 天。
透過 API,你也可以更正較早一次更新的文字(但不能更正其時間或狀態),並可在事後以開始時間回報事故。
公告維護
建立維護時段時,請選取 Announce on the status page,並填寫 Public title 和(可選的)Public description;請參閱規劃維護時段。該時段會顯示在所有「其元件追蹤該時段所涵蓋資源」的實體的頁面上:進行期間顯示在 Maintenance 下,否則顯示 30 天內的下一次時段。每週時段會顯示為重複進行,而不是列出每一週。只會顯示公開標題和說明,絕不會顯示內部原因。
以自己的網域提供頁面
若要把頁面發佈為 https://status.ciguapa.example/status/ciguapa:
- 以
CNAME或A記錄,把該名稱的 DNS 指向伺服器。 - 請超級管理員在 Settings › Server and certificates 中把該名稱新增為別名,並且(使用 Let's Encrypt 或自有憑證時)讓它保留在憑證的名稱之中。請參閱設定名稱及 TLS。
- 在頁面的 Own domain 中輸入該名稱,然後選取 Save。
透過該名稱開啟頁面時,頁面及其訂閱源中的連結便會使用該名稱。該名稱的根目錄 https://status.ciguapa.example/ 仍會開啟控制台的登入頁面,所以請分享帶有 /status/<short name> 的完整位址。
設定分支外觀
Settings › Branch appearance 可以在實體上設定 Default theme 和 Logo address;其下的每個實體都會繼承,直到它設定自己的值為止。In effect 會顯示結果及其來源。沒有自己標誌的狀態頁會使用其實體的標誌。在此版本中,控制台本身尚未套用分支的主題;無論如何,個人自己選擇的主題都會優先於它。
可用性
每個元件都會按頁面時區的每一天,記錄它在每種狀態停留了多久。遇到夏令時間更改的日子有 23 或 25 小時。長條每天顯示一格,電腦上顯示 90 格,平板電腦上 60 格,手機上 30 格,顏色按當天持續一分鐘或以上的最差狀態決定,並可透過懸停、輕按或鍵盤焦點顯示詳細資料。
- 每日正常運作率 = 1 − (嚴重中斷 + 0.3 × 部分中斷) ÷ 已知時間。效能降級視為正常運作。維護和 No data 不計入已知時間,因此計劃內的工作絕不會拉低數字。
- 頭條百分比以相同公式計算 90 天。最近才建立的元件會顯示自第一天起的 uptime since。
- 只要期間內有任何停機時間,最高只會顯示 99.99%,絕不會是 100%。
- 歷史記錄保留 400 天。新的時區只套用於新的日子;已記錄的日子保留其原有的邊界。
訂閱源及快取
頁面連結到其事故更新及已公告維護的三個訂閱源:RSS 2.0、Atom 1.0 和 JSON Feed 1.1,位於 /api/v1/status/<short name>/feed.rss、feed.atom 和 feed.json。加上 ?lang=es 可取得西班牙文標籤。尚不提供電子郵件訂閱。
公開位址不需要登入,提供成本很低。頁面以 Cache-Control: public, max-age=30 及 ETag 回應,訂閱源則使用 max-age=300,因此前端的 CDN 或代理伺服器可以原樣快取。回應帶有 Access-Control-Allow-Origin: *,因此其他網站可以讀取 JSON。
使頁面離線
- 若要暫時隱藏頁面,請清除 Published 並儲存。其位址會立即回應 not found。
- 關閉功能
ui.public_status_page會對所有頁面產生相同的效果。 - Delete the page 會移除頁面,連同其元件、事故及可用性歷史記錄。此操作無法復原。