grafana-util docs

alert

這一頁對應的工作流

工作流常用子命令
盤點現況list-ruleslist-contact-pointslist-mute-timingslist-templates
匯出 / 匯入 / 比對exportimportdiff
變更規劃與套用planapplydelete
規則 / 聯絡點 / 路由撰寫new-ruleadd-ruleclone-rulenew-contact-pointadd-contact-pointnew-templateset-routepreview-route

從這裡開始

  • 先盤點:alert list-rulesalert list-contact-points
  • 先看現況再改:alert exportalert diff
  • 先規劃再套用:alert planalert apply
  • 先建草稿:alert new-rulealert new-contact-pointalert new-template
  • 先調路由:alert set-routealert preview-route

說明

grafana-util alert 把告警工作流收在同一個入口:從盤點、匯出、比對,到路由設計、草稿撰寫,再到 plan / apply。這頁適合先搞懂規則、通知路由與 contact point 的關係,再決定要往哪個子命令深入。

採用前後對照

  • 採用前:告警工作常分散在 UI、臨時 export,或不容易重跑的 shell 指令裡。
  • 採用後:同一個命令群組就能把 inventory、撰寫、diff、規劃與套用放在一起。

成功判準

  • 你在開始前就能判斷這次 alert 變更屬於盤點、撰寫、路由設計,還是 review / apply
  • plan 或 export 可以一路走到 review,而不會把 policy 或 routing context 弄丟
  • 同一條流程也能在 CI 或事故回顧時重跑

失敗時先檢查

  • 如果 inventory 指令抓到的東西比預期少,先確認 auth scope 是否涵蓋需要的 org 或 folder
  • 如果 review 或 apply 步驟怪怪的,先看 alert plan JSON,再決定是不是 CLI 真有問題
  • 如果結果要交給自動化,請把輸出格式寫清楚,讓下游步驟知道 contract

主要旗標

  • --profile--url--token--basic-user--basic-password
  • --prompt-password--prompt-token--timeout--verify-ssl
  • 巢狀子命令涵蓋 exportimportdiffplanapplydeleteadd-ruleclone-ruleadd-contact-pointset-routepreview-routenew-rulenew-contact-pointnew-templatelist-ruleslist-contact-pointslist-mute-timingslist-templates

範例

# 先盤點目前有哪些 alert 規則。
grafana-util alert list-rules --profile prod --json
# 先把現況匯出,再拿去做 diff 或 review。
grafana-util alert export --url http://localhost:3000 --basic-user admin --basic-password admin --output-dir ./alerts --overwrite
# 先試跑規劃,不要直接套用。
grafana-util alert plan --url http://localhost:3000 --basic-user admin --basic-password admin --output-format json

相關命令

盤點

搬移

變更前檢查

規則與路由撰寫