Grafana: ダッシュボードの基本的な作り方 #JSON

実施環境：

Linux

[root@testhost ~]# uname -a
Linux testhost 4.18.0-448.el8.x86_64 #1 SMP Wed Jan 18 15:02:46 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
[root@testhost ~]# cat /etc/redhat-release
CentOS Stream release 8
[root@testhost ~]# yum list installed | grep grafana
grafana-enterprise.x86_64                          10.0.3-1

prometheus：2.46.0.linux-amd64
node_exporter：1.6.1.linux-amd64

0. 概要

Grafana はデータの可視化を得意とするソフトウェアです。
その可視化の方法として最も主要なものは、やはりダッシュボードでしょう。

ダッシュボードは、複数のグラフなどを1つの画面にまとめたものです。
例えば、あるホストについて CPU 使用率、メモリ使用率、ディスク使用率を監視したいとき、項目ごとに画面を開いて並べるよりは1つの画面で一度に見れた方が楽になります。
今回は、このダッシュボードの作り方を紹介していきます。

なお、今回 Grafana で可視化するリソースには Prometheus で収集したデータを使用しています。
Prometheus で収集したデータの連携方法や Grafana 自体のインストール方法については、以下の過去記事を参照してください。

Linux: データ可視化ソフト「Grafana」を無料インストールしてみた＋「Prometheus」と連携させてみた

1. ダッシュボード作成の基本

まずは、ダッシュボードの基本的な作成方法について見ていきます。

1.1. ダッシュボードの新規作成

メニュー画面から、「 Dashboards 」を選択します。

すると、ダッシュボードの一覧画面が表示されます。
この画面で、右上の「 New 」⇒「 New Dashboard 」を選択します。

これで新しいダッシュボードが作成されます。

1.2. パネルの新規作成

今の時点では、ダッシュボード上にはまだ何もありません。
とりあえずグラフを1つ追加するために、「 Add visualization 」を選択してグラフを表示するパネルを作成します。

パネルに使用するデータソースとしては、「 Prometheus 」を選択します。

パネルの編集画面が開きます。
表示するデータの検索条件としては、「 Metric 」に「 node_cpu_seconds_total 」、「 Label filters 」に「 cpu = 0 」を指定してみます。
「 Run queries 」を押してグラフが表示されれば OK です。

画面右上の「 Apply 」を押してパネルの編集を終了します。

これで、とりあえずダッシュボード上に1つグラフが追加されました。

1.3. パネルの追加

ダッシュボード上にもう1つグラフを追加してみましょう。
「 Add 」⇒「 Visualization 」を選択します。

表示するデータについて、「 Data source 」に「 Prometheus 」を選択し、今度は「 Metric 」に「 node_memory_MemAvailable_bytes 」を選択してみます。
「 Run queries 」を押してグラフが表示されることを確認しましょう。

先ほどと同様に、「 Apply 」を選択します。

これで、ダッシュボード上のグラフが2つになりました。

1.4. ダッシュボードの保存

編集を終了してダッシュボードを保存するには、画面右上の保存ボタンを押します。

新規作成の場合は、この時点でダッシュボード名と格納場所の変更ができます。
「 Save 」を押して保存します。

これで、新しく作成したダッシュボードが保存できました。
左上の「 Dashboards 」を押して、ダッシュボードの一覧画面に戻りましょう。
一覧に、新しく作成したダッシュボードが追加されています。

1.5. ダッシュボードの編集

ダッシュボードの一覧画面でダッシュボード名を選択すれば、一度作ったダッシュボードを編集できます。

1.6. ダッシュボードの削除

ダッシュボードを削除するには、ダッシュボードの一覧画面で削除したいダッシュボードにチェックを入れ、「 Delete 」を押します。

確認メッセージが出るので、「 Delete 」を押せばグラフを削除できます。

1.7. パネルの編集

ダッシュボード上のグラフを編集するには、パネル右上のメニューボタンから「 Edit 」を選択します。

1.8. パネルの削除

ダッシュボード上のグラフを削除するには、パネル右上のメニューボタンから「 Remove 」を選択します。

確認メッセージが出るので、「 Remove 」を押せばグラフを削除できます。

2. ダッシュボードの見た目を変える

ダッシュボードについては、そのタイトルやグラフの配置などを自由に変えることができます。
次はそのような見た目の変更について試していきます。

2.1. ダッシュボードのタイトル変更

ダッシュボードのタイトルは、ダッシュボード画面右上の設定ボタンでダッシュボードの設定画面を開き、「 General 」⇒「 Name 」から変更できます。

2.2. パネルのタイトル変更

グラフのタイトルは、パネルの編集画面右の「 Panel options 」⇒「 Title 」から変更できます。

2.3. パネルの配置変更

パネル上部にカーソルを移動し、カーソルが十字になった状態でドラッグ & ドロップをすることで、グラフの配置を自由に変更することができます。

2.4. パネルのサイズ変更

パネル右下の角にカーソルを移動し、カーソルが斜めの両矢印になった状態でドラッグ & ドロップをすることで、グラフのサイズを自由に変更することができます。

2.5. グラフの種別変更

グラフの種別は、パネルの編集画面右上、グラフ種別が表示されている部分をクリックすることで変更できます。
デフォルトでは「 Time series 」と表示されているかと思います。

とりあえず「 Pie chart 」を選択した結果が以下です。
折れ線グラフから円グラフにグラフの種別が変わっていることがわかります。

なお今回は触れませんが、折れ線のスタイルなどグラフの詳細な設定はパネルの編集画面右の各種項目で編集できます。

3. ダッシュボードの変数

ダッシュボードで表示するデータについて、例えば異なるホストの情報が見たいときなど、画面の表示を動的に制御したい場合があります。
このようなときに用いるのが変数( Variable )です。

3.1. 変数の作成

変数の作成は、ダッシュボードの設定画面から「 Variables 」⇒「 Add variable 」で行います。

とりあえず今回は「 Select variable type 」を「 Text box 」(自由入力形式)に、「 Name 」を「 cpu_number 」にして「 Apply 」を押します。

これで、変数が作成できました。
変数の一覧に作った変数が表示されています。

「 Close 」を押してダッシュボード画面に戻ると、左上に変数の入力画面が追加されていることがわかります。

なお、さらに変数を追加したい場合は、変数の一覧画面から「 New variable 」を押します。

3.2. 変数の紐づけ

さて、とりあえず変数をつくりましたが、このままではこの変数は何の意味も持ちません。
というのも、変数がどこにも紐づいていないからです。
変数を活用するには、作った変数をどこかに紐づける作業が必要となります。

今回は、グラフの検索条件に入れ込んでみましょう。
この記事の 1.2 で作ったパネルについて、右上のメニューボタンを押して「 Edit 」を選択します。

「 Label filters 」の「 0 」を「 $cpu_number 」に変更します。

「 Apply 」を押して、変更を適用します。

これで、グラフの検索条件と変数が紐づきました。
試しに「 cpu_number 」に「 1 」を指定して Enter キーを押すと、グラフの検索結果が「 cpu = 0 」から「 cpu = 1 」に変わることがわかります。

3.3. 変数の編集

一度作った変数を編集したい場合は、変数の一覧画面で編集したい変数名を選択すれば編集できます。

3.4. 変数の削除

変数を削除したい場合は、変数の一覧画面で削除したい変数名の右の削除ボタンを押します。

確認メッセージが出るので、「 Remove 」を押せば変数を削除できます。

3.5. 検索期間

検索期間については、特に何も設定を変更せずともダッシュボード画面の右上から変更できます。

4. ダッシュボードのインポート・エクスポート

Grafana のダッシュボードは JSON 形式でインポート、エクスポートすることができます。
これにより、一度作ったダッシュボードを流用したり、有用なダッシュボードをコミュニティ内で共有したりすることが可能です。

4.1. インポート

まずは、インポートを試してみましょう。
今回は以下の Grafana の公式サイトで配布されているダッシュボードを読み込んでみます。

Grafana Labs

なお、上記サイトで配布しているダッシュボードであれば ID 指定でサイトから直接ダウンロードも可能ですが、今回は一旦 JSON ファイルとしてダウンロードしてからインポートを行います。

「 Node Exporter 」と検索すると、 Prometheus の node_exporter を利用したダッシュボードが出てきます。
とりあえず一番先頭の「 Node Exporter Full 」を選択してみます。

「 Revisions 」からバージョンを選択し、「 Download 」をクリックしてダッシュボードのソースをダウンロードします。

ダウンロードしたファイルは、以下のように JSON ファイルとなっています。

さて、これをインポートしてみましょう。
ダッシュボードの一覧画面で、「 New 」⇒「 Import 」を選択します。

「 Upload dashboard JSON file 」をクリックし、インポートするファイルを選択して「開く」を押します。
またはファイルを直接ドラッグ & ドロップしても OK です。

「 Name 」にインポートしたダッシュボード名が入っていることを確認し、「 Folder 」で格納先を指定します。
また、今回はデータソースとして Prometheus を利用するダッシュボードなので、「 Prometheus 」に「 Prometheus 」を指定するようにしてください。
全て指定したら「 Import 」を押します。