Opsgenie を Nagios XI プラグインと統合する

統合による機能

• Nagios XI でホストまたはサービスの状態がダウンになると、Opsgenie でアラートが作成されます。

• 新しいアラートを作成すると、Nagios XI の関連するヒストグラムとトレンド画像が自動的にアラートに添付されます。

• Opsgenie アラートが承認されると、Nagios XI のアラートも自動的に承認されます。その逆も同様です。

• Opsgenie アラートにメモが追加されると、Nagios XI のアラートも自動的に更新されます。その逆も同様です。

統合をセットアップする

Nagios XI 統合プラグインでは Opsgenie の全機能を利用し、Nagios XI との双方向の統合を実現します。以下の手順のステップでは、Nagios XI 統合プラグインを使用して Opsgenie と Nagios XI を統合する方法を説明します。ご使用の Linux ディストリビューションと Nagios XI の設定によっては、これらの指示に若干の変更が必要になる場合があることに注意してください。

インストールの必須条件

インストール パッケージは、以下のシステムをサポートしています。

• RedHat ベースの Linux ディストリビューション

• Debian ベースの Linux ディストリビューション

Nagios XI 用 Opsgenie プラグインをインストールする

Opsgenie Edge Connector (OEC) is a prerequisite for configuring the outgoing authentication of Nagios XI integration. You can combinedly use OEC and Nagios XI scripts to update alerts on Nagios XI. With this setup, you can deploy your own script, modify the ones provided, or run customized actions on Nagios XI. Download the latest version of the Nagios XI package from this repository.

RedHat ベースのディストリビューションに関する手順

次のコマンドを実行します。 

rpm -i opsgenie-nagiosxi-<your_version>.rpm

rpm をアップグレードする前に、設定ファイルをバックアップします。

rpm パッケージによってアップグレード中に既存の設定が上書きされることはありません。新しい既定の設定ファイルは integration.conf.rpmnew として保存されます。バージョン 201X-XX-XX から 2.X.X にアップグレードするには、-- force パラメーターを追加します。例: rpm -U --force opsgenie-nagiosxi-<your_version>.rpm

rpm アップグレードの設定ファイル処理に関する詳細をご確認ください。

Debian ベースのディストリビューションに関する手順

次のコマンドを実行します。 

dpkg -i opsgenie-nagiosxi-<your_version>.deb

Nagios XI 統合を追加する

Opsgenie で Nagios XI 統合を追加する方法は以下のとおりです。

1. [設定] > [統合] の順に移動します。

2. [統合を追加] を選択します。

3. 検索を実行して「Nagios XI」を選択します。

4. 次の画面で、統合の名前を入力します。

5. オプション: 特定のチームが統合からのアラートを受信するようにする場合は、[Assignee team (担当者チーム)] のチームを選択します。

6. [Continue] を選択します。
   この時点で、統合が保存されます。

7. [統合を設定するステップ] セクションを展開して、URL をコピーします。
   この URL は、後で Nagios XI で統合を設定するときに使用します。

8. [統合をオンにする] を選択します。
   統合のために作成したルールは、統合をオンにした場合にのみ機能します。

Nagios XI で Opsgenie プラグインを設定する

プラグインでは golang-executable ファイル (send2opsgenie としてプラグインに含まれる) を使用して、Opsgenie でアラートを作成、承認、クローズします。send2opsgenie を動作させるには、いくつかの設定を行う必要があります。次の表は必須のパラメーターとステータスを一覧にしたものです。apiKey の設定は必須です。その他の構成パラメーターは既定値に設定されていて、ほとんどの Nagios XI 実装で動作しますが、変更が必要な場合もあります。

golang 実行可能ファイルを次の 3 つの方法のいずれかで設定します。

方法 1: conf ファイルから設定する

/home/opsgenie/oec/conf/integration.conf ファイルから設定します。これによって、過去にスクリプトで行った設定がすべて上書きされます。

方法 2: Golang フラグで設定する

[設定] > [Core Config Manager] > [コマンド] の順に移動して、Nagios XI の Web インターフェイスからコマンドにフラグを入力して設定を行います。apiKey に -apiKey フラグを、nagios_server の名前に -ns フラグをそれぞれ使用します。複数の Nagios サーバーを所有していない場合は、Nagios サーバーを定義する必要はありません。フラグを使用すると、上述したその他のすべての設定方法が上書きされます。

To send additional custom arguments, add them after the flags. For example, customArgName1 customArgValue1 customArgName2 customArgValue2. Parse custom arguments by adding {{_payload.customArgName}} to wherever is needed in the input fields. To learn more about using raw parameters, see dynamic fields.

方法 3: スクリプトから設定する

send2opsgenie.go スクリプトから apiKey と nagios_server を設定します。スクリプトを再構築して、新しい実行可能ファイルを /home/opsgenie/oec/scripts ディレクトリに配置します。send2opsgenie.go の場所と go スクリプトの構築方法に関する詳細は、この記事の「send2opsgenie のソースと再コンパイル」セクションをご参照ください。

Nagios XI コマンドを定義する

1. [設定] > [Core Config Manager] > [コマンド] の順に移動して、Nagios XI の Web インターフェイスから次のコンテンツでホストとサービスの通知コマンドの作成と設定を行います。

2. ホスト コマンドを定義します:
コマンド名: notify-host-by-opsgenie
コマンド タイプ: misc コマンド
コマンド ライン:

3. サービス コマンドを定義します。
コマンド名: notify-service-by-opsgenie
コマンド タイプ: misc コマンド
コマンド ライン:

4. 変更を有効にするには [新しい設定を適用] を選択します。

Nagios XI 連絡先を定義する

1. [設定] > [Core Config Manager] > [連絡先] の順に移動します。

2. [Add New (新規追加)] を選択します。

3. [共通設定] に次のように入力します。
   連絡先名: opsgenie
   説明: Opsgenie 連絡先

4. [アクティブ] チェックボックスを選択します。

5. アラート設定を次のように入力します。

[保存] と [設定を適用] を選択します。

ホストとサービスの各連絡先リストに連絡先が追加されているか、ご確認ください。問題がない場合は、Nagios XI で作成されたすべての通知を Opsgenie のアラートで確認できます。ホストやサービスが復帰すると、Opsgenie のアラートも自動的にクローズします。

問題が発生した場合は、send2opsgenie ログと [よくある質問とトラブルシューティング] セクションをご確認ください。必要に応じてログを添えて、アトラシアンにお問い合わせください。

Nagios XI を更新するように Opsgenie を設定する

これはオプションのステップです。

統合設定ページの「Nagios XI にアラート アクションを送信」チェックボックスを選択します。OEC と Nagios XI の各スクリプトを組み合わせて使用して、Nagios XI のアラートを更新できます。このセットアップによって、Nagios XI 上での独自のスクリプトのデプロイ、提供されたスクリプトの変更、カスタマイズしたアクションの実行が可能です。

Nagios XI でアクションを実行するために、OEC は設定ファイル config.json (/home/opsgenie/oec/conf/oec-config.json にあります) から設定パラメーターを取得します。

設定パラメーター

• alert_histogram_image_url: OEC は、この URL で Nagios XI からヒストグラム画像を取得します。ローカルホストを Nagios サーバー・アドレスと置き換える必要があります。

• trends_image_url: OEC は、この URL で Nagios XI からトレンド画像を取得します。ローカルホストを Nagios サーバー・アドレスと置き換える必要があります。

• command_url: アラートの承認やコメントなどが行われた場合に、Nagios XI アラートを更新するための URL です。

• ユーザー: Nagios ヒストグラムとトレンド画像を取得するために、Nagios XI Web サーバーを認証するユーザー名です。

• パスワード: Nagios ヒストグラムとトレンド画像を取得するために、Nagios XI Web サーバーを認証するパスワードです。

The downloaded package includes the OEC utility (found in /usr/local/bin) and the script that OEC needs to run (found in /home/opsgenie/oec/scripts). Be sure to run OEC after configuring it. Learn more about running OEC documentation. If using OEC, rich alerts are populated with host or service current status information in Opsgenie for every notification created in Nagios XI.

send2opsgenie のソースと再コンパイル

The source for the executable send2opsgenie is found in /usr/bin/ and send2opsgenie.go, in /home/opsgenie/oec/scripts respectively, and is also available in this repository. To change the behavior of the executable, edit send2opsgenie.go and build it by using the following command: go build send2opsgenie.go

go のインストールについては、http://golang.org/doc/install を参照してください。プラグインの実行可能ファイルは linux/386 システム用に構築されていることに注意してください。

よくある質問とトラブルシューティング

統合が機能しない場合は、このセクションを確認して、規定のガイドラインに従ってください。

1. Nagios アラートが Opsgenie で作成されない

シェルから次のテスト コマンドを実行して、Opsgenie でアラートが作成されているかを確認します。 

• 「Trace/breakpoint trap (トレース/ブレークポイント トラップ)」エラーが発生した場合は、send2opsgenie プラグインがサーバー ディストリビューションと互換性がありません。この記事の「send2jopsgenie のソースと再コンパイル」セクションでの説明のとおり、特定のサーバー環境に従って send2opsgenie.go を再構築してください。

• アラートが Opsgenie で作成されている場合は、統合が正しく設定されています。この場合、Nagios XI が Opsgenie の連絡先にアラートを通知していないことが考えられます。Nagios XI のアラート通知ログをご確認ください。

• アラートが Opsgenie で作成されていない場合は、/var/log/oec/send2opsgenie.log にあるログをご確認ください。
  ログ ファイルで次のエラーがないか、お探しください。

  • 「RestException[Could not authenticate.] (RestException[認証できませんでした。])」がログにある場合は、Opsgenie が API キーを識別できなかったことを意味します。この記事の「Nagios XI で Opsgenie プラグインを設定する」セクションに記載されているステップに従って、API キーが正しく設定されているか、ご確認ください。

  • 問題がわからない場合は、プラグインのログ レベルをデバッグに設定して、もう一度お試しください。アトラシアンにお問い合わせのうえ、ログを共有してください。

• /var/log/oec/send2opsgenie.log ファイル、またはログがない場合は、次をご確認ください。

  1. Nagios ユーザーが /var/log/oec ディレクトリに書き込む権限を持っているかどうか確認してください。インストール パッケージによって自動で実行されます。問題が発生した場合は、次のコマンドを実行してください。
     chown -R nagios:opsgenie /var/log/oec

  2. /opt/nagios/log/zeneventd.log で Nagios サーバーのログを確認します。send2opsgenie に関するエラー ログがあるかどうか確認してください。必要に応じてログを添えて、アトラシアンにお問い合わせください。

send2opsgenie プラグインのログ レベルをデバッグに設定する

send2opsgenie プラグインのログ レベルを DEBUG に設定します。/home/opsgenie/oec/conf/integration.conf ファイルを開いて、send2opsgenie.logger=warning 行を nagios2opsgenie.logger=debug に変更します。

2. Opsgenie でアラートが承認されても Nagios アラートが承認されない

アラート ログを確認します。

• 「Posted [Acknowledge] action to Nagios XI.. (Nagios XI に [承認] アクションを送信..)」がログにない場合は、Opsgenie が「承認」アクションを Nagios XI に送信しなかったことを意味します。統合の設定をご確認ください。アラート アクションと一致していない可能性があります。

• 「Posted [Acknowledge] action to Nagios XI.. (Nagios XI に [承認] アクションを送信..)」のみがログに記録されており、それ以降に関連するログがない場合は、OEC に接続の問題が発生している可能性があります。ログをご確認ください。

3. Nagios RPM パッケージを開けません

• rpm パッケージのインストール時に、そのパッケージが旧バージョンであることが判明した場合は、代わりに rpm -i opsgenie-nagiosxi-1.0.4-rpm-x86-64.rpm --nodeps をご利用ください。

• 「インストール済みです」というエラーが表示された場合は、代わりに rpm -i opsgenie-nagiosxi-1.0.4-rpm-x86-64.rpm --force をご利用ください。

4. スクリプトのアラートに zip ファイルを添付しているときに権限エラーが発生します

スクリプトの実行中に「PermissionError: [Errno 13] Permission denied: details_*」エラーが表示される場合は、スクリプトの添付方法の「file_name」変数の先頭にスクリプトのパスを追加します。