Zenoss と統合する

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

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

統合をセットアップする

Jira Service Management Zenoss 統合プラグインを使用して Jira Service Management と Zenoss を統合するには、次の手順に従います。ご利用の Linux ディストリビューションと Zenoss の設定によっては、これらの手順に若干の変更が必要になる場合があります。

インストールの必須条件

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

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

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

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

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

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

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

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

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

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

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

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

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

Zenoss 統合を追加する

Jira Service Management で Zenoss 統合を追加するには、次の手順を完了します。

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

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

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

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

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

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

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

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

Zenoss で Jira Service Management プラグインを設定する

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

設定パラメーター

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

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

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

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

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

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

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

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

Zenoss でのトリガーの設定

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

2. Jira Service Management という名前のトリガーを作成します。

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

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

5. 新しい通知を作成します。

6. 先ほど作成した通知を選んで、[編集] を選択します。

7. 「通知」タブで通知を有効にして、「送信を選択解除」チェックボックスを選択します。

8. 先ほど作成したトリガーをリストから選び、[追加] を選択します。

9. 「コンテンツ」タブ内：
   [コマンドをクリア] にオプションの -eventState=close を追加します。send2jsm 実行可能ファイルは、Zenoss からイベントの詳細を取得しようとせず、Jira Service Management でイベントのアラートを直接クローズします。/home/jsm/jec/scripts/send2jsm -evid=${evt/evid}

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

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

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

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

設定パラメーター

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

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

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

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

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

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

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

/home/jsm/jec/scripts/send2jsm -test

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

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

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

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

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

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

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

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

send2jsm プラグインのログレベルを DEBUG に設定する

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

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

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

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

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

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

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

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