儀表板模型

本文件主題是針對支援 Grafana 10.x 版的 Grafana 工作區所設計。

如需支援 Grafana 9.x 版的 Grafana 工作區，請參閱。在 Grafana 第 9 版中工作

如需支援 Grafana 8.x 版的 Grafana 工作區，請參閱。在 Grafana 第 8 版中工作

在 Grafana 儀表板由 JSON 對象，其中存儲其儀表板的元數據表示。管控面板詮釋資料包括管控面板性質、面板中的詮釋資料、樣板變數和面板查詢

若要檢視儀表板的 JSON

1. 導覽至儀表板。

2. 在頂端導覽功能表中，選取 [儀表板設定 (齒輪)] 圖示。

3. 選取 [JSON 模型]。

JSON 欄位

當使用者建立新的儀表板時，會使用下列欄位初始化新的儀表板 JSON 物件。

注意

在以下 JSON 中，id 顯示為 null，這是指派給它的預設值，直到儲存儀表板為止。儲存儀表板後，會為欄位指派一個整數id值。

{
  "id": null,
  "uid": "cLV5GDCkz",
  "title": "New dashboard",
  "tags": [],
  "timezone": "browser",
  "editable": true,
  "graphTooltip": 1,
  "panels": [],
  "time": {
    "from": "now-6h",
    "to": "now"
  },
  "timepicker": {
    "time_options": [],
    "refresh_intervals": []
  },
  "templating": {
    "list": []
  },
  "annotations": {
    "list": []
  },
  "refresh": "5s",
  "schemaVersion": 17,
  "version": 0,
  "links": []
}

以下說明儀表板 JSON 中的每個欄位。

名稱	用量
id	儀表板的唯一數字標識符（由數據庫生成）
uid	任何人都可以生成的唯一儀表板標識符。字符串（8-40）
title	儀表板的當前標題
tags	與儀表板相關的標籤，字符串數組
style	儀表板的主題，例如dark或 light
timezone	儀表板的時區，例如utc或 browser
editable	儀表板是否可編輯
graphTooltip	0 表示無共用十字游標或工具提示 (預設)，共用十字游標為 1，共用十字游標為 2 個，共用十字游標和共用工具提示
time	儀表板的時間範圍，例如last 6 hours或 last 7 days
timepicker	時間選擇器元數據，請參閱時間選擇器部分了解
templating	模板元數據，有關詳細信息，請參閱模板部分
annotations	註釋元數據，請參閱註釋以了解如何添加它們
refresh	自動刷新間隔
schemaVersion	JSON 結構描述 (整數) 的版本，每次 Grafana 更新對此結構描述進行變更時都會遞增
version	儀表板的版本（整數），每次更新儀表板時都會遞增
panels	面板陣列（有關詳細信息，請參閱下一節）

面板

嵌板是管控面板的建構區塊。它由數據源查詢，圖形類型，別名等組成。面板 JSON 由 JSON 物件陣列組成，每個物件都代表不同的面板。大多數欄位對於所有面板都是通用的，但某些欄位取決於面板類型。以下是文字面板的面板 JSON 範例。

"panels": [
  {
    "type": "text",
    "title": "Panel Title",
    "gridPos": {
      "x": 0,
      "y": 0,
      "w": 12,
      "h": 9
    },
    "id": 4,
    "mode": "markdown",
    "content": "# title"
  }

面板尺寸和位置

GridPOS 屬性描述了在網格坐標面板的大小和位置。

• w-1 到 24（儀表板的寬度分為 24 列）

• h— 以格點高度單位表示，每個單位代表 30 像素。

• x— x 位置，與相同的單位w。

• y— y 位置，與之相同的單位h。

如果嵌板上方有空白空間，則網格具有負重力會向上移動嵌板。

時間選擇器

"timepicker": {
    "collapse": false,
    "enable": true,
    "notice": false,
    "now": true,
    "refresh_intervals": [
      "5s",
      "10s",
      "30s",
      "1m",
      "5m",
      "15m",
      "30m",
      "1h",
      "2h",
      "1d"
    ],
    "status": "Stable",
    "type": "timepicker"
  }

模板

該templating字段包含模板變量的數組及其保存的值以及一些其他元數據。

"templating": {
    "enable": true,
    "list": [
       {
        "allFormat": "wildcard",
        "current":  {
          "tags": [],
          "text": "prod",
          "value": "prod"
        },
        "datasource": null,
        "includeAll": true,
        "name": "env",
        "options": [
           {
            "selected": false,
            "text": "All",
            "value": "*"
          },
           {
            "selected": false,
            "text": "stage",
            "value": "stage"
          },
           {
            "selected": false,
            "text": "test",
            "value": "test"
          }
        ],
        "query": "tag_values(cpu.utilization.average,env)",
        "refresh": false,
        "type": "query"
      },
       {
        "allFormat": "wildcard",
        "current":  {
          "text": "apache",
          "value": "apache"
        },
        "datasource": null,
        "includeAll": false,
        "multi": false,
        "multiFormat": "glob",
        "name": "app",
        "options": [
           {
            "selected": true,
            "text": "tomcat",
            "value": "tomcat"
          },
           {
            "selected": false,
            "text": "cassandra",
            "value": "cassandra"
          }
        ],
        "query": "tag_values(cpu.utilization.average,app)",
        "refresh": false,
        "regex": "",
        "type": "query"
      }
    ]
  }

下表說明範本欄位的用法。

名稱	用量
enable	模板是否已啟用
list	一個對象數組，每個對象代表一個模板變量
allFormat	從資料來源擷取所有值時使用的格式，包括wildcard、glob、regex、pipe。
current	顯示儀表板上目前選取的變數文字/值
datasource	顯示變數的資料來源
includeAll	是否所有值選項都可用
multi	是否可以從變量值列表中選擇多個值
multiFormat	從資料來源擷取時間序列時使用的格式
name	變數名稱
options	可在儀表板上選擇可變文字/值對的陣列
query	用於擷取變數值的資料來源查詢
refresh	設定何時重新整理變數
regex	擷取系列名稱或度量節點區段的一部分
type	變數、customquery、或類型 interval