grafana-util docs

dashboard list-vars

這頁在說什麼

列出線上 Grafana 的儀表板模板變數與類似 datasource 的選項,或列出本機儀表板檔案與匯出樹中的變數。

什麼時候看這頁

  • 當您需要列出變數狀態、供截圖工作流程使用、排查受變數範圍影響的儀表板 URL,或檢查本機渲染出的儀表板檔案時,使用這個指令。

適合誰

適合 SRE、Grafana 維運人員,以及要處理 dashboard 盤點、搬遷、檢查或截圖的人。

用途

列出線上 Grafana 的儀表板模板變數與類似 datasource 的選項,或列出本機儀表板檔案與匯出樹中的變數。

何時使用

當您需要列出變數狀態、供截圖工作流程使用、排查受變數範圍影響的儀表板 URL,或檢查本機渲染出的儀表板檔案時,使用這個指令。

重點旗標

  • --dashboard-uid--dashboard-url:選擇要列出變數的儀表板。
  • --input:直接讀取一個本機儀表板 JSON 檔案。
  • --input-dir:從本機匯出樹讀取儀表板。
  • --input-format:將 --input-dir 視為 rawprovisioning
  • --vars-query:疊加變數查詢字串,例如 var-env=prod&var-host=web01
  • --org-id:將檢查限制在單一 org。
  • --output-format:輸出 tablecsvtextjsonyaml
  • --no-header:隱藏表格或 CSV 標頭。
  • --output-file:將輸出複本寫到磁碟。

範例

# 用途:列出線上 Grafana 的儀表板模板變數與類似 datasource 的選項。
grafana-util dashboard list-vars --profile prod --dashboard-uid cpu-main --vars-query 'var-cluster=prod-a&var-instance=node01' --output-format json
# 用途:列出線上 Grafana 的儀表板模板變數與類似 datasource 的選項。
grafana-util dashboard list-vars --url https://grafana.example.com --dashboard-uid cpu-main --vars-query 'var-cluster=prod-a&var-instance=node01' --basic-user admin --prompt-password --output-format json
# 用途:列出本機儀表板 JSON 檔案中的變數。
grafana-util dashboard list-vars --input ./dashboards/raw/cpu-main.json --output-format yaml

相關指令