ITRS OP5 Monitor と統合する

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

Jira Service Management は OP5 との強力な双方向の統合を提供します。OP5 で新しいアラート (ホストまたはサービス) が作成されると、アラートに関する詳しい情報を含む、対応する Jira Service Management アラートが自動的に作成されます。Jira Service Management は、オンコール・ローテーション、スケジューリング機能、アラート・エスカレーションによる詳細な通知を提供します。ユーザーは Jira Service Management のアラート・アクションのいずれかを選択して、OP5 の「承認」アクションにマッピングします。

統合による機能

OP5 から Jira Service Management へ

• OP5 でホストまたはサービスのアラートが作成されると、Jira Service Management でアラートが作成されます。

• OP5 でホストまたはサービスのアラートがクローズされると、Jira Service Management で対応するアラートがクローズされます。

• OP5 でホストまたはサービスのアラートが承認されると、Jira Service Management で対応するアラートが承認されます。

Jira Service Management から OP5 へ

[Send alert updates back to OP5 (アラートの更新を OP5 に送信)] が有効になっている場合は、OP5 アラートに対して実行されたアクションが「承認」アクションとして OP5 に送信されます。

統合をセットアップする

OP5 は双方向の統合です。次のステップに沿ってセットアップを行います。

• Jira Service Management に OP5 統合を追加する

• アラート アクションをマッピングする

• OP5 で統合を設定する

OP5 用 Jira Service Management プラグインをインストールする

Jira Edge Connector (略称 JEC) は OP5 統合の送信認証を設定するための前提条件です。OP5 パッケージの最新バージョンは、このリポジトリからダウンロードしてください。

OP5 Monitor の Red Hat ベースのディストリビューションの場合

OP5 ファイルをリモートの OP5 Monitor と共有するか、開始ページのリンクをコピーします。

• 次のコマンドを実行します。
  wget https://linkTo.the.OP5Package

• 次のコマンドを実行します。
  rpm -i jsm-op5-<your_version>.rpm

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

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

rpm アップグレード設定ファイルの処理に関する詳細。

OP5 統合を追加する

1. チームのオペレーション ページに移動します。

2. 左側のナビゲーション パネルで、[統合]、[統合を追加] の順に選択します。

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

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

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

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

7. [統合を設定するステップ] セクションを展開して、統合 API キーをコピーします。
   このキーは、後ほど OP5 で統合を設定する際に使用します。

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

OP5 Monitor で OP5 パッケージを設定する

プラグインは golang 実行可能ファイル (send2jsm としてプラグインに含まれます) を使用して、Jira Service Management でアラートを作成、承認、クローズします。Jira Service Management でアラートを作成、承認、クローズするために、イベントでこのファイルを実行するように OP5 を設定します。apiKey の設定は必須です。その他の設定パラメーターは、OP5 で動作する既定値に設定されています。

次のテーブルは、パラメーターとその場所を示しています。

設定パラメーター

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

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

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

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

jsm.cfg ファイルでコマンドにフラグを入力して設定します。apiKey に -apiKey フラグを、nagios_server の名前に -ns フラグをそれぞれ使用します。OP5 サーバーを複数使用していない場合は、nagios サーバーを定義する必要はありません。フラグを使用すると、この記事の前半で説明したその他のすべての設定方法が上書きされます。
cfg ファイルから apiKey を次のように設定します。

apiKey を cfg ファイルに追加すると、config.json ファイル内の apiKey が上書きされます。

追加のカスタム引数を送信するには、フラグの後に追加します。例: customArgName1 customArgValue1 customArgName2 customArgValue2。入力フィールドの必要な場所に {{_payload.customArgName}} を追加することで、カスタム引数を解析できます。動的プロパティに関する詳細をご確認ください。

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

send2jsm.go スクリプトから apiKey と nagios_server を設定します。このオプションを使用するには、スクリプトを再構築して、新しい実行可能ファイルを /usr/bin ディレクトリに配置します。send2jsm.go の場所と go スクリプトの構築方法は、「send2jsm のソースと再コンパイル」セクションを参照してください。

Jira Service Management を連絡先として定義する

1. OP5 Monitor にログインします。

2. nagios.cfg がある /opt/monitor/etc ディレクトリに移動します。
   cd /opt/monitor/etc

3. メインの Nagios 設定ファイル (nagios.cfg) に次の行を追加します。

   1 2 3 ... cfg_file=jsm.cfg ...

4. Monitor を再起動して、連絡先「jsm」が連絡先リストにあることを確認します。

5. 連絡先「jsm」を、OP5 Monitor の主要な連絡先グループに追加します。

特に問題がない場合は、OP5 で作成されたすべての通知について Jira Service Management にアラートが表示されます。

アラート アクションをマッピングする

Jira Service Management アクションと 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 統合自体によって作成された場合)、Jira Service Management アクションを OP5 アクションにマッピングします。異なる Jira Service Management アクションは別々の OP5 アクションにマッピングします。たとえば、OP5 からのアラートが承認されたときに、OP5 でアラートを承認するとします。これを実行するには、「アラートの更新を OP5 に送信」セクションで「Jira Service Management でアラートが承認された場合、OP5 で承認する」のマッピングを定義します。 

Jira Service Management を設定して OP5 をアップデートする

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

Jira Service Management の JEC と OP5 スクリプトを使用して、OP5 でアラートをアップデートします。これによって、独自のスクリプトをデプロイしたり、提供されているスクリプトを変更して OP5 上でカスタマイズしたアクションを実行したりできます。OP5 でアクションを実行するために、JEC は設定ファイルから設定パラメーターを取得します。設定ファイルは、/home/jsm/jec/conf/jec-config.json にあります。

設定パラメーター

• url – JEC は、この URL を使用して構築されたエンドポイントにアラート・アクションを投稿します。

• ユーザー名 – JEC は、OP5 アカウントのユーザー名で認証を行います。

• パスワード – JEC は、OP5 アカウントのパスワードで認証を行います。

ダウンロードしたパッケージには、/usr/local/bin にある JEC ユーティリティと、/home/jsm/jec/scripts にある JEC によって実行する必要があるスクリプトも含まれています。JEC の設定が完了したら、JEC を実行する必要があります。JEC の実行に関する詳細をご確認ください。

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

send2jsm 実行可能ファイルのソースは /usr/bin/ にあり、send2jsm.go ファイルは /home/jsm/jec/scripts にあります。なお、こちらのリポジトリでも入手できます。実行可能ファイルの動作を変更するには、send2jsm.go を編集して、go build send2jsm.go コマンドでビルドします。go のインストール方法についてはこちらをご確認ください。プラグインの実行可能ファイルは linux/amd64 システム用にビルドされています。

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

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

1. Jira Service Management で OP5 アラートが作成されない

シェルから次のテスト・コマンドを実行します。Jira Service Management でテスト・アラートが作成されているかどうかを確認してください。

/home/jsm/jec/scripts/send2jsm -entityType=host -t=PROBLEM -hs=DOWN -hn=test_host

「Trace/breakpoint trap (トレース/ブレークポイント・トラップ)」エラーが発生した場合: send2jsm プラグインがサーバー・ディストリビューションと互換性がないことを意味します。このページの「send2jsm のソースと再コンパイル」セクションを参照して、特定のサーバー環境に従って send2jsm.go を再構築してください。

アラートが Jira Service Management で作成されている場合: 統合は正しく設定されています。OP5 が Jira Service Management の連絡先にアラートを通知していないことが問題である可能性があります。OP5 アラート通知ログを確認してください。

そうでない場合: /var/log/jec にあるログ・ファイルを確認します。ログ・ファイルから次のエラーを探してください。

• 「RestException[Could not authenticate.] (RestException[認証できませんでした。])」エラーがログに表示されている場合、Jira Service Management は API キーを識別できませんでした。このページの「OP5 Monitor で OP5 パッケージを設定する」で説明されているように、API キーが正しく設定されているかどうかを確認してください。

• 「[OP5] 統合の apiKey でこのアクションを実行できませんでした」エラーがログに表示された場合は、間違った統合パッケージをダウンロードしている可能性があります。OP5 統合パッケージをダウンロードしているか、ご確認ください。

• 問題がわからない場合は、プラグインのログ・レベルをデバッグに設定してもう一度お試しのうえ、ログを添えてアトラシアンまでお問い合わせください。/var/log/jec ファイルにログ・ファイルがない場合、またはログ・ファイルにログが記録されていない場合は、次を確認してください。

1. まず、Nagios ユーザーに /var/log/jec ディレクトリへの書き込み権限があることを確認します。これは、インストール・パッケージによって自動で実行されます。問題が発生した場合は、chown -R nagios:nagios:jsm /var/log/jec を実行します。

2. 次に、/var/log/jec にある OP5 サーバー・ログを確認します。send2jsm に関するエラー・ログがあるかを確認して、それらを添えてお問い合わせください。

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

/home/jsm/jec/conf/integration.conf ファイルの send2jsm.logger=warning の行を nagios2jsm.logger=debug に変更します。

Jira Service Management を設定して Zenoss をアップデートする

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

2. Jira Service Management でアラートを承認しても、OP5 アラートが承認されない

1. まず、アラート ログを確認します。

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

• 「Executed [Acknowledge] action via OEC with errors. (JEC 経由で [承認] アクションを実行しましたが、エラーが発生しました)」エラーがログに表示された場合、JEC の op5ActionExecutor.groovy スクリプトでエラーが発生したことを意味します。/var/log/jsm/ の下のログ・ファイルをチェックして、エラー・ログを確認してください。

• 「Posted [Acknowledge] action to OP5.. (OP5 に [承認] アクションを送信..)」エラーのみがログに表示されており、それ以降関連ログがない場合、JEC の接続に問題が発生している可能性があります。/var/log/jsm/ の下のログ・ファイルをチェックして、エラー・ログを確認してください。

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

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

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

問題が不明な場合は、JEC スクリプトのログ・レベルを「デバッグ」に設定して、もう一度お試しください。/var/log/jsm/ にあるログ・ファイルを添えて、お問い合わせください。