コンテンツにスキップ

5.3 Grafanaとの連携

5.3.1 概要#

Grafanaは、システムのデータを可視化するためのツールです。 Grafanaと連携することによって、SpeeDBee Synapseが収集したデータを用いてグラフを作成することができます。

Grafanaについての詳細は、公式サイトをご覧ください。

注意事項

本章の説明では、バージョン9.1.3のGrafanaを使用しています。バージョンの違いにより、操作の内容に違いがある場合がございます。

5.3.2 Grafanaのインストール#

・本項目の手順は、Grafanaをインストールする環境で行ってください。
・以降の手順は、システム管理権限を必要とする操作には、すべてsudoを使用しています。
・root権限を持つユーザーの場合は、sudoを除外したコマンドを入力してください。
・管理者権限については、OSのシステム管理者へ相談して下さい。

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

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

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

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

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

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

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

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

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

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

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

    $ sudo systemctl restart grafana-server

5.3.3 Grafanaのセットアップ#

本項目の手順の前に、「Grafanaのインストール」が完了している必要があります。

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

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

  3. 次の項目を入力し、「自動セットアップ」を押下します。

    項目 説明
    ホスト Grafanaをインストールした環境のホスト名またはIPアドレス
    ポート Grafanaが稼働しているポート
    ※初期設定では、Grafanaはポート3000で稼働します。

  4. 次の項目を入力し、「セットアップ」を押下します。

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

  5. セットアップが完了した場合、APIキーが自動で入力されています。
    また「テスト」を押下すると、画面下部に「テスト接続に成功しました。」と表示されます。

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

  7. ヘッダのGrafanaアイコンを押下すると、Grafana画面に遷移できるようになっています。

5.3.4 グラフの作成#

本項目の手順の前に、「Grafanaのインストール」、「Grafanaのセットアップ」が完了している必要があります。

5.3.4.1 データの登録#

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

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

  3. コンポーネントとグラフ種類を選択します。グラフ種類は個別で選択、もしくは「グラフ種類一括適用」を使用して一括で変更することも可能です。

    グラフ種類は次の通りです。

    種類 説明 表示例
    折れ線グラフ 値を時系列で表示します。
    現在値 折れ線グラフを背景にし、現在値を表示します。
    テーブル 値をテーブル形式で表示します。
    ヒストグラム 値の分布を計算し、棒グラフとして表示します。
    - グラフを作成しません。

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

  5. 「はい」を押下します。

  6. 「アクセストークンを発行して適用する」を選択し、トークンの名前と有効期限を入力します。

  7. 「更新」を押下します。

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

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

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

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

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

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

5.3.5 グラフの閲覧#

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

  2. 左メニューの「Dashboards」アイコンを押下します。

  3. 「SpeeDBee Synapse」というフォルダの中に、「データの登録」で登録したコンポーネントが一覧で表示されます。

  4. コンポーネントを選択します。

  5. 選択したコンポーネントの各データのグラフが、一覧で表示されます。

5.3.6 グラフの設定変更#

5.3.6.1 データ件数の上限変更#

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

  1. 「グラフの閲覧」の手順を実施し、グラフの一覧を表示します。

  2. グラフのタイトルを押下します。

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

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

    デフォルト値

    「Query Limit (cnt)」のデフォルト値は10000です。

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

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

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

    設定がリセットされるタイミング

    設定を変更した後、「データの登録」の手順を実施すると、設定がリセットされるのでご注意ください。

5.3.7 Grafana手動設定#

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

5.3.7.1 データソースを手動で設定#

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

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

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

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

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

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

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

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