DOCS
インテグレーションガイド / Pandora FMS

インテグレーションの要件

Pandora FMS 5.0以上をインストールする必要があります。 要件の詳細リストは、http://wiki.pandorafms.com のオンラインドキュメントを参照してください。また、 Perlは次の依存関係とともにインストールする必要があります。

• LWP :: UserAgent（APIへのPostコールを実行するために必要）
• JSON（コール中にデータ構造を構築するために必要）
• File :: Basename（スクリプトパスを見つけて一時ファイルを保存するために必要）
• IO :: Socket :: SSL（HTTPSを使用してAPIコールを実行するために必要）

このインテグレーションはPagerDutyのAPIをコールすることで実行されるため、インターネット接続も必要です。Pandora FMS 5.0 SP3以降では、インテグレーションスクリプトとPagerDuty incidentというアラートコマンドが使用できます。以下の手順が完了したら、このガイドの「In Pandora FMS」の手順1と2をスキップしてください。

• インテグレーションスクリプトのパスは、下記の通りです。[SERVER_INSTALLATION_PATH] /pandora_server/util/pagerduty/pandorafmsalert2pagerduty.pl
• システムのAlertコマンドリストは、Pandora FMSコンソールのAdministration > Manage alerts > Commandsセクションで利用できます。

PagerDutyでの設定

1. ConfigurationメニューからServicesを選択します。

2. Serviceページで： インテグレーションのために新しいサービスを作成する場合は、 +Add New Service をクリックします。 既存のサービスにインテグレーションを追加する場合は、統合を追加するサービスの名前をクリックします。 その後、Integrations タブをクリックし、 + New Integration ボタンをクリックします。

3. Integration Typeメニューから追加したいアプリケーションを選択し、Integration Nameを入力します。新たにサービスを作成する場合は、General Settingsで、サービスのNameを入力します。次に、Incident Settingsで、新しいサービスのEscalation Policy （エスカレーションポリシー）、Notification Urgency（通知の緊急度）、Incident Behavior<（インシデントの動作）を指定します。

4. Add ServiceまたはAdd Integrationボタンをクリックして、インテグレーションを保存します。するとサービスのIntegrationsページにリダイレクトされます。

5. 新しいインテグレーションのIntegration Keyをコピーします。

Pandora FMSでの設定

1. Pandora FMSモジュールライブラリからpandorafmsalert2pagerduty.plというスクリプトをダウンロードします。

2. サーバーが利用できるパスにスクリプトを配置します。 推奨されるパスは次の通りです。 [SERVER_INSTALLATION_PATH]/pandora_server/util/pagerduty/

3. スクリプトの一般的な実行のための「Alert Command」を作成します。 これは2つの方法、つまり事前に定義されたSQLスクリプトを使用するか、Pandora FMSインターフェイスを使用して手動で行うか、どちらかの方法で実行できます。

   1. Pandora FMS（バージョン5以上）データベースでSQLスクリプトPagerDutyPandoraFMSCommand.sqlを自動的に実行します。 このスクリプトは Pandora FMSモジュールライブラリで見つけることができます。
   2. Administration > Manage alerts > Commandsの順に手動で進み、アラートが発生した時に実行するスクリプトへのコールを伴うアラートコマンドを作成します。 このコマンドは、絶対パスを使用するインテグレーションスクリプトへのコールです。 /usr/share/pandora_server/util/pagerduty/pandorafmsalert2pagerduty.pl "_field8_" "_id_alert_" "_field9_" "_field10_" "_timestamp_" "_alert_text_severity_" "_agent_" "_module_" "_data_" カスタムフィールドは次のようになります。
      • field8：PagerDutyサービスから取得したService APIキー
      • field9：インシデントのタイプ。 取りうる値は次の通り：
        • trigger：インシデントを作成または更新するための標準コール。
        • resolve：インシデントを閉じる。 field10：インシデントの説明。 注：下のほうのフィールドを使う一般的なテンプレートおよびアクションとの互換性を保つために、上にあるフィールドが優先されます。

4. PagerDutyサービスごとにAlert Action（アラートアクション）を作成します。Pandora FMSのアラートにはいくつかのアクションを設定できます。アクションは一般的なコマンドを使うことができ、必要なパラメーターを追加できます。 このインテグレーションでは、PagerDutyサービスごとにアクションを作成します。 これを行うには、** Administration** > Manage alerts> Actionsのメニューに移動し、新しいアラートアクションを作成します。 アラート設定では、名前を入力し、先に作成したPagerDutyコマンドを選択します。 3つの設定フィールドが表示されます：

   • Service API key： PagerDutyサービスから得られるキーです。
   • Type：新しいインシデントを作成するには’Trigger’を使用し、終了するには’Resolve’を使用します。 Resolveは通常、リカバリーアラートパラメータで使用されます。
   • Description： PagerDutyインシデントに送信される説明。 一般的な例では、“Alert has been fired in Pandora FMS”（「アラートがPandora FMSで発生しました」）です。 設定フィールドを変更すると、インテグレーションスクリプトの実行例を示すようにコマンドプレビューが更新されます。

5. アラートが回復したときにPagerDutyインシデントを閉じるようにアラートテンプレートを設定します。この手順は、Pandora FMSの回復済みアラートがPagerDutyで関連するインシデントを閉じるようにしたい場合などにのみ必要です。 Administration >Manage alerts >Templatesを選択して、目的のテンプレートを編集します。Pandora FMSがデフォルトで設定しているテンプレートの1つ、“Critical condition”を設定します。 ただし、この設定はどんなアラートテンプレートとも互換性があります。 テンプレートエディタで、 Step 3 > Recoveryに進みます。 PagerDutyとの総合に使用されるコマンドで設定されたフィールドは、8,9と10です。

   • Field 8: PagerDuty service API key。 このキーはアクションで設定されているため、空欄のままです。
   • Field 9: Type of the incident。先ほどPandora FMSアラートが発せられたときに、PagerDutyインシデントを作成するアクションでTriggerを選択しました。復旧時には、PagerDutyの事態を解決するために値を ” resolve “に上書きします。
   • Field 10: Description of the incident インシデントが終了したときに、そのインシデントに異なる説明を登録するように説明を変更します。別のオプションは、フィールドを空いたままにして、アクションフィールドを使用することです。 この場合、フィールドは回復時に接頭辞[RECOVER]を受け取ります。 アラートが回復する（例：ping応答に再び答えるようになる）と、PagerDutyへのインシデントは閉じられます（解決済みになります）。

6. おめでとう！ Pandora FMSシステムがPagerDutyと統合されました。

Pandora FMSがPagerDutyと通信していることを確認する

• Create agent ボタンをクリックして、Administration> Manage monitoring> Manage agentsの中でサンプルエージェントを作成します。
• エージェントの内部で、簡単なネットワークモニタを作成します。Create a new network server moduleボタンをクリックします。
• このモニターは、5分ごとに定義されたIPにpingを実行する ‘Host Alive’モニターになります。モジュールの設定が完了したら、Createボタンをクリックします。
• このモジュールに関連づけて、テンプレート ‘Critical condition’を使用してアクション ‘New PageDuty incident’でアラートを作成します。 終了したら、 Add Alertボタンをクリックします。
• Criticalになる前にアラートが存在するかどうかを目視で確認します。
• このモニタがクリティカルな状態（ping失敗）になると、アラートが発せられます。 色が緑色から赤色に変わったことを確認します。

アラートが発生した後に、API経由でPagerDutyでインシデントが作成されたことを確認します。モジュールが critical state (recovered)になると、PagerDuty内のインシデントを自動的に解決にします。