Opsgenie を Zenoss と統合する

概要

統合でできるようになること

Zenoss 統合プラグインは、Opsgenie の全機能を活用し、Zenoss との双方向の統合を提供します。統合では、Opsgenie の Zenoss 固有の実行可能ファイルと OEC ユーティリティを活用して、アラートを自動的に作成し、Zenoss と Opsgenie の間でアラート ステータスを同期します。

統合をセットアップする

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

インストールの必須条件

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Zenoss 統合を追加する

Opsgenie に Zenoss 統合を追加するには:

1. Go to Settings > Integrations.

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

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

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

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

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

7. [統合を設定する手順] セクションを展開して、API キーをコピーします。
   このキーは、後で Zenoss で統合を設定するときに使用します。

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

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

プラグインは golang-executable ファイル (send2opsgenie としてプラグインに含まれる) を使用して、Opsgenie でアラートを作成、承認、クローズします。send2opsgenie を動作させるには、いくつかの設定を行う必要があります。次の表は必須のパラメーターとステータスを一覧にしたものです。

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

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

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

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

「Zenoss でのトリガーの設定」で説明したように、Zenoss で作成された通知のコマンドにフラグを入力して設定します。apiKey には -apiKey フラグを使用します。

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: スクリプトから設定する

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

Zenoss でのトリガーの設定

1. ナビゲーション メニューから [イベント] > [トリガー] を選択します。

2. Create a trigger named Opsgenie.

3. ナビゲーション メニューから [イベント] > [トリガー] を選択します。

4. 左側のパネルから [通知] を選択します。

5. 通知を作成します。

6. 以前に作成した通知を選択し、[編集] を選択します。

7. [通知] タブで通知を有効にし、[Send Clear (送信を選択解除)] チェックボックスを選択します。

8. 以前に作成したトリガーをリストから選択し、[追加] を選択します。

9. [コンテンツ] タブで:
10. オプションの -eventState=close を [Clear Command (コマンドをクリア)] に追加します。send2opsgenie 実行可能ファイルは、Zenoss からイベントの詳細を取得しようとせず、Opsgenie でイベントのアラートを直接クローズします。/home/opsgenie/oec/scripts/send2opsgenie -evid=${evt/evid}

11. [Subscribers (サブスクライバー)] タブで、サブスクライバーを選択し、[送信] を選択します。

Opsgenie を設定して Zenoss をアップデートする

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

Opsgenie の OEC と Zenoss スクリプトを使用して、Zenoss でアラートをアップデートします。これによって、独自のスクリプトや機能をデプロイして提供された機能を変更し、カスタマイズしたアクションを Zenoss 上で実行できます。Zenoss でアクションを実行するために、OEC は設定ファイル (/home/opsgenie/oec/conf/config.json にあります) から設定パラメーターを取得します。

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.

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 システム用に構築されていることに注意してください。

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

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

Zenoss アラートが Opsgenie で作成されない

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

/home/opsgenie/oec/scripts/send2opsgenie -test

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

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

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

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

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

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

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

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

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

Set the send2opsgenie plugin's log level to DEBUG. Open the /home/opsgenie/oec/conf/integration.conf file and change the line send2opsgenie.logger=warning to zenoss2opsgenie.logger=debug.

Opsgenie でアラートが承認されても Zenoss アラートが承認されない

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

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

• 「Posted [Acknowledge] action to Zenoss..」のみがログに記録されており、それ以降に関連するログがない場合は、OEC に接続の問題が発生している可能性があります。ログを確認してください。

Zenoss RPM パッケージを開けない

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

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