儀表板 JSON 模型 - Amazon Managed Grafana

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

儀表板 JSON 模型

本文件主題專為支援 Grafana 9.x 版的 Grafana 工作區而設計。

如需支援 Grafana 10.x 版的 Grafana 工作區，請參閱使用 Grafana 第 10 版。

如需支援 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": [],
  "style": "dark",
  "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

儀表板的唯一數字識別符 （由 db 產生）

uid

可由任何人產生的唯一儀表板識別符。 字串 (8-40)

標題

儀表板的目前標題

tags

與儀表板相關聯的標籤，字串陣列

樣式

儀表板主題，例如深色或淺色

timezone

儀表板的時區，例如 utc 或瀏覽器

可編輯

儀表板是否可編輯

graphTooltip

無共用十字線或工具提示 （預設），請按 0；共用十字線，請按 1；共用十字線，請按 2；共用工具提示

time

儀表板的時間範圍，例如過去 6 小時或過去 7 天

計時字元

timepicker 中繼資料，如需詳細資訊，請參閱 timepicker 區段

範本化

範本中繼資料，請參閱範本區段以取得詳細資訊

註釋

註釋中繼資料，請參閱如何新增中繼資料的註釋

重新整理

自動重新整理間隔

schemaVersion

JSON 結構描述 （整數） 的版本，每次 Grafana 更新對所述結構描述帶來變更時都會遞增

version

儀表板版本 （整數），每次更新儀表板時都會遞增

面板

面板陣列 （如需詳細資訊，請參閱下文）

面板

面板是儀表板的建置區塊。它包含資料來源查詢、圖形類型、別名等。面板 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

"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"
      }
    ]
  }