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 (abbreviated as JEC) is a prerequisite for configuring the outgoing authentication of Zenoss integration. You can combinedly use JEC 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.

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

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

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

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

The rpm package does not overwrite the existing configuration during upgrades. It saves the new default configuration file as integration.conf.rpmnew. To upgrade from version 201X-XX-XX to 2.X.X, add the --force parameter. For example: rpm -U --force jsm-zenoss-<your_version>.rpm. Read more about config file handling for rpm upgrades.

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

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

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

Zenoss 統合を追加する

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

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

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

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

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

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

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

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 フラグを使用します。

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

Zenoss でのトリガーの設定

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

2. Create a trigger named 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 にある設定ファイルから設定パラメーターを取得します。

設定パラメーター

The downloaded package includes the JEC utility (found in /usr/local/bin) and the script that JEC needs to run (found in /home/jsm/jec/scripts). Be sure to run JEC after configuring it. Read more about running JEC.

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

The source for the executable send2jsm is found in /usr/bin/ and send2jsm.go, in /home/jsm/jec/scripts respectively. They can also be downloaded from the repository. To change the behavior of the executable, edit send2jsm.go and build it by using the following command: go build send2jsm.go. Find out how to install go. The executable in the plugin is built for linux/386 systems.

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

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

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 に設定する

Set the send2jsm plugin's log level to DEBUG. Open the /home/jsm/jec/conf/integration.conf file and change the line send2jsm.logger=warning to 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 をご利用ください。