5.3 Grafanaとの連携

5.3.1 Grafana連携の概要#

Grafanaは、システムのデータを可視化するためのツールです。 Grafanaと連携することによって、SpeeDBee Synapseが収集したデータを用いてグラフを作成することができます。
1つのSpeeDBee Synapseから複数のGranafaへ接続し、ダッシュボードを作成したり、1つのGrafana内に複数のダッシュボードの作成を行うことができます。

5.3.2 Grafanaのインストール#

1. Grafanaをインストールします。インストール手順は、公式サイトを参考にしてください。

2. 以下のコマンドを実行し、プラグインのインストール先ディレクトリを作成します。

   LinuxWindowsStandalone Linux Binaries

   $ sudo mkdir -p /var/lib/grafana/plugins/SpeeDBSynapse/
   

   PS >New-Item -ItemType Directory -Path "C:\Program Files\GrafanaLabs\grafana\data\plugins\SpeeDBeeSynapse" -Force
   

   $ sudo mkdir -p <展開先ディレクトリ>/grafana-9.1.3/data/plugins/SpeeDBeeSynapse/
   

3. 任意のディレクトリに、「synapse_gplugin.tar.gz」を配置します。

   「synapse_gplugin.tar.gz」は、GrafanaとSpeeDBee Synapseが連携するためのプラグインです。SpeeDBee Synapseのインストーラと合わせて配布しています。ご不明な場合はお問い合わせください。

   お問合せフォーム: https://www.saltyster.com/contact/

4. 以下のコマンドを実行し、「synapse_gplugin.tar.gz」を配置したディレクトリに移動します。

   LinuxWindowsStandalone Linux Binaries

   $ cd <synapse_gplugin.tar.gzを配置したディレクトリ>
   

   PS >cd <synapse_gplugin.tar.gzを配置したディレクトリ>
   

   $ cd <synapse_gplugin.tar.gzを配置したディレクトリ>
   

5. 以下のコマンドを実行し、プラグインをインストールします。

   LinuxWindowsStandalone Linux Binaries

   $ sudo tar xzf synapse_gplugin.tar.gz -C /var/lib/grafana/plugins/SpeeDBSynapse/
   

   PS >tar xzf synapse_gplugin.tar.gz -C "C:\Program Files\GrafanaLabs\grafana\data\plugins\SpeeDBeeSynapse"
   

   $ sudo tar xzf synapse_gplugin.tar.gz -C <展開先ディレクトリ>/grafana-9.1.3/data/plugins/SpeeDBeeSynapse/
   

6. 以下のコマンドを実行し、Grafanaを再起動します。

   LinuxWindowsStandalone Linux Binaries

   $ sudo systemctl restart grafana-server
   

   PS >Restart-Service grafana
   

   $ cd <展開先ディレクトリ>/grafana-9.1.3
   $ sudo ./bin/grafana-server
   

   systemdへのサービス登録

   systemctlでサービスを起動したい場合は、次の手順に従ってsystemdにサービスを登録してください。

   1. サービスユニットファイルを作成

      /lib/systemd/system/grafana-server.service

      [Unit]
      Description=Grafana server
      
      [Service]
      Type=simple
      WorkingDirectory=<展開先ディレクトリ>/grafana-9.1.3
      ExecStart=<展開先ディレクトリ>/grafana-9.1.3/bin/grafana-server
      Restart=on-failure
      
      [Install]
      WantedBy=multi-user.target
      

   2. systemdにサービスを読み込ませ、サービスを起動。

      $ sudo systemctl daemon-reload
      $ sudo systemctl start grafana-server
      

5.3.3 Grafana連携での基本情報#

Grafanaとの連携を行うためには、「接続先」と「ダッシュボード」の設定を行う必要があります。

• 接続先

  SpeeDBee SynapseとGrafanaを連携させる際、どのGrafanaと通信するかの設定です。

• ダッシュボード

  SpeeDBee Synapseで収集しているデータを一つの画面上でグラフ化するための設定です。

指定した接続先に対して、ダッシュボードを作成します。

5.3.4 接続先#

5.3.4.1 接続先の追加#

1. SpeeDBee SynapseのEditモードの画面を開きます。

   

2. 設定メニューアイコンを押下し、「Grafanaセットアップ」を選択します。

   

3. ダッシュボード設定一覧が開きます。ダッシュボード設定に関しては、「ダッシュボード」を参照してください。

   

4. 「接続先」タブをクリックすると、接続先設定一覧が表示されます。

   

   項目	説明
   既定	既定の接続先（ヘッダのグラフアイコンからの遷移先を設定）
   名称	接続先一覧で使用される接続先名称
   URL	接続を行うGrafanaのURL
   データソース名	Grafanaで使用されるデータソース名

5. 「追加」を押下します。

   

6. 接続先詳細設定が開くため、入力を行います。

   

   項目	説明
   名称	接続先設定一覧で表示されます。 任意の文字列を入力してください。
   API URL	接続を行いたいGrafanaのURLを入力してください。
   APIトークン	Grafanaに接続する際に使用されるトークンです。 発行済のものがあれば直接入力してください。 ない場合は「APIトークン発行」ボタンから発行できます。 詳しくは、「APIトークン発行の流れ」を参照してください。
   遷移先URL	画面上部のヘッダにあるグラフアイコンから遷移するためのURLを入力して下さい。 通常はAPI URLと同一になるため、変更不要です。 変更を行う必要がある際は、チェックボックスにチェックを入れることで編集可能です。
   データソース名	Grafanaで使用されるデータソース名です。 通常は名称の入力値が反映されるため、変更不要です。 変更を加えたい場合は、任意の文字列を入力してください。
   データソースURL	Grafana側から本ソフトウェアのDBクエリにアクセスするためのURLです。 選択肢から選ぶか、選択肢にない場合は直接入力してください。 例: http://127.0.0.1:8081/dbquery IPアドレス部分はGrafanaから本ソフトウェアにアクセス可能なアドレスを使う必要があります。 詳しくは「DBクエリサービス」 及び「DBクエリサービスのWeb-API仕様」を参照してください。
   フォルダ名	Grafanaのダッシュボードで使用されるフォルダ名です。 任意の文字列を入力してください。

   APIトークン発行の流れ

   接続を行うGrafanaのURLを入力し、「APIトークン発行」を押下します。

   

   以下のダイアログが出現するので、項目を入力後、「発行」を押下します。

   

   項目	説明
   ユーザー名	Grafanaへのログインに必要なユーザー名 ※初期設定値は"admin"です。
   パスワード	Grafanaへのログインに必要なパスワード ※初期設定値は"admin"です。

   セットアップが完了した場合、APIトークンが自動で入力されます。
   また、「接続テスト」を押下すると右側に検証結果が表示されます。
   

   

7. 保存を押下します。

   

   1. 「保存」を押したのち、アクセストークン、データソース、フォルダに関して以下の検証を行っています。

      ・データソースに登録されたアクセストークン
      ・データソースがない場合、設定したデータソース名が既に使われていないか
      ・フォルダがない場合、設定したフォルダ名が既に使われていないか
      
      

      検証に失敗した場合、画像のようなダイアログが出現します。ダイアログが出現した場合は、入力値を設定し、「更新」を押下します。

      ※　検証に成功した場合、この操作は不要です。

      

      項目	説明
      トークン名	新しくトークンを発行する際に設定したいトークン名
      有効期間	トークンの有効期間
      単位	「有効期間」で設定した入力値の単位
      データソース名	新しくデータソースを作成する際に設定したいデータソース名
      フォルダ名	新しくフォルダを作成する際に設定したいフォルダ名

   2. アクセストークンを新しく発行した場合、ダイアログが出現するため、「はい」を押下します。
      ※アクセストークンを発行して更新した場合、DBクエリサービスの設定更新と再起動が必要になります。 手動で更新、起動する場合は、「DBクエリサービスの起動」を参照してください。
      アクセストークンを新しく発行していない場合、この操作は不要です。
      
      

      

8. 接続先設定一覧に、現在設定した接続先が追加されていることが確認できます。

   

5.3.4.2 接続先の変更・削除#

編集

次の手順で、接続先設定の編集を行うことができます。

1. 接続先設定一覧を開き、編集アイコンを押下します。

   

2. 以下の項目を入力し、「保存」を押下します。
   項目の詳細は、「接続先の追加」を参照してください。
   

   

既定の接続先

次の手順で、既定の接続先を設定することができます。
既定の接続先に設定されたURLが、ヘッダのグラフアイコンからの遷移先として使用されます。

1. 接続先設定一覧を開き、既定として設定したい接続先にチェックを入れます。

   

2. ※既定として設定済みの接続先を押下すると、既定の接続先を未設定の状態にすることができます。

   

削除

次の手順で、接続先設定の削除を行うことができます。

1. 接続先設定一覧を開き、編集アイコンを押下します。

   

2. 「削除」を押下します。
   ※削除を行う接続先設定が使用されているリソースがGrafana側に存在している場合、削除を行うとGrafana側のリソースも消去されます。
   

   

5.3.5 ダッシュボード#

5.3.5.1 ダッシュボードの追加#

1. 「ダッシュボード」タブをクリックすると、ダッシュボード設定一覧が表示されます。

   

   項目	説明
   ダッシュボード名	ダッシュボード詳細一覧で使用されるダッシュボード名
   接続先	ダッシュボードが使用する接続先

2. 「追加」を押下します。

   

3. ダッシュボード詳細設定が開くため、入力を行います。

   

   項目	説明
   ダッシュボード名	ダッシュボード設定一覧とGrafanaのダッシュボード名に表示されます。 任意の文字列を入力してください。
   接続先	ダッシュボードで使用される接続先です。 「接続先」で設定を行った接続先を設定します。 接続先が「未設定」の場合、Grafanaとの連携は行われず、ダッシュボード設定一覧に設定が追加されるのみとなります。
   コンポーネント	「データ一括追加」機能で使用されるコンポーネント名称です。 詳しくは「データ一括追加」を参照してください。
   グラフ種別	「データ一括追加」機能で使用されるグラフ種別です。 詳しくは「データ一括追加」を参照してください。

   Grafanaで表示されるダッシュボードは画像下半分にある表の項目で設定されます。
   「追加」を押下することで、行が追加されます。
   ※複数の行が存在するときは、左端のアイコンからドラッグ＆ドロップを行い、行の並び替えが可能です。
   
   

   

   項目	説明
   コンポーネント	Grafanaのダッシュボードで表示されるコンポーネントの名称です。 左クリックで選択が行えるかつ、手入力が可能です。
   データ名	コンポーネントで出力されるデータの名称です。 左クリックで選択が行えるかつ、手入力が可能です。 同じ行の「コンポーネント」で出力されているデータ名が選択できます。
   グラフ種別	Grafanaのダッシュボードで表示されるグラフ種別です。 設定を行いたいグラフ種別を選択してください。

   なお、グラフ種別は次の通りです。

   種別	説明	表示例
   折れ線グラフ	値を時系列で表示します。
   現在値	折れ線グラフを背景にし、現在値を表示します。
   テーブル	値をテーブル形式で表示します。
   ヒストグラム	値の分布を計算し、棒グラフとして表示します。
   未選択	グラフ種別設定時の初期値。未選択のまま保存することはできません。

   データ一括追加

   コンポーネントとグラフ種別を選択し、「データ一括追加」を押下します。

   

   選択を行ったコンポーネントから出力されるデータ全てが、選択を行ったグラフ種別で一括追加されます。

   

4. 「保存」を押下します。

   

   1. 接続先設定同様に「保存」を押した際、アクセストークン、データソース、フォルダの検証を行っています。(詳細は「接続先」をご覧ください。)

      このようなダイアログが出現した場合は、入力値を設定し、「更新」を押下します。

      ※　検証に成功した場合、この操作は不要です。

      

   2. アクセストークンを新しく発行した場合、ダイアログが出現するため、「はい」を押下します。

      ※アクセストークンを発行して更新した場合、DBクエリサービスの設定更新と再起動が必要になります。
      手動で更新、起動する場合は、「DBクエリサービスの起動」を参照してください。
      アクセストークンを新しく発行していない場合、この操作は不要です。
      
      

      

5. ダッシュボード設定一覧に、現在設定したダッシュボード設定が追加されていることが確認できます。

   

5.3.5.2 ダッシュボードの変更・削除#

編集

次の手順で、ダッシュボード設定の編集を行うことができます。

1. ダッシュボード設定一覧を開き、編集アイコンを押下します。

   

2. 以下の項目を入力し、「保存」を押下します。
   項目の詳細は、「ダッシュボードの追加」を参照してください。
   

   

削除

次の手順で、ダッシュボード設定の削除を行うことができます。

1. ダッシュボード設定一覧を開き、編集アイコンを押下します。

   

2. 「削除」を押下します。
   ※削除を行うダッシュボード詳細設定が使用されているリソースがGrafana側に存在している場合、削除を行うとGrafana側のリソースも消去されます。
   

   

5.3.6 Grafanaでの確認#

設定を行った接続先とダッシュボードについてGrafanaで確認を行います。

1. ヘッダのグラフアイコンを押下し、Grafana画面を開きます。

   

2. 左メニューの「Data sources」を押下します。

   

3. 「接続先」で設定した接続先が、データソースとして登録されていることが確認できます。

   

4. また、左メニューの「Dashboards」を押下します。

   

5. 「接続先」で設定したフォルダが存在していることが確認できるため、選択します。

   

6. 「ダッシュボード」で設定したダッシュボードを選択します。

   

7. 設定したグラフが確認できます。

   

5.3.7 GrafanaとDBクエリサービス#

GrafanaはSpeeDBee SynapseのDBクエリサービスを用いて、グラフを表示させるためにデータを取得しています。 DBクエリサービスとはコンポーネントの一つであり、外部からデータを参照できるようにする役割を持っています。 詳しくは「DBクエリサービス」を参照してください。

5.3.7.1 DBクエリサービスの起動#

1. 「システム」のパネルタブを押下し、システムパネルを開きます。

   

2. DBクエリサービスの設定アイコンを押下します。

   

3. 「トークン認証」をONにし、全てのトークンを選択して「保存」を押下します。

   

4. コアDBクエリの起動アイコンを押下します。既に起動している場合は、停止アイコンを押下した後に、起動アイコンを押下します。

   

5.3.8 グラフのデータ件数上限の変更#

データが一部分しか表示されていない場合、データの件数が上限を超えている場合があります。 下記の手順で、データ件数の上限を変更することができます。

1. 「ダッシュボード」の手順を実施し、グラフの一覧を表示します。

2. グラフ右上のメニューアイコンを押下します。

   

3. メニューが表示されます。その中から「Edit」を選択します。

   

4. グラフの設定画面が表示されます。この画面の「Query Limit (cnt)」という設定項目で、データ件数の上限が設定されています。 値を変更すると、グラフに反映されます。
   （「Query Limit (cnt)」のデフォルト値は10000です。）
   

   

5. 値を変更した後は、ESCキーを押下するか、画面右上の「Back to dashboard」アイコンを押下します。

   

6. グラフ一覧の画面に戻ります。画面右上の「Save dashboard」アイコンを押下します。

   

7. 「Save」を押下すると、設定が保存されます。

   

5.3.9 Grafanaデータソースの手動設定#

Grafanaを手動で操作して、データ参照を行う方法について説明します。
この設定は、「接続先」にて設定済みであれば特に設定を行う必要はありません。

1. 「アクセストークン発行」を参考に、アクセストークンを発行します。
   ※発行したアクセストークンはのちに使うので、控えておきます。
   

2. 「DBクエリサービスの起動」の手順に従って、DBクエリサービスを再起動します。

3. ヘッダのグラフアイコンを押下し、Grafana画面を開きます。

   

4. 左メニューの「Connections」アイコンにカーソルを合わせ、表示されたメニューの中から「Data sources」を選択します。

   

5. 「SpeeDBee Synapse」を選択します。

   

6. 以下の項目を入力します。

   項目	説明
   URL	「http://{ SpeeDBee Synapseが稼働している環境のIPアドレス }:{ DBクエリサービスが稼働しているポート }/dbquery」と入力してください。 ※DBクエリサービスが稼働しているポートは、DBクエリサービスコンポーネントの設定項目「ポート」で確認、変更することができます。詳細は「DBクエリサービス」をご覧ください。
   API Key	上の手順で発行したアクセストークンを入力してください。

   

7. 「Save & test」を押下し、"Success"というメッセージが表示されれば、データソースの設定は完了です。