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

Edge for Private Cloud バージョン 4.17.09

システム要件

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

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

apigee-influxdb は、既存の Edge ノード(Management Server ノードや Edge UI ノードなど)にインストールでき、システム要件は変更されません。

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

  • 2 コア CPU
  • 4 GB RAM
  • 250 GB のディスク容量(1 か月後にパージされたデータのモニタリング)
  • 1,000 以上の IOPS

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

apigee-influxdb のポート要件

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

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

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

apigee-telegraf の構成パラメータ

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

プロパティ

Description

INFLUXDB_URL

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

例:

http://192.168.0.1:8086

apigee-grafana の構成パラメータ

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

プロパティ

Description

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 という名前で作成します。通常、このファイルは、/opt/apigee/customer/application のような「apigee」ユーザーがアクセスできるディレクトリに保存し、「apigee」ユーザーに所有させます。

    ファイルで次のプロパティを設定して、apigee-influxdb ノードの URL(ポート 8086 を含む)を指定します。
    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 という名前で作成します。通常、このファイルは、/opt/apigee/customer/application のような「apigee」ユーザーがアクセスできるディレクトリに保存し、「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 のセットアップを実行します。これはべき等です。エラーや依存関係の欠落を確認して解決します。
    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. [クエリ] フィールドに「データベースを表示」と入力します。
        データベース system、application、events、_internal が作成されていることを確認します。
      2. [Query](クエリ)フィールドに「show server」と入力します。
        apigee-influxdb ノードが表示されていることを確認します。
  3. ダッシュボードでデータソースを確認します。
    1. メインメニューで [データソース] を選択します。3 つのデータソースのアイコンが表示されるはずです。
    2. データソースごとにアイコンを選択します。
    3. データソースの詳細ページで、[Save & Test] ボタンを選択します。
    4. データソースが正しく構成されていれば、次の形式のメッセージが表示されます。
      Success
      Data source is working

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

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

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

バージョン 4.16.09、4.17.01、4.17.05 からの更新

4.16.09、4.17.01、または 4.17.05 でベータ版の Apigee Monitoring ダッシュボードをインストールした場合は、4.17.09 のベータ版に更新できます。

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

  1. Apigee Edge 4.17.01/4.17.05 から 4.17.09 への更新Apigee Edge 4.16.09 から 4.17.09 への更新Apigee Edge 4.16.01/4.16.05 から 9.17 への更新の手順に従って、Edge を 4.17.09 に更新します。
  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/
  5. ノードごとにステップ 4 を繰り返します。

バージョン 4.16.05 からの更新

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

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

  1. Apigee Edge 4.17.01/4.17.05 から 4.17.09 への更新Apigee Edge 4.16.09 から 4.17.09 への更新Apigee Edge 4.16.01/4.16.05 から 9.17 への更新の手順に従って、Edge を 4.17.09 に更新します。
  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 停止
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf install
    > /opt/apigee/apigee-service/bin/apigee-service apigee-telegraf/apigee-service/bin/apigee-service apigee-telegraf, apigee-telegraf >


    configFile
  5. ノードごとにステップ 4 を繰り返します。