grafana-util docs

datasource modify

這頁在說什麼

透過 Grafana API 修改一個線上 Grafana datasource。

什麼時候看這頁

  • 當某個 datasource 已經存在,而您需要更新它的 URL、驗證、JSON payload 或其他線上設定時,使用這個指令。

適合誰

適合要管理 Grafana data source 設定、依賴檢查與復原流程的維運人員。

用途

透過 Grafana API 修改一個線上 Grafana datasource。

何時使用

當某個 datasource 已經存在,而您需要更新它的 URL、驗證、JSON payload 或其他線上設定時,使用這個指令。

重點旗標

  • --uid:要修改的 datasource UID。
  • --set-url:替換 datasource URL。
  • --set-access:替換 datasource 存取模式。
  • --set-default:設定或取消預設 datasource 旗標。
  • --basic-auth--basic-auth-user--basic-auth-password:更新基本驗證設定。
  • --user--password--with-credentials--http-header:更新支援的請求設定。
  • --tls-skip-verify--server-name:更新與 TLS 相關的設定。
  • --json-data--secure-json-data--secure-json-data-placeholders--secret-values:更新結構化欄位與秘密值。
  • --dry-run--table--json--output-format--no-header:預覽輸出控制。

範例

# 用途:透過 Grafana API 修改一個線上 Grafana datasource。
grafana-util datasource modify --url http://localhost:3000 --token "$GRAFANA_API_TOKEN" --uid prom-main --set-url http://prometheus-v2:9090 --dry-run --json
# 用途:透過 Grafana API 修改一個線上 Grafana datasource。
grafana-util datasource modify --url http://localhost:3000 --token "$GRAFANA_API_TOKEN" --uid prom-main --set-default true --dry-run --table

採用前後對照

  • 採用前:更新 live datasource 常常得手動編 JSON 或跑過多個 UI 分頁。
  • 採用後:一個指令就能先預覽實際會套用的 live 更新,讓變更在落地前先變成可審查內容。

成功判準

  • 在 mutation 開始前,UID 就能對上正確的 datasource
  • --dry-run 顯示的 URL、驗證或 JSON 欄位符合預期
  • 預設值與 secret 更新在 live 變更前都看得見

失敗時先檢查

  • 如果預覽碰到錯的 datasource,先確認 UID 再重跑
  • 如果 auth 或 TLS 變更不完整,先把預覽 payload 與目前 live 設定對照一次
  • 如果某個 secret 欄位沒有解開,先檢查 placeholder 對應或 profile 預設值

相關指令