Opsgenie を ITRS OP5 Monitor と統合する
概要
統合でできるようになること
Opsgenie は OP5 との強力な双方向の統合を提供します。OP5 で新しいアラート (ホストまたはサービス) が作成されると、アラートに関する詳しい情報を含む、対応する Opsgenie アラートが自動的に作成されます。Opsgenie は、オンコール ローテーション、スケジューリング機能、アラート エスカレーションを含む詳細な通知を提供します。ユーザーは Opsgenie のアラート アクションのいずれかを選択して、OP5 の「承認」アクションにマッピングします。
統合による機能
OP5 から Opsgenie
OP5 でホストまたはサービス アラートが作成されると、Opsgenie でアラートが作成されます。
OP5 でホストまたはサービス アラートがクローズされると、Opsgenie で対応するアラートがクローズされます。
OP5 でホストまたはサービス アラートが承認されると、Opsgenie で対応するアラートが承認されます。
Opsgenie から OP5
[Send alert updates back to OP5 (アラートの更新を OP5 に送信)] が有効になっている場合は、OP5 アラートに対して実行されたアクションが「承認」アクションとして OP5 に送信されます。
統合をセットアップする
OP5 は双方向の統合です。次のステップに沿ってセットアップを行います。
Opsgenie で OP5 統合を追加する
アラート アクションをマッピングする
OP5 で統合を設定する
OP5 用の Opsgenie プラグインをインストールする
Opsgenie Edge Connector (OEC) は OP5 統合の送信認証を設定するために必要です。OP5 パッケージの最新バージョンは、このリポジトリからダウンロードしてください。
OP5 Monitor の Red Hat ベースのディストリビューションの場合
OP5 ファイルをリモートの OP5 Monitor と共有するか、開始ページのリンクをコピーします。
次のコマンドを実行します。
wget https://linkTo.the.OP5Package次のコマンドを実行します。
rpm -i opsgenie-op5-<your_version>.rpm
rpm をアップグレードする前に、設定ファイルをバックアップします。
アップグレード中に、rpm パッケージは既存の設定を上書きしません。新しい既定の設定ファイルは integration.conf.rpmnew として保存されます。バージョン 201X-XX-XX から 2.X.X にアップデートするには、--force パラメーターを追加します。例: rpm -U --force opsgenie-integration-<your_version>.rpm
OP5 統合を追加する
Opsgenie の Free プランまたは Essentials プランを使用している、または Jira Service Management の Standard プランで Opsgenie を使用している場合は、チーム ダッシュボードからのみこの統合を追加できます。 このプランでは、[設定] の [統合] ページが利用できません。
[チーム] に移動して自分のチームを選択します。
左側のナビゲーションで [統合] を選択し、[統合を追加] を選択します。
統合をチーム ダッシュボードから追加すると、そのチーム統合の所有者になります。Opsgenie では、この統合を通じて受信したアラートはそのチームのみに割り当てられます。このセクションの残りの手順に従って、統合を設定してください。
[設定] > [統合] の順に移動します。
[統合を追加] を選択します。
検索を実行して「OP5」を選択します。
次の画面で、統合の名前を入力します。
オプション: 特定のチームが統合からのアラートを受信するようにする場合は、[Assignee team (担当者チーム)] のチームを選択します。
[Continue] を選択します。
この時点で、統合が保存されます。[統合を設定するステップ] セクションを展開して、統合 API キーをコピーします。
このキーは、後ほど OP5 で統合を設定する際に使用します。[統合をオンにする] を選択します。
統合のために作成したルールは、統合をオンにした場合にのみ機能します。
OP5 Monitor で OP5 パッケージを設定する
プラグインは golang 実行可能ファイル (send2opsgenie としてプラグインに含まれます) を使用して、Opsgenie でアラートを作成、承認、クローズします。イベント時にこのファイルを実行するように OP5 を設定して、Opsgenie でアラートを作成、承認、クローズします。apiKey の設定は必須です。その他の設定パラメーターは、OP5 で動作する既定値に設定されています。
次のテーブルは、パラメーターとその場所を示しています。
設定パラメーター |
| 場所 |
|---|---|---|
API キー | 上記で作成した OP5 統合から API キーをコピーします。send2opsgenie はこのキーを使用して Opsgenie への認証を行います。API キーは、アラートの処理に使用する必要がある適切な統合構成を識別するためにも用いられます。 | /home/opsgenie/oec/conf/config.json |
ベース URL | Opsgenie を別のドメイン (例:EU、サンドボックス) から使用している場合は、[詳細設定] ページでこの configuration.Opsgenie OP5 統合をアップデートする必要があります。 | /home/opsgenie/oec/conf/config.json |
responders | responders フィールドは、OP5 アラートを通知する必要があるチームを指定するために使用されます。このフィールドは、既定のチーム フィールド値を設定するために使用されます。Opsgenie OP5 インテグレーションの [詳細設定] ページで、異なるアラートを異なるチームにルーティングするように変更します。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
tags | [Tags] フィールドは、Opsgenie で作成されたアラートのタグを指定するために使用されます。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
logPath | ログ ファイルの完全なパスを指定します (既定値は /var/log/opsgenie/send2opsgenie.log)。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
nagios2opsgenie.http.proxy.enabled | nagios2opsgenie.http.proxy.enabled フィールドは、外部プロキシの設定を有効または無効にします。既定は false です。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
nagios2opsgenie.http.proxy.host | これは、プロキシのホストです。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
nagios2opsgenie.http.proxy.port | プロキシのポートです。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
nagios2opsgenie.http.proxy.scheme | これは、プロキシ接続プロトコルです。プロキシ サーバーに応じて http または https になる場合があります。既定値は http です。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
nagios2opsgenie.http.proxy.username | プロキシ認証ユーザー名です。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
nagios2opsgenie.http.proxy.password | これは、プロキシ認証パスワードです。 | /home/opsgenie/oec/conf/opsgenie-integration.conf |
golang 実行可能ファイルを次の 3 つの方法のいずれかで設定します。
方法 1: conf ファイルから設定する
/home/opsgenie/oec/conf/integration.conf ファイルから設定します。これによって、過去にスクリプトで行った設定がすべて上書きされます。
方法 2: Golang フラグで設定する
opsgenie.cfg ファイルでコマンドにフラグを入力して設定します。apiKey に -apiKey フラグを、nagios_server の名前に -ns フラグをそれぞれ使用します。OP5 サーバーを複数使用していない場合は、nagios サーバーを定義する必要はありません。フラグを使用すると、この記事の前半で説明したその他のすべての設定方法が上書きされます。
cfg ファイルから apiKey を次のように設定します。
define command {
command_name notify-service-by-opsgenie
command_line /home/opsgenie/oec/scripts/send2opsgenie -apiKey="apiKey1" -entityType=service ...
}apiKey を cfg ファイルに追加すると、config.json ファイル内の apiKey が上書きされます。
追加のカスタム引数を送信するには、フラグの後に追加します。たとえば、customArgName1 customArgValue1 customArgName2 customArgValue2 などとします。入力フィールドの必要な場所に {{_payload.customArgName}} を追加して、カスタム引数を解析します。生のパラメーターの使用方法について詳しくは、動的フィールドをご確認ください。
方法 3: スクリプトから設定する
send2opsgenie.go スクリプトから apiKey と nagios_server を設定します。このオプションを使用するには、スクリプトを再構築して、新しい実行可能ファイルを /usr/bin ディレクトリに配置します。send2opsgenie.go の場所と go スクリプトの構築方法は、「send2opsgenie のソースと再コンパイル」セクションをご参照ください。
Opsgenie を連絡先として定義する
OP5 Monitor にログインします。
nagios.cfg がある /opt/monitor/etc ディレクトリに移動します。
cd /opt/monitor/etc)メインの Nagios 設定ファイル (nagios.cfg) に次の行を追加します。
... cfg_file=opsgenie.cfg ...Monitor を再起動して、「opsgenie」連絡先が連絡先リストにあることを確認します。
連絡先「opsgenie」を、OP5 Monitor の主要な連絡先グループに追加します。
問題がない場合は、OP5 で作成されたすべての通知について Opsgenie でアラートが作成されます。
アラート アクションをマッピングする
Opsgenie アクションと OP5 アクション間 (アラートのソースが OP5 の場合も同様) のマッピングを定義できます。これには、OP5 アカウントの追加認証が必要です。
ユーザー名: OP5 アカウントのユーザー名。
パスワード: OP5 アカウントのパスワード。
OP5 Monitor URL: OP5 Monitor のドメイン名。例: https://19.167.1.143
OP5 によって作成されたアラートの場合
[Send alert updates back to OP5 (アラートの更新を OP5 に送信)] セクションで、アラートのソースが OP5 である場合 (アラートが OP5 統合自体によって作成された場合)、Opsgenie アクションを OP5 アクションにマッピングします。異なる Opsgenie アクションを別々の OP5 アクションにマッピングします。たとえば、OP5 からのアラートが承認されたときに、OP5 でアラートを承認するとします。これを実行するには、[アラートの更新を OP5 に送信] セクションで「Opsgenie でアラートが承認された場合、OP5 で承認する」のマッピングを定義します。
Opsgenie を設定して OP5 をアップデートする
このステップはオプションです。
Opsgenie の OEC と OP5 スクリプトを使用して、OP5 でアラートを更新します。これによって、独自のスクリプトや機能をデプロイして提供された機能を変更し、カスタマイズしたアクションを OP5 上で実行できます。OP5 でアクションを実行するために、OEC は設定ファイルから設定パラメーターを取得します。設定ファイルは、/home/opsgenie/oec/conf/oec-config.json にあります。
設定パラメーター
url – OEC は、この URL を使用して構築されたエンドポイントにアラート アクションを投稿します。
ユーザー名 – OEC は、OP5 アカウントのユーザー名で認証を行います。
パスワード – OEC は、OP5 アカウントのパスワードで認証を行います。
ダウンロードしたパッケージには、/usr/local/bin にある OEC ユーティリティと、/home/opsgenie/oec/scripts にある OEC によって実行する必要があるスクリプトも含まれています。OEC の設定が完了したら、OEC を実行する必要があります。OEC の実行に関する詳細をご確認ください。
send2opsgenie のソースと再コンパイル
send2opsgenie 実行可能ファイルのソースは /usr/bin/ にあります。send2opsgenie.go 実行可能ファイルのソースは /home/opsgenie/oec/scripts にあります。なお、こちらのリポジトリでも入手できます。実行可能ファイルの動作を変更するには、send2opsgenie.go を編集して、go build send2opsgenie.go コマンドでビルドします。
go のインストールについては、http://golang.org/doc/install を参照してください。プラグインの実行可能ファイルは linux/amd64 システム用に構築されていることに注意してください。
よくある質問とトラブルシューティング
統合が機能しない場合は、このセクションを確認して、規定のガイドラインに従ってください。
1. OP5 アラートが Opsgenie で作成されません
シェルから次のテスト コマンドを実行します。Opsgenie でアラートが作成されているかどうかを確認します。
/home/opsgenie/oec/scripts/send2opsgenie -entityType=host -t=PROBLEM -hs=DOWN -hn=test_host
「Trace/breakpoint trap (トレース/ブレークポイント トラップ)」エラーが発生した場合: send2opsgenie プラグインがサーバー ディストリビューションと互換性がないことを意味します。このページの「send2opsgenie のソースと再コンパイル」セクションを参照して、特定のサーバー環境に従って send2opsgenie.go を再構築します。
アラートが Opsgenie で作成されている場合: 統合は正しく設定されています。OP5 が Opsgenie のアラートの連絡先に通知していないことが問題である可能性があります。OP5 アラート通知ログを確認してください。
そうでない場合: /var/log/oec にあるログ ファイルをご確認ください。ログ ファイルから次のエラーを探します。
「RestException[Could not authenticate.] (RestException[認証できませんでした。])」エラーがログに表示された場合は、Opsgenie が API キーを識別できなかったことを意味します。このページの「OP5 Monitor で OP5 パッケージを設定する」で説明されているように、API キーが正しく設定されているか、ご確認ください。
「[OP5] 統合の apiKey でこのアクションを実行できませんでした」エラーがログに表示された場合は、間違った統合パッケージをダウンロードしている可能性があります。OP5 統合パッケージをダウンロードしているか、ご確認ください。
問題がわからない場合は、プラグインのログ・レベルをデバッグに設定してもう一度お試しのうえ、ログを添えてアトラシアンまでお問い合わせください。/var/log/oec ファイルにログ ファイルがない場合、またはログ ファイルにログが記録されていない場合は、次をご確認ください。
まず、Nagios ユーザーが /var/log/oec ディレクトリへの書き込み権限を持っていることを確認します。これは、インストール パッケージによって自動で実行されます。問題が発生した場合は、
chown -R nagios:nagios:opsgenie /var/log/oecを実行します。次に、/var/log/oec にある OP5 サーバー ログを確認します。send2opsgenie に関するエラー ログがあるかを確認して、それらを添えてお問い合わせください。
send2opsgenie プラグインのログ レベルを DEBUG に設定する
/home/opsgenie/oec/conf/integration.conf ファイルで、send2opsgenie.logger=warning の行を nagios2opsgenie.logger = debug に変更します。
Opsgenie を設定して Zenoss をアップデートする
send2opsgenie プラグインのログ レベルを DEBUG に設定します。/home/opsgenie/oec/conf/integration.conf ファイルを開いて、zenoss2opsgenie.logger=warning 行を zenoss2opsgenie.logger=debug に変更します。
2. Opsgenie でアラートが承認されても OP5 アラートが承認されません
まず、アラート ログを確認します。
「Posted [Acknowledge] action to OP5.. (OP5 に [承認] アクションを送信)」エラーがログに表示されない場合は、Opsgenie が「承認」アクションを OP5 に送信しなかったことを意味します。統合設定を確認してください。アラート アクションと一致していない可能性があります。
"Executed [Acknowledge] action via OEC with errors."エラーがログに表示された場合、JEC の op5ActionExecutor.groovy スクリプトでエラーが発生したことを意味します。/var/log/opsgenie/ の下のログ ファイルをチェックして、エラー ログを確認します。
"Posted [Acknowledge] action to OP5.." エラーのみがログに表示されており、それ以降関連ログがない場合、OEC の接続に問題が発生している可能性があります。/var/log/opsgenie/ の下のログ ファイルをチェックして、エラー ログを確認します。
ログが存在しない場合は、OEC を再起動し、承認アクションをもう一度送信してみてください。
3. OP5 RPM パッケージを開けません
rpm パッケージのインストール時に、そのパッケージが旧バージョンであることが判明した場合は、代わりに
rpm -i opsgenie-op5-1.0.4-rpm-x86-64.rpm --nodepsをご利用ください。「インストール済みです」というエラーが表示された場合は、代わりに
rpm -i opsgenie-op5-1.0.4-rpm-x86-64.rpm --forceをご利用ください。
問題がわからない場合は、OEC のスクリプトのログ レベルを「デバッグ」に設定して、もう一度お試しください。/var/log/opsgenie/ にあるログ ファイルを添えて、お問い合わせください。
この内容はお役に立ちましたか?