View a markdown version of this page

ダッシュボード JSON モデル - Amazon Managed Grafana

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ダッシュボード JSON モデル

このドキュメントのトピックは、Grafana バージョン 9.x をサポートする Grafana ワークスペース向けです。

Grafana バージョン 12.x をサポートする Grafana ワークスペースについては、「」を参照してくださいGrafana バージョン 12 での作業。

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)

title

ダッシュボードの現在のタイトル

[タグ]

ダッシュボードに関連付けられたタグ、文字列の配列

Style

ダークやライトなどのダッシュボードのテーマ

timezone

utc やブラウザなどのダッシュボードのタイムゾーン

editable

ダッシュボードが編集可能かどうか

graphTooltip

共有十字線またはツールチップなしの場合は 0 (デフォルト）、共有十字線の場合は 1、共有十字線と共有ツールチップの場合は 2

time

過去 6 時間や過去 7 日など、ダッシュボードの時間範囲

timepicker

timepicker メタデータ。詳細については「timepicker セクション」を参照してください。

[テンプレート作成‭]

メタデータのテンプレート作成。詳細については[テンプレート作成セクションを参照してください。

annotations

注釈メタデータ。追加方法については「注釈」を参照してください。

[更新]

自動更新間隔

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: w と同じ単位の x 位置。

  • y: h と同じ単位の y 位置。

グリッドには負の重力があり、パネルの上に空のスペースがある場合にパネルを上に移動します。

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