View a markdown version of this page

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

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

ダッシュボード JSON モデル

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

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

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

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

Amazon Managed Grafana のダッシュボードは、ダッシュボードのメタデータを保存する JSON オブジェクトによって表されます。ダッシュボードメタデータには、ダッシュボードプロパティ、パネルからのメタデータ、テンプレート変数、パネルクエリが含まれます。

ダッシュボードの JSON を表示する方法
  1. ダッシュボードを開きます。

  2. 上部のナビゲーションバーで、ダッシュボードの管理を選択します。

  3. ドロップダウンメニューから [JSON の表示] を選択します。

JSON フィールド

ユーザーが新しいダッシュボードを作成すると、新しいダッシュボード JSON オブジェクトが次のフィールドで初期化されます。

注記

次の JSON では、idnull として表示されます。これは、ダッシュボードが保存されるまで割り当てられるデフォルト値です。ダッシュボードを保存すると、整数値が id フィールドに割り当てられます。

{ "id": null, "uid": "cLV5GDCkz", "title": "New dashboard", "tags": [], "style": "dark", "timezone": "browser", "editable": true, "hideControls": false, "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 誰でも生成できる一意のダッシュボード識別子。uid は 8~40 文字の文字列です。
title ダッシュボードの現在のタイトル。
[タグ] ダッシュボードに関連付けられているタグ。JSON では、タグは文字列の配列です。
style ダッシュボードのテーマ (darklight など)。
timezone ダッシュボードのタイムゾーン (utc または browser)。
editable ダッシュボード編集の可否。
graphTooltip ツールチップのスタイル。
  • 0: 共有クロスヘアまたはツールチップなし (デフォルト)

  • 1: 共有クロスヘア

  • 2: 共有クロスヘアと共有ツールチップ

time ダッシュボードの時間範囲 (過去 6 時間、過去 7 日など)。
timepicker タイムピッカーメタデータ。詳細については、「タイムピッカー」を参照してください。
templating テンプレートメタデータ。詳細については、「テンプレートおよび変数」を参照してください。
annotations 注釈メタデータ。詳細については、「‏注釈」を参照してください。
refresh 自動更新間隔。
schemaVersion JSON スキーマのバージョン (整数)。Amazon Managed 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 位置。x 位置は、w と同じ列単位を使用します。

  • y – 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" }

timepicker の使用方法の詳細を以下の表に示します。

名前 使用方法
collapse timepicker が折りたたまれているかどうか
enable timepicker がアクティブ化されているかどうか
notice TODO
now TODO
refresh_intervals TODO
status TODO
type TODO

テンプレート作成

templating フィールドには、保存された値やその他のメタデータを含むテンプレート変数の配列が格納されています。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 データソースからすべての値を取得する際に使用する形式 (例: wildcardglobregexpipe)。
current ダッシュボードに現在選択されている変数テキスト/値を表示します
データソース 変数のデータソースを表示します
includeAll すべての値オプションが使用可能かどうか
multi 変数値リストから複数の値を選択できるかどうか
multiFormat データソースから時系列を取得する際に使用する形式
[名前] 変数の名前。
options: ダッシュボードで選択できる可変テキスト/値のペアの配列
query 変数の値の取得に使用されるデータソースクエリ
[更新] TODO
[正規表現] TODO
type 変数のタイプ (customquery、または interval)。