Nagios と統合する

Jira Service Management は Nagios 用の双方向の機能豊富な統合プラグインを提供しています。Jira Service Management では、使いやすい統合方法（メール、API、コマンド・ライン・ツール、プログラミング・ライブラリなど）が多数提供されており、すべての監視ツールを Jira Service Management と簡単に統合できます。Nagios は、メール・インターフェイスを介して、または Jira Service Management Web API を使用する任意の言語のスクリプトを実行することで、Jira Service Management と統合できます。このドキュメントでは、サポートされている 2 つの統合オプションについて説明します。

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

Jira Service Management 用の Nagios プラグインは、Nagios との双方向の統合をサポートしています。この統合では、Jira Service Management の Nagios 専用の実行可能ファイルと JEC ユーティリティを活用し、豊富なアラート（ステータス、アラート・ヒストグラム、トレンドなど）を自動で作成します。そして Nagios と Jira Service Management の間でアラートのステータスを同期します。Nagios プラグインは、使用することで Jira Service Management が提供する詳細な機能を Nagios で利用できるようになるため、統合方法として推奨されます。

統合による機能

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

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

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

• Jira Service Management のアラートにメモが追加されると、Nagios のアラートも自動的にアップデートされます。その逆も同様です。

統合をセットアップする

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

インストールの必須条件

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

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

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

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

Jira Edge Connector（JEC）は Nagios 統合の送信認証を設定するための前提条件です。JEC と Nagios のスクリプトを組み合わせて使用して、Nagios のアラートをアップデートできます。このセットアップによって、Nagios 上での独自のスクリプトのデプロイ、提供されたスクリプトの変更、カスタマイズしたアクションの実行が可能です。Nagios パッケージの最新バージョンをダウンロードしてください。

Red Hat ベースのディストリビューション

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

rpm -i jsm-nagios-<your_version>.rpm

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

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

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

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

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

dpkg -i jsm-nagios-<your_version>.deb

Nagios 統合を追加する

Jira Service Management で Nagios 統合を追加するには、次の手順を実行します。

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

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

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

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

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

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

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

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

Nagios 用の Jira Service Management プラグインを設定する

プラグインは golang 実行可能ファイル（send2jsm としてプラグインに含まれます）を使用して、Jira Service Management でアラートを作成、承認、クローズします。send2jsm を動作させるには、いくつかの設定を行う必要があります。次の表は、パラメーターと、それらが必須かどうかの状態を示しています。apiKey の設定は必須です。その他の設定パラメーターは、ほとんどの Nagios 実装で動作する既定値に設定されていますが、変更が必要となる場合もあります。

設定パラメーター

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

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

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

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

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

jsm.cfg ファイルから apiKey を次のように設定します（JSON 形式）。

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

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

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

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

Nagios 連絡先を定義する

1. /home/jsm/jec/jsm-nagios/jsm.cfg ファイル（連絡先、そのホスト、サービス通知コマンドの設定）を /usr/local/nagios/etc/objects ディレクトリにコピーします。

シェル

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

シェル

3. NAGIOS_HOME/etc/objects/contacts.cfg ファイル内の Nagios 設定のメイン連絡先グループに連絡先「jsm」を追加します。既定の設定である contacts.cfg を使用する場合は、「jsm」ユーザーを「admins」連絡先グループに追加します。

4. Nagios を再起動します。

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

省略可：Nagios をアップデートするように Jira Service Management を設定する

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

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

設定パラメーター

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

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

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

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

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

ダウンロードしたパッケージには、JEC ユーティリティ（/usr/local/bin にあります）と、JEC が実行する必要のあるスクリプト（/home/jsm/jec/scripts にあります）が含まれています。JEC の設定後、JEC を必ず実行してください。JEC の実行方法についてはこちらをご確認ください。JEC を使用している場合、Nagios で作成された通知ごとに、Jira Service Management のホストまたはサービスの現在のステータス情報がリッチ・アラートに入力されます。

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

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

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

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

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

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

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

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

• Jira Service Management でアラートが作成されていない場合は、/var/log/jec/send2jsm.log のログをご確認ください。
  ログファイルから次のエラーを探します。

  • 「RestException[Could not authenticate.]（RestException[認証できませんでした。]）」がログに表示されている場合、Jira Service Management は API キーを識別できませんでした。この記事の「Nagios で Jira Service Management プラグインを設定する」セクションに記載されているステップに従って、API キーが正しく設定されているか確認してください。

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

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

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

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

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

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

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

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

• 「Posted [Acknowledge] action to Nagios..（Nagios に [承認] アクションを送信..）」がログにない場合、Jira Service Management は「承認」アクションを Nagios に送信していません。統合設定を確認してください。アラート・アクションと一致していない可能性があります。

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

3. Nagios RPM パッケージを開けない

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

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

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

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