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

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

ダッシュボード JSON モデル

このドキュメントトピックは、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

ダッシュボードの一意の数値識別子 (db によって生成)

uid

誰でも生成できる一意のダッシュボード識別子。 文字列 (8~40)

title

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

tags

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

style

dark や などのダッシュボードのテーマ light

timezone

utc や などのダッシュボードのタイムゾーン browser

editable

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

graphTooltip

共有クロスヘアまたはツールヒントなしの場合は 0 (デフォルト)、共有クロスヘアの場合は 1、共有クロスヘアと共有ツールヒントの場合は 2

time

last 6 hours や などのダッシュボードの時間範囲 last 7 days

timepicker

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

templating

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

annotations

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

refresh

自動更新間隔

schemaVersion

JSON スキーマ (整数) のバージョン。Grafana の更新によってこのスキーマが変更されるたびに増分されます。

version

ダッシュボード (整数) のバージョン。ダッシュボードが更新されるたびに増加します。

panels

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

それぞれが 1 つのテンプレート変数を表すオブジェクトの配列

allFormat

、、、 など、データソースからすべての値を取得する際に使用する wildcard glob形式regexpipe

current

ダッシュボードに現在選択されている変数のテキスト/値を表示する

datasource

変数のデータソースを表示する

includeAll

すべての値オプションが使用可能かどうか

multi

変数値リストから複数の値を選択できるかどうか

multiFormat

データソースから時系列を取得する際に使用する形式

name

変数の名前

options

ダッシュボードで選択できる可変テキスト/値ペアの配列

query

変数の値を取得するために使用されるデータソースクエリ

refresh

変数を更新するタイミングを設定します。

regex

は、シリーズ名またはメトリクスノードセグメントの一部を抽出します。

type

変数のタイプ、customquery、または interval