ベータ版モニタリング ダッシュボードのインストール

Edge for Private Cloud v. 4.17.05

システム要件

ダッシュボード データを収集するには、すべての Edge ノードに apigee-telegraf をインストールする必要があります。したがって、apigee-telegraf のシステム要件は、インストールする Edge ノードと同じです。

apigee-grafana は、別のノードにインストールすることも、既存の Edge ノード（Management Server や Edge UI ノードなど）のいずれかを再利用することもできます。

apigee-influxdb の場合、システム要件を変更することなく、Management Server ノードや Edge UI ノードなどの既存の Edge ノードにインストールできます。

パフォーマンス上の理由から、apigee-influxdb を独自のノードにインストールする場合は、ノードが次の要件を満たしている必要があります。

  • 2 コアの CPU
  • 4 GB RAM
  • 250 GB のディスク容量（モニタリング データは 1 か月後に消去されます）
  • 1,000 IOPS 以上

詳細については、 InfluxData のドキュメントをご覧ください。

apigee-influxdb のポート要件

apigee-grafana と apigee-telegraf を実行しているノードがアクセスできるように、apigee-influxdb データノードでポート 8086 と 8183 を開く必要があります。

ダッシュボード コンポーネントをインストールするための構成ファイル

apigee-telegraf コンポーネントと apigee-grafana コンポーネントをインストールするには、構成ファイルを apigee-service ユーティリティに渡します。これらのファイルは、/opt/apigee/customer/application など、「apigee」ユーザーがアクセスできるディレクトリに保存し、「apigee」ユーザーが所有するようにします。

apigee-telegraf の構成パラメータ

これらのプロパティは、apigee-telegraf setup コマンドに渡すテキスト ファイルで設定します。たとえば、sa_telegraf.txt という名前のテキスト ファイルに設定します。

プロパティ

説明

INFLUXDB_URL

ポート 8086 を含む apigee-influxdb ノードの URL を指定します。

次に例を示します。

http://192.168.0.1:8086

apigee-grafana の構成パラメータ

これらのプロパティは、apigee-grafana setup コマンドに渡すテキスト ファイルで設定します。たとえば、sa_grafana.txt という名前のテキスト ファイルに設定します。

プロパティ

説明

INFLUXDB_HOST

InfluxDB ノードの IP アドレスまたは DNS 名を指定します。

例: 

192.168.0.1

INFLUXDB_PORT

Grafana データソースで使用される InfluxDB API ポート。「8086」と指定します。

GRAFANA_USERNAME

ダッシュボード UI にログインするための Grafana ユーザー名。

GRAFANA_PASSWORD

ダッシュボード UI にログインするための Grafana パスワード。

インストール手順

以下の手順に沿って、ダッシュボード コンポーネントを次の順序でインストールします。

  • apigee-influxdb（中央ノード上）
  • apigee-telegraf（各ノード）
  • apigee-grafana（中央サーバー上）

単一の Edge ノードまたはスタンドアロン ノードに apigee-influxdb をインストールする

スタンドアロン ノード、または Management Server か Edge UI を実行している Edge ノードの場合:

  1. apigee-influxdb をインストールします。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-influxdb install
  2. apigee-influxdb データベースを構成します。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-influxdb setup
  3. apigee-influxdb を起動します。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-influxdb start

すべての Edge ノードに apigee-telegraf をインストールする

Edge インストールのすべてのノードで、次の操作を行います。

  1. 最初の Edge ノードに apigee-telegraf をインストールします。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf install
  2. apigee-telegraf の構成ファイル（sa_telegraf.txt）を作成します。通常、このファイルは「apigee」ユーザーがアクセスできるディレクトリ（/opt/apigee/customer/application など）に保存し、「apigee」ユーザーが所有するようにします。

    ファイルに次のプロパティを設定して、ポート 8086 を含む apigee-influxdb ノードの URL を指定します。
    INFLUXDB_URL=http://influx_IP:8086
  3. 所有者を「apigee」に変更します。
    > chown apigee:apigee /opt/apigee/customer/application/sa_telegraf.txt
  4. apigee-telegraf を構成します。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf setup -f /opt/apigee/customer/application/sa_telegraf.txt
  5. apigee-telegraf を再起動します。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf restart
  6. すべての Edge ノードでこのプロセスを繰り返します。

単一の Edge ノードに apigee-grafana をインストールする

Edge インストールの単一ノード（Edge UI ノードなど）で、次の操作を行います。

  1. 最初の Edge ノードに apigee-grafana をインストールします。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-grafana install
  2. apigee-grafana の構成ファイル（sa_grafana.txt）を作成します。通常、このファイルは「apigee」ユーザーがアクセスできるディレクトリ（/opt/apigee/customer/application など）に保存し、「apigee」ユーザーが所有するようにします。

    ファイルに次のプロパティを設定します。これらのプロパティについては、上記で説明しています。
    INFLUXDB_HOST=192.168.56.101
    INFLUXDB_PORT=8086
    GRAFANA_USERNAME=admin
    GRAFANA_PASSWORD=admin
  3. 所有者を「apigee」に変更します。
    > chown apigee:apigee /opt/apigee/customer/application/sa_grafana.txt
  4. 構成ファイルを使用して apigee-grafana を構成します。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-grafana setup -f /opt/apigee/customer/application/sa_grafana.txt
  5. apigee-grafana を再起動します。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-grafana restart

ダッシュボードにアクセスするには、ブラウザで次の URL を開きます。

http://grafana_IP_or_DNS:3000

apigee-grafana の構成ファイルで指定した認証情報を使用してログインします。上記の例では、ユーザー名/パスワードは admin/admin です。

インストールのトラブルシューティング

ダッシュボードにデータが表示されない場合は、次の手順でインストールのトラブルシューティングを行います。

  1. apigee-telegraf がデータを収集していることを確認するには、次のコマンドを実行します。
    1. apigee-service apigee-telegraf setup を実行します。これはべき等です。エラーや依存関係の欠落を確認して解決します。
    2. apigee-telegraf を再起動し、/opt/apigee/var/log/apigee-telegraf/apigee-telegraf.log でエラーを確認します。
  2. apigee-influxdb がデータを受信していることを確認するには:
    1. apigee-influxdb データノードで、TCP ポート 8086 と 8183 が開いていることを確認します。
    2. 次の URL を使用して、ブラウザで influxdb UI を開きます。
      http://influxdb_IP_or_DNS:8183
      1. [クエリ] フィールドに「show databases」と入力します。
        次のデータベースが作成されていることを確認します。system、application、events、_internal。
      2. [Query] フィールドに「show servers」と入力します。
        apigee-influxdb ノードが一覧表示されていることを確認します。
  3. ダッシュボードのデータソースを確認します。
    1. メインメニューで [データソース] を選択します。3 つのデータソースのアイコンが表示されます。
    2. データソースごとにアイコンを選択します。
    3. データソースの詳細ページで、[Save & Test] ボタンを選択します。
    4. データソースが正しく構成されている場合は、次の形式のメッセージが表示されます。
      Success
      Data source is working

ベータ版モニタリング ダッシュボードの更新

アップグレード元の Edge のバージョンに応じて、次の 2 つの手順のいずれかを使用します。

  • 4.16.09 と 4.17.01 では同じ手順を使用します。
  • 4.16.05 では、アップデートの一環として apigee-collectd をアンインストールする必要があります。

バージョン 4.16.09 または 4.17.01 からの更新

4.16.09 または 4.17.01 で Apigee Monitoring Dashboard のベータ版をインストールした場合は、4.17.05 のベータ版に更新できます。

ベータ版のモニタリング ダッシュボードを更新するには:

  1. Apigee Edge 4.17.01 から 4.17.05 への更新、Apigee Edge 4.16.09 から 4.17.05 への更新、Apigee Edge 4.16.01/4.16.05 から 4.17.05 への更新の説明に従って、Edge を 4.17.05 に更新します。
  2. Management Server ノードで apigee-influxdb を更新します。
    > /opt/apigee/apigee-setup/bin/update.sh -c pp -f configfile

    ここで、configFile は、apigee-influx のインストールに使用した構成ファイルです。

    Management Server ノードに apigee-grafana もインストールしている場合は、この手順で apigee-grafana も更新されます。それ以外の場合は、次の手順に示すように apigee-granfana を更新します。
  3. Management Server ノードに apigee-grafana をインストールしなかった場合、インストールしたノードで apigee-grafana を更新します。
    > /opt/apigee/apigee-setup/bin/update.sh -c pp -f configfile
  4. ノード 1 の apigee-telegraf を更新します。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf update
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf setup -f configFile
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf restart
  5. すべてのノードに対してステップ 4 を繰り返します。

バージョン 4.16.05 からの更新

ダッシュボードの 4.16.05 バージョンでは、apigee-telegraf ではなく apigee-collectd が使用されていました。4.17.05 への更新の一環として、apigee-collectd をアンインストールし、apigee-telegraf をインストールします。

ベータ版のモニタリング ダッシュボードを更新するには:

  1. Apigee Edge 4.17.01 から 4.17.05 への更新、Apigee Edge 4.16.09 から 4.17.05 への更新、Apigee Edge 4.16.01/4.16.05 から 4.17.05 への更新の説明に従って、Edge を 4.17.05 に更新します。
  2. Management Server ノードで apigee-influxdb を更新します。
    > /opt/apigee/apigee-setup/bin/update.sh -c pp -f configfile

    ここで、configFile は、apigee-influx のインストールに使用した構成ファイルです。

    Management Server ノードに apigee-grafana もインストールしている場合は、この手順で apigee-grafana も更新されます。それ以外の場合は、次の手順に示すように apigee-granfana を更新します。
  3. Management Server ノードに apigee-grafana をインストールしなかった場合、インストールしたノードで apigee-grafana を更新します。
    > /opt/apigee/apigee-setup/bin/update.sh -c pp -f configfile
  4. ノード 1 に apigee-telegraf をインストールします。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-collectd stop
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf install
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf setup -f configFile
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf restart
    > /opt/apigee/apigee-service/bin/apigee-service apigee-collectd uninstall
  5. すべてのノードに対してステップ 4 を繰り返します。