コンテンツにスキップ

10. Grafana連携#

10.1 Grafana連携とは#

Grafanaは、様々なデータベースから得られる情報をWebブラウザ上のアプリケーションで可視化するためのオープンソースソフトウェアです。 SpeeDBee Hive(以降Hive)のGrafana連携により、コレクタが収集した各種データを、Webブラウザ上で折れ線グラフや棒グラフなどを用いて視覚的にわかりやすい形態で閲覧することができるようになります。

本書は、Grafanaへ連携するための設定方法について説明します。

10.1.1 参考#

  1. Grafana公式サイト
  2. Grafanaドキュメント

10.1.2 制限事項#

Grafanaへのデータ出力は、Hiveが動作しているデバイスと同じデバイス上で動作します。 一度に大量のデータの閲覧を行うと、Hiveのデータ収集やデータアップロード処理に影響を与える可能性があることにご注意ください。

10.2 Grafanaの利用開始手順#

10.2.1 前提条件#

  • Grafana連携が有効なHiveがインストールされている必要があります。
  • Grafanaサーバーの起動にはTCP3000番ポートが必要になります。別のポートを指定するにはGrafanaのドキュメントを参照してください。
  • HiveをGrafanaと連携させるためには、HiveのライセンスにてDBサービスオプションが有効となっている必要があります。
  • HiveのDBサービスを有効化するため、TCP 33451番ポートが必要になります。(ポート番号は設定にて変更可能です)

10.2.2 Grafanaのセットアップ#

Grafanaのセットアップ手順を説明します。

10.2.2.1 Linux(debパッケージ使用)#

Linux版で、debパッケージを使用してGrafanaをセットアップする手順を説明します。

対象のLinuxについて

Ubuntu18, Uubntu20, Raspberry Pi OSの場合はこちらの手順に従ってください。
それ以外のLinux環境についてはLinux(tarボール使用)を参照してください。

10.2.2.1.1 Grafanaのインストール#

Grafanaの公式サイトよりご利用の環境にあったインストーラーをダウンロードし、 Hiveをインストールしている機器に、Grafanaをインストールします。 下記はUbuntu18.04、Ubuntu20.04、Raspberry Pi OSにてGrafanaをインストールする場合の手順です。

$ wget https://dl.grafana.com/oss/release/grafana_8.3.3_amd64.deb
$ sudo apt install ./grafana_8.3.3_amd64.deb
$ wget https://dl.grafana.com/oss/release/grafana-rpi_8.3.3_armhf.deb
$ sudo apt install ./grafana-rpi_8.3.3_armhf.deb
10.2.2.1.2 SpeeDBee Hiveプラグインの設定#

HiveのGrafanaプラグインのファイルを、Grafanaプラグインパスへコピーします。

$ mkdir -p /var/lib/grafana/plugins/SpeeDBeeHive
$ cp -r /usr/local/share/speedbeehive/grafana_plugin/dist /var/lib/grafana/plugins/SpeeDBeeHive/
10.2.2.1.3 Grafanaサービス自動有効化・開始・停止#

Linux版でdebパッケージからインストールした場合は、以下の手順で開始・停止を制御できます。

$ systemctl enable grafana-server
$ systemctl start grafana-server
$ systemctl stop grafana-server

10.2.2.2 Linux(tarボール使用)#

Linux版で、tarボールを使用してGrafanaをセットアップする手順を説明します。

適用環境について

Grafanaのdeb, rpmを使用できない環境ではこちらの手順に従ってください。
現時点ではCONEXIO BlackBear環境でのみ動作確認済みです。

10.2.2.2.1 Grafanaのインストール#

Grafanaを/opt配下にインストールする手順を示します。
他の場所にインストールする場合は適宜パスを読み替えてください。

$ cd /opt
$ wget https://dl.grafana.com/oss/release/grafana-8.3.3.linux-armv7.tar.gz
$ tar -zxvf grafana-8.3.3.linux-armv7.tar.gz
10.2.2.2.2 SpeeDBee Hiveプラグインの設定#

HiveのGrafanaプラグインのファイルを、Grafanaプラグインパスへコピーします。

$ cd /opt/grafana-8.3.3
$ mkdir -p data/plugins/SpeeDBeeHive
$ cp -r /usr/local/share/speedbeehive/grafana_plugin/dist data/plugins/SpeeDBeeHive/
10.2.2.2.3 Grafanaサービス自動有効化・開始・停止#

tarボールを使用してインストールした場合、Grafanaは自動で起動しません。システム 起動時に自動でGrafanaを起動する場合、下記の内容のファイルを配置してください。

配置先: /lib/systemd/system/grafana-server.service
[Unit]
Description=Grafana server

[Service]
Type=simple
WorkingDirectory=/opt/grafana-8.3.3
ExecStart=/opt/grafana-8.3.3/bin/grafana-server
Restart=on-failure

[Install]
WantedBy=multi-user.target

その後、下記コマンドを実行することでGrafanaの自動起動を有効化し、開始・停止を制御できます。

$ systemctl enable grafana-server
$ systemctl start grafana-server
$ systemctl stop grafana-server
10.2.2.2.4 Grafanaのアンインストール#

Grafanaのアンインストールを行う場合は下記の手順を実施してください。

$ rm -rf /opt/grafaga-8.3.3

10.2.2.3 Windows#

Windows版でGrafanaをセットアップする手順を説明します。

詳細はこちらのドキュメントを参照してください。

10.2.2.3.1 Grafanaのインストール#

こちらのリンクから、「Download the installer」をクリックしてインストーラーをダウンロードします。

ダウンロード後、インストーラーをクリックし、Grafanaをインストールします。

10.2.2.3.2 SpeeDBee Hiveプラグインの設定#

以下の手順で、SpeeDBee Hiveプラグインの有効化を行います。

  1. 以下のディレクトリに移動して、「dist」フォルダをコピーします。

    C:/Program Files/SALTYSTER/SpeeDBeeHive/share/speedbeehive/grafana/plugin
    
  2. 以下のディレクトリに移動して、コピーしたフォルダを貼り付けます。 ディレクトリがない場合は、新規作成します。

    C:/Program Files/GrafanaLabs/grafana/data/plugins/SpeeDBeeHive/dist
    
  3. Grafanaを再起動します。再起動の方法は次節を参照してください。

10.2.2.3.3 Grafanaサービス開始・停止・再起動#

Windows版でインストーラーからインストールした場合は、以下の手順で開始・停止を制御できます。

  1. Windowsメニューで「service」と入力し、「サービス」を起動します。
    サービスツール起動
  2. サービス一覧の中からGrafanaを選択、右クリックします。
  3. 表示されたコンテキストメニューから「開始」、「停止」、「再起動」などの操作を実行できます。
    サービスツール起動

10.2.3 Grafanaの起動#

Grafanaサービスを開始した状態で、ブラウザから下記URLへアクセスします。

http://{ホスト名}:3000/

ホスト名はGrafanaやHiveを起動しているデバイスのIPアドレスやホスト名に置き換えてください。デフォルトのユーザー名、パスワードはどちらも「admin」です。適宜変更してください。

10.2.4 Hive側の事前設定#

SpeeDBee Hiveで行う事前設定について説明します。

10.2.4.1 コレクタの設定#

コレクタについては特別な設定は必要ありません。下記マニュアルを参照し、任意のコレクタを登録してください。

10.2.4.2 データベースサービスの設定#

GrafanaからHiveのデータベースにアクセスするため、下記手順に従いデータベースの外部I/Fを設定する必要があります。

  1. サービスを選択し、ツリーよりデータベースを選択します。
    データベース設定1
  2. 任意の「ユーザー名」、「パスワード」を入力、
    データベース設定2
  3. 「無効にする」のチェックが入っている場合は、チェックを外し、「更新」を選択します。
    データベース設定3
  4. Hiveを起動します。

10.3 Grafanaでのデータ可視化#

Grafana画面の設定を行います。ここでは、Hiveで取得したデータを Grafanaで閲覧するために必要な最低限の設定のみ行います。 Data Sources、Dashboards、Panelなどの編集・削除などの設定はGrafanaドキュメントを参照してください。

10.3.1 Data Sourcesの登録#

Data Sourcesの登録を行います。

  1. Grafana画面の左側にある設定(歯車)アイコンから、Data Sourcesを選択します。
    データソースの設定

  2. 「Add data source」を選択します。
    データソースの追加

  3. 「Others」の「SpeeDBee Hive」で「Select」を選択します。
    SpeeDBee Hiveプラグインの選択

  4. Grafana入力項目の表を参考に入力し、「Save & Test」を選択します。
    SpeeDBee Hiveプラグインの設定

  5. 右上に、Datasource updated と表示されると成功です。
    SpeeDBee Hiveプラグインの設定成功

Grafana入力項目 説明
URL Linux版では「http://localhost/grafana」
Windows版では「http://localhost:8120/grafana」を入力してください。
HiveのWeb画面のポート番号を変更している場合はそのポート番号と合わせる必要があります。
DB Port 接続するポート番号
Hiveのデータサービスにて設定したポートを入力してください。
DB User ID 接続するユーザーID
Hiveのデータサービスにて設定した「ユーザー名」を入力してください。
DB User Pass 接続するパスワード
Hiveのデータサービスにて設定した「パスワード」を入力してください。

10.3.2 ダッシュボードの登録#

DashBoradsの登録を行います。

10.3.2.1 パネルの作成#

  1. Grafana画面左側にある 「+」のアイコンから、「Dashboard」を選択します。
    ダッシュボードの追加
  2. 「Add an empty panel」を選択します。
    ダッシュボードにパネルを追加
  3. 「Query」にて、「Column name」を選択します。
    パネル内のカラム設定

    「Column name」をクリックすると、Hiveで収集しているデータ名のリストが表示されま す。閲覧したいデータ名を選択してください。
    データ名が表示されない場合は、Hiveが起動しているか、また、Hiveのデータベース設定、GrafanaのData Sourcesの設定などを確認してください。

  4. 閲覧するデータを追加したい場合は、「+Query」を選択し、追加のカラムを選択します。 パネル内のカラム追加

  5. 「Save」を選択し、追加したパネルを保存します。
    パネルの保存
  6. ダッシュボードの右上にある、表示時間幅とリフレッシュ間隔の設定を行います。
    ダッシュボードの時間幅とリフレッシュ間隔の設定
  7. 「Save dashboard」ボタンをクリックし、ダッシュボード名を入力してダッシュボードを保存します。
    ダッシュボード保存1
    ダッシュボード保存2

10.3.2.2 ダッシュボードの参照#

以下の手順でダッシュボードを閲覧します。

  1. Grafana左側の「Dashboards」アイコンより、「Manage」を選択します。
    ダッシュボード選択
  2. 閲覧したいダッシュボードを選択します。
    ダッシュボード選択
  3. 設定したダッシュボードを閲覧できます。
    ダッシュボードの閲覧
  4. 閲覧データの編集を行いたい場合は、パネルのタイトル右にある「v」をクリックして「Edit」を選択し、Dashboardの登録 と同様にパネルを編集、保存してください。
    パネルの編集