apigee-monit による自己回復

Apigee Edge for Private Cloud には、オープンソースの monit ユーティリティに基づくツールである apigee-monit が含まれています。apigee-monit は Edge サービスを定期的にポーリングします。サービスが利用できない場合、apigee-monit はサービスの再起動を試みます。

apigee-monit を使用するには、手動でインストールする必要があります。標準インストールの一部ではありません。

デフォルトでは、apigee-monit は 60 秒ごとに Edge サービスのステータスを確認します。

クイック スタート

このセクションでは、apigee-monit をすぐに使い始める方法について説明します。

Amazon Linux または Oracle-Linux-7.X を使用している場合は、まず Fedora を介して monit をインストールします。それ以外の場合は、この手順をスキップします。

sudo yum install -y https://kojipkgs.fedoraproject.org/packages/monit/5.25.1/1.el6/x86_64/monit-5.25.1-1.el6.x86_64.rpm

apigee-monit をインストールする手順は次のとおりです。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit install
/opt/apigee/apigee-service/bin/apigee-service apigee-monit configure
/opt/apigee/apigee-service/bin/apigee-service apigee-monit start

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c component_name

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c all

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c component_name

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c all

/opt/apigee/apigee-service/bin/apigee-service apigee-monit report

/opt/apigee/apigee-service/bin/apigee-service apigee-monit summary

cat /opt/apigee/var/log/apigee-monit/apigee-monit.log

これらのトピックやその他のトピックについては、以降のセクションで詳しく説明します。

apigee-monit について

apigee-monit は、ノード上のすべてのコンポーネントが稼働し続けるようにします。このために、以下を含むさまざまなサービスが提供されます。

• 失敗したサービスの再起動
• 概要情報の表示
• ロギングのモニタリング ステータス
• 通知の送信
• Edge 以外のサービスのモニタリング

Apigee では、apigee-monit をモニタリングして、実行されていることを確認することをおすすめします。詳細については、apigee-monit をモニタリングするをご覧ください。

apigee-monit アーキテクチャ

Apigee Edge for Private Cloud のインストールと構成の際に、クラスタ内の各ノードに apigee-monit の個別のインスタンスをインストールすることもできます。これらの個別の apigee-monit インスタンスは、互いに独立して動作します。コンポーネントのステータスを他のノードに通知することも、モニタリング ユーティリティ自体の障害を中央サービスに通知することもありません。

次の図は、5 ノード クラスタの apigee-monit アーキテクチャを示しています。

コンポーネントの構成

apigee-monit は、コンポーネント構成を使用して、モニタリングするコンポーネント、確認するコンポーネントの側面、障害発生時に実行するアクションを決定します。

デフォルトでは、apigee-monit は、事前定義されたコンポーネント構成を使用して、ノード上のすべての Edge コンポーネントをモニタリングします。デフォルトの設定を確認するには、apigee-monit コンポーネントの構成ファイルをご覧ください。デフォルトのコンポーネント構成は変更できません。

apigee-monit は、チェックするコンポーネントに応じて、コンポーネントのさまざまな側面をチェックします。次の表に、apigee-monit が各コンポーネントでチェックする内容と、各コンポーネントのコンポーネント構成の場所を示します。一部のコンポーネントは単一の構成ファイルで定義されますが、他のコンポーネントは独自の構成を持ちます。

次の例は、edge-router コンポーネントのデフォルトのコンポーネント構成を示しています。

check host edge-router with address localhost
  restart program = "/opt/apigee/apigee-service/bin/apigee-service edge-router monitrestart"
  if failed host 10.1.1.0 port 8081 and protocol http
    and request "/v1/servers/self/uuid"
    with timeout 15 seconds
    for 2 times within 3 cycles
  then restart

  if failed port 15999 and protocol http
    and request "/v1/servers/self"
    and status < 600
    with timeout 15 seconds
    for 2 times within 3 cycles
  then restart

次の例は、新しい Edge UI（edge-management-ui）コンポーネントのデフォルト構成を示しています。

check process edge-management-ui
 with pidfile /opt/apigee/var/run/edge-management-ui/edge-management-ui.pid
 start program = "/opt/apigee/apigee-service/bin/apigee-service edge-management-ui start" with timeout 55 seconds
 stop program = "/opt/apigee/apigee-service/bin/apigee-service edge-management-ui stop"

Apigee Edge for Private Cloud コンポーネントのデフォルトのコンポーネント構成は変更できません。ただし、ターゲット エンドポイントや httpd サービスなど、外部サービスの独自のコンポーネント構成を追加することはできます。詳細については、Apigee 以外のコンポーネントの構成をご覧ください。

デフォルトでは、apigee-monit は実行されているノード上のすべてのコンポーネントをモニタリングします。すべてのコンポーネントまたは個々のコンポーネントに対して有効または無効にできます。詳しくは以下をご覧ください。

• コンポーネントのモニタリングを停止して開始する
• apigee-monit の停止、起動、無効化

apigee-monit をインストールする

apigee-monit はデフォルトではインストールされません。Apigee Edge for Private Cloud バージョン 4.19.01 以降をアップグレードまたはインストールした後、手動でインストールできます。

このセクションでは、apigee-monit をインストールする方法について説明します。

apigee-monit のアンインストールの詳細については、apigee-monit をアンインストールするをご覧ください。

apigee-monit をインストールする

このセクションでは、apigee-monit をインストールする方法について説明します。

apigee-monit をインストールするには:

1. 次のコマンドで apigee-monit をインストールします。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit install

2. 次のコマンドを使用して apigee-monit を構成します。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit configure

3. 次のコマンドで apigee-monit を起動します。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit start

4. クラスタ内の各ノードでこの手順を繰り返します。

モニタリング コンポーネントを停止して起動する

なんらかの理由でサービスが停止すると、apigee-monit はサービスの再起動を試みます。

これは、コンポーネントを意図的に停止する場合に問題になる可能性があります。たとえば、バックアップやアップグレードが必要な場合にコンポーネントを停止できます。バックアップまたはアップグレード中に apigee-monit がサービスを再起動すると、メンテナンス手順が中断され、失敗する可能性があります。

以降のセクションでは、コンポーネントのモニタリングを停止するオプションについて説明します。

コンポーネントを停止してモニタリングを解除する

コンポーネントを停止してモニタリングを解除するには、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit stop-component -c component_name

• apigee-cassandra（Cassandra）
• apigee-openldap（OpenLDAP）
• apigee-postgresql（PostgreSQL データベース）
• apigee-qpidd（Qpidd）
• apigee-zookeeper（ZooKeeper）
• edge-management-server（管理サーバー）
• edge-management-ui（新しい Edge UI）
• edge-message-processor（Message Processor）
• edge-postgres-server（Postgres サーバー）
• edge-qpid-server（Qpid サーバー）
• edge-router（エッジルーター）

「all」は stop-component の有効なオプションではありません。stop-component で停止してモニタリングを解除できるコンポーネントは、一度に 1 つだけです。

コンポーネントを再起動してモニタリングを再開するには、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit start-component -c component_name

「all」は start-component の有効なオプションではありません。

すべてのコンポーネントを停止してモニタリングを解除する方法については、すべてのコンポーネントを停止してモニタリングを解除するをご覧ください。

コンポーネントのモニタリングを解除する（停止しない）

コンポーネントのモニタリングを停止するには（コンポーネントは停止しません）、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c component_name

• apigee-cassandra（Cassandra）
• apigee-openldap（OpenLDAP）
• apigee-postgresql（PostgreSQL データベース）
• apigee-qpidd（Qpidd）
• apigee-zookeeper（ZooKeeper）
• edge-management-server（管理サーバー）
• edge-management-ui（新しい Edge UI）
• edge-message-processor（Message Processor）
• edge-postgres-server（Postgres サーバー）
• edge-qpid-server（Qpid サーバー）
• edge-router（エッジルーター）

コンポーネントのモニタリングを再開するには、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c component_name

すべてのコンポーネントのモニタリングを解除します（ただし、停止はしません）。

すべてのコンポーネントのモニタリングを解除するには（ただし、停止はしない）、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c all

すべてのコンポーネントのモニタリングを再開するには、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c all

すべてのコンポーネントを停止してモニタリングを解除する

すべてのコンポーネントを停止してモニタリングを解除するには、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c all
/opt/apigee/apigee-service/bin/apigee-all stop

すべてのコンポーネントを再起動してモニタリングを再開するには、次のコマンドを実行します。

/opt/apigee/apigee-service/bin/apigee-all start
/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor -c all

すべてのコンポーネントのモニタリングを停止するには、apigee-monit の停止、起動、無効化で説明されているように、apigee-monit を無効にすることもできます。

apigee-monit の停止、起動、無効化

他のサービスと同様に、apigee-service コマンドを使用して apigee-monit を停止および開始できます。また、apigee-monit は unmonitor コマンドをサポートしています。このコマンドを使用すると、モニタリング コンポーネントを一時的に停止できます。

apigee-monit を停止する

apigee-monit を停止するには、次のコマンドを使用します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit stop

apigee-monit を起動する

apigee-monit を起動するには、次のコマンドを使用します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit start

apigee-monit を無効にする

次のコマンドを使用して、ノード上のすべてのコンポーネントのモニタリングを一時停止できます。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit unmonitor -c all

または、apigee-monit をアンインストールするで説明されているように、ノードからアンインストールして apigee-monit を完全に無効にすることもできます。

apigee-monit をアンインストールする

apigee-monit をアンインストールするには:

1. apigee-monit をモニタリングする cron ジョブを設定している場合は、apigee-monit をアンインストールする前にその cron ジョブを削除します。

   sudo rm /etc/cron.d/apigee-monit.cron

2. 次のコマンドを使用して apigee-monit を停止します。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit stop

3. 次のコマンドを使用して apigee-monit をアンインストールします。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit uninstall

4. クラスタ内の各ノードでこの手順を繰り返します。

新しくインストールされたコンポーネントをモニタリングする

apigee-monit を実行しているノードに新しいコンポーネントをインストールした場合は、apigee-monit の restart コマンドを実行して、そのコンポーネントのモニタリングを開始できます。これにより、コンポーネント構成に新しいコンポーネントを含む新しい monit.conf 構成ファイルが生成されます。

次の例では、apigee-monit を再起動します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit restart

apigee-monit をカスタマイズする

apigee-monit のさまざまな設定をカスタマイズできます。たとえば、次の設定をカスタマイズできます。

1. デフォルトの apigee-monit コントロール設定
2. グローバル構成設定
3. Apigee 以外のコンポーネントの構成

デフォルトの apigee-monit 制御設定

ステータス チェックの頻度や apigee-monit ファイルの場所など、デフォルトの apigee-monit 制御設定をカスタマイズできます。これを行うには、コードと構成の手法を使用してプロパティ ファイルを編集します。プロパティ ファイルは、Apigee Edge for Private Cloud をアップグレードした後も保持されます。

次の表に、カスタマイズ可能なデフォルトの apigee-monit コントロール設定を示します。

conf_monit_httpd_allow=allow username:"password"\nallow 127.0.0.1

デフォルトの apigee-monit コントロール設定をカスタマイズするには:

1. 次のファイルを編集します。

   /opt/apigee/customer/application/monit.properties

   ファイルが存在しない場合は作成し、所有者を「apigee」ユーザーに設定します。

   chown apigee:apigee /opt/apigee/customer/application/monit.properties

   ファイルがすでに存在する場合は、上記の表に記載されているもの以外にも構成プロパティが定義されている可能性があります。上記のプロパティ以外は変更しないでください。

2. プロパティ値を新しい値に設定または置き換えます。

   たとえば、ログファイルの場所を /tmp に変更するには、次のプロパティを追加または編集します。

   conf_monit_monit_logdir=/tmp/apigee-monit.log

3. 変更を monit.properties ファイルに保存します。
4. 次のコマンドを使用して apigee-monit を再構成します。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit configure

5. 次のコマンドを使用して apigee-monit を再読み込みします。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit reload

   apigee-monit を再起動できない場合は、apigee-monit ログファイルにアクセスするの説明に従って、ログファイルでエラーを確認します。

6. クラスタ内の各ノードに対してこの手順を繰り返します。

グローバル構成設定

apigee-monit のグローバル構成設定を定義できます。たとえば、アラートのメール通知を追加できます。これを行うには、/opt/apigee/data/apigee-monit ディレクトリに構成ファイルを作成し、apigee-monit を再起動します。

apigee-monit のグローバル構成設定を定義するには:

1. 次の場所に新しいコンポーネント構成ファイルを作成します。

   /opt/apigee/data/apigee-monit/filename.conf

   filename は、「monit」を除く任意の有効なファイル名です。

2. 次の例に示すように、新しい構成ファイルの所有者を「apigee」ユーザーに変更します。

   chown apigee:apigee /opt/apigee/data/apigee-monit/my-mail-config.conf

3. 新しいファイルにグローバル構成設定を追加します。次の例では、メールサーバーを構成し、アラートの受信者を設定します。

   SET MAILSERVER smtp.gmail.com PORT 465
     USERNAME "example-admin@gmail.com" PASSWORD "PASSWORD"
     USING SSL, WITH TIMEOUT 15 SECONDS
   
   SET MAIL-FORMAT {
     from: edge-alerts@example.com
     subject: Monit Alert -- Service: $SERVICE $EVENT on $HOST
   }
   SET ALERT fred@example.com
   SET ALERT nancy@example.com

   グローバル構成オプションの完全なリストについては、monit のドキュメントをご覧ください。

4. コンポーネント構成ファイルへの変更を保存します。
5. 次のコマンドを使用して apigee-monit を再読み込みします。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit reload

   apigee-monit が再起動しない場合は、apigee-monit ログファイルにアクセスするの説明に従って、ログファイルでエラーを確認します。

6. クラスタ内の各ノードに対してこの手順を繰り返します。

Apigee 以外のコンポーネントの構成

apigee-monit に独自の構成を追加して、Apigee Edge for Private Cloud に含まれていないサービスをチェックできます。たとえば、apigee-monit を使用して、ターゲット エンドポイントにリクエストを送信することで、API が実行されていることを確認できます。

Apigee 以外のコンポーネント構成を追加するには:

1. 次の場所に新しいコンポーネント構成ファイルを作成します。

   /opt/apigee/data/apigee-monit/filename.conf

   ここで、filename は任意の有効なファイル名です（「monit」を除く）。

   コンポーネント構成ファイルは、必要に応じていくつでも作成できます。たとえば、ノードでモニタリングする Apigee 以外のコンポーネントごとに個別の構成ファイルを作成できます。

2. 次の例に示すように、新しい構成ファイルの所有者を「apigee」ユーザーに変更します。

   chown apigee:apigee /opt/apigee/data/apigee-monit/my-config.conf

3. 新しいファイルにカスタム構成を追加します。次の例では、ローカル サーバーのターゲット エンドポイントを確認します。

   CHECK HOST localhost_validate_test WITH ADDRESS localhost
     IF FAILED
       PORT 15999
       PROTOCOL http
       REQUEST "/validate__test"
       CONTENT = "Server Ready"
       FOR 2 times WITHIN 3 cycles
     THEN alert

   可能な構成設定の完全なリストについては、monit のドキュメントをご覧ください。

4. 変更を構成ファイルに保存します。
5. 次のコマンドを使用して apigee-monit を再読み込みします。

   /opt/apigee/apigee-service/bin/apigee-service apigee-monit reload

   apigee-monit が再起動しない場合は、apigee-monit ログファイルにアクセスするの説明に沿って、ログファイルでエラーを確認します。

6. クラスタ内の各ノードに対してこの手順を繰り返します。

これは Edge 以外のコンポーネントのみを対象としています。Edge コンポーネントのコンポーネント構成はカスタマイズできません。

apigee-monit ログファイルにアクセスする

apigee-monit は、イベント、再起動、構成の変更、アラートなど、すべてのアクティビティをログファイルに記録します。

ログファイルのデフォルトの場所は次のとおりです。

/opt/apigee/var/log/apigee-monit/apigee-monit.log

デフォルトの場所を変更するには、apigee-monit コントロールの設定をカスタマイズします。

ログファイルのエントリの形式は次のとおりです。

'edge-message-processor' trying to restart
[UTC Dec 14 16:20:42] info     : 'edge-message-processor' trying to restart
'edge-message-processor' restart: '/opt/apigee/apigee-service/bin/apigee-service edge-message-processor monitrestart'

apigee-monit ログファイル エントリの形式をカスタマイズすることはできません。

apigee-monit で集計ステータスを表示する

apigee-monit には、ノード上のコンポーネントに関する集計ステータス情報を提供する次のコマンドが含まれています。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit report

/opt/apigee/apigee-service/bin/apigee-service apigee-monit summary

これらの各コマンドについては、以降のセクションで詳しく説明します。

レポート

report コマンドは、ノード上の現在稼働しているコンポーネント、停止しているコンポーネント、初期化中のコンポーネント、モニタリング対象外になっているコンポーネントの数を集計して表示します。次の例では、report コマンドを呼び出します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit report

次の例は、AIO（オールインワン）構成での report 出力を示しています。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit report
up:            11 (100.0%)
down:           0 (0.0%)
initialising:   0 (0.0%)
unmonitored:    1 (8.3%)
total:         12 services

この例では、12 個のサービスのうち 11 個が apigee-monit によって稼働中と報告されています。1 つのサービスは現在モニタリングされていません。

report コマンドを最初に実行したときに、Connection refused エラーが発生することがあります。この場合は、conf_monit_monit_delay_time プロパティの期間が経過してからもう一度お試しください。

概要

summary コマンドは、各コンポーネントを一覧表示し、そのステータスを提供します。次の例では、summary コマンドを呼び出します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit summary

次の例は、AIO（オールインワン）構成での summary 出力を示しています。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit summary
Monit 5.25.1 uptime: 4h 20m
 Service Name                     Status                      Type
 host_name                        OK                          System
 apigee-zookeeper                 OK                          Process
 apigee-cassandra                 OK                          Process
 apigee-openldap                  OK                          Process
 apigee-qpidd                     OK                          Process
 apigee-postgresql                OK                          Process
 edge-management-ui               OK                          Process
 edge-qpid-server                 OK                          Remote Host
 edge-postgres-server             OK                          Remote Host
 edge-management-server           OK                          Remote Host
 edge-router                      OK                          Remote Host
 edge-message-processor           OK                          Remote Host

summary コマンドを初めて実行したときに Connection refused エラーが発生した場合は、conf_monit_monit_delay_time プロパティの期間待ってから、もう一度試してください。

apigee-monit をモニタリングする

apigee-monit が各ノードで実行されていることを定期的に確認することをおすすめします。

apigee-monit が実行されていることを確認するには、次のコマンドを使用します。

/opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor_monit

Apigee では、apigee-monit を実行している各ノードでこのコマンドを定期的に発行することをおすすめします。これを行う方法の 1 つは、事前定義された間隔でスケジュールされたタスクを実行する cron などのユーティリティを使用することです。

cron を使用して apigee-monit をモニタリングするには:

1. 次の例に示すように、apigee-monit.cron ディレクトリを /etc/cron.d ディレクトリにコピーして、cron のサポートを追加します。

   cp /opt/apigee/apigee-monit/cron/apigee-monit.cron /etc/cron.d/

2. apigee-monit.cron ファイルを開いて編集します。

   apigee-monit.cron ファイルは、実行する cron ジョブと、そのジョブを実行する頻度を定義します。次の例は、デフォルト値を示しています。

   # Cron entry to check if monit process is running. If not start it
   */2 * * * * root /opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor_monit

   このファイルでは次の構文を使用します。最初の 5 つのフィールドは、apigee-monit がアクションを実行する時間を定義します。

   min hour day_of_month month day_of_week task_to_execute

   たとえば、デフォルトの実行時間は */2 * * * * です。これは、cron に 2 分ごとに apigee-monit プロセスをチェックするように指示します。

   cron ジョブは 1 分間に 1 回を超えて実行することはできません。

   cron の使用方法について詳しくは、サーバー OS のドキュメントまたは man ページをご覧ください。

3. 組織のポリシーに合わせて cron の設定を変更します。たとえば、実行頻度を 5 分ごとに変更するには、ジョブ定義を次のように設定します。

   */5 * * * * root /opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor_monit

4. apigee-monit.cron ファイルを保存します。
5. クラスタ内の各ノードに対してこの手順を繰り返します。

cron が apigee-monit の視聴を開始しない場合は、次の点を確認します。

• cron ジョブ定義の後に空白行があります。
• ファイルで定義されている cron ジョブは 1 つだけです。（コメント行はカウントされません）。

apigee-monit を停止または一時的に無効にする場合は、この cron ジョブも無効にする必要があります。そうしないと、cron が apigee-monit を再起動します。

cron を無効にするには、次のいずれかを行います。

• /etc/cron.d/apigee-monit.cron ファイルを削除します。

  sudo rm /etc/cron.d/apigee-monit.cron

  後で cron を再度有効にして apigee-monit を視聴する場合は、再度コピーする必要があります。

  または

• /etc/cron.d/apigee-monit.cron ファイルを編集し、行の先頭に「#」を追加してジョブ定義をコメントアウトします。例:

  # 10 * * * * root /opt/apigee/apigee-service/bin/apigee-service apigee-monit monitor_monit