Opsgenie を Cherwell と統合する

Opsgenie が Cherwell ユーザーに提供するもの

Opsgenie は Cherwell との強力な双方向のインテグレーションを提供します。インテグレーションを使用して Cherwell インシデントを Opsgenie の API に詳細情報とともに送信します。Opsgenie は Cherwell のアラートのディスパッチャーとして機能して、オンコールスケジュールに基づいて通知する適切な担当者を決定します。メール、テキストメッセージ (SMS)、電話、iOS、Android のプッシュ通知によって通知し、アラートが確認されるかクローズされるまでアラートをエスカレートします。

統合の機能性

When the status of incident is New or Reopened in Cherwell, an alert is created in Opsgenie automatically through the integration.
When the status of incident is In Progress in Cherwell, the alert that is created in Opsgenie is acknowledged automatically.
When the status of incident is Resolved or Closed in Cherwell, the alert that is created in Opsgenie is closed automatically.
If Send Alert Updates Back to Cherwell is enabled, incident actions are executed in Cherwell when the chosen action is executed in Opsgenie for Cherwell alerts.
If Create Cherwell Incidents for OpsGenie Alerts is enabled, incident actions are executed in Cherwell when the chosen action is executed in Opsgenie for alerts from a different source than Cherwell.

Opsgenie で Cherwell インテグレーションを追加する

この統合は、Opsgenie の Standard プランと Enterprise プラン、および Jira Service Management の Premium プランと Enterprise プランでのみ利用できます。

統合をチームダッシュボードから追加すると、そのチーム統合の所有者になります。Opsgenie では、この統合を通じて受信したアラートはそのチームのみに割り当てられます。このセクションの残りの手順に従って、統合を設定してください。

Go to Settings > Integrations. Search for Cherwell and select Add.
Specify who is notified of Cherwell alerts using the Responders field. Auto-complete suggestions are provided as you type.
API キーをコピーします。
[Save Integration (統合の保存)] を選択します。

OEC は Opsgenie から Cherwell にデータを送信するために必要です。

We currently support Cherwellversion 10.X. Earlier versions aren’t supported due to API changes in Cherwell.

Cherwell での設定

Download the integration blueprint, opsgenie.bp.
In Cherwell Service Management Administrator, open opsgenie.bp and publish the blueprint.

3. Stored Values Manager (格納される値のマネージャー) を開いて、グローバル/統合にある [OpsGenie API キー] を見つけます。コピーした API キーを値として貼り付けます。保存値の更新については、こちらをご参照ください。

すべて完了! Cherwell インシデントを Opsgenie に転送して、Opsgenie のアラート機能をフル活用してください。

Opsgenie の EU サービスリージョンでの Cherwell インテグレーションの使用

If using Opsgenie’s dedicated European Service Region, a slight modification is needed for the OpsGenie Web Service

Cherwell Service Management Administrator で [ブラウザとモバイル設定] を開きます。
[Web サービスマネージャー] をクリックします。
リストで [OpsGenie Webhook] を探して右クリックし、[編集] を選択して変更します。
URL フィールドを https://api.opsgenie.com/v1/json/cherwell から https://api.eu.opsgenie.com/v1/json/cherwell に変更します

OEC インテグレーションに Cherwell で必要な変更

Before setting up the Integration via OEC follow the steps below for a hassle-free experience.

REST API クライアント ID の取得

Cherwell Service Management Administrator で [セキュリティ] を開きます。
[REST API クライアント設定の編集] をクリックします。
プラス記号をクリックして、新しいエントリを作成します。
REST API クライアントに OpsGenie という名前を付けて、クライアント ID をコピーします。
フロッピーディスクのアイコンをクリックして保存します。

OEC 統合のユーザーを作成する
Cherwell で認証するための OEC 統合用の Cherwell ユーザーを作成します。

Cherwell Service Management Administrator で [セキュリティ] を開きます。
[ユーザーの編集] をクリックします。
プラス記号をクリックして、新しいエントリを作成します。
このユーザーの Cherwell 認証資格情報を指定します。
ユーザーの [氏名] を OpsGenie に設定します、このフィールドでは大文字と小文字が区別されます。
画像はオプションです。
フロッピーディスクのアイコンをクリックして保存します。

Creating a customer for OEC Integration
Create a Cherwell Customer for OEC integration which will be used as the requestor of the incidents created by Opsgenie.

Cherwell サービス管理 で、[新規] > [新規顧客 - 社内] の順にクリックします。
顧客の [フルネーム] を OpsGenie に設定します。このフィールドでは、大文字と小文字が区別されます。
画像はオプションです。
フロッピーディスクのアイコンをクリックして保存します。

OEC を介した統合

または、Opsgenie の OEC と Cherwell スクリプトを使用して、Cherwell でアクションを実行します。これによって、独自のスクリプトや機能をデプロイして提供された機能を変更し、カスタマイズしたアクションを Cherwell 上で実行できます。

Cherwell インテグレーションパッケージを使用するには、以下のセクションのステップを最後まで実行します。

OEC の最新バージョンをダウンロードする

To download the latest version of Cherwell package, please use readme file of oec-scripts repository.

インストール

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

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

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

次のコマンドを実行します。dpkg -i cherwell-<your_version>.deb

Windows の場合

OEC パッケージを含む opsgenie integration の zip ファイルをディレクトリ内に解凍します (C:\opsgenie は優先パスです)。

便宜上、この解凍パスを %OEC_HOME% として参照できます。展開場所の値で OEC_HOME というシステム環境変数を作成できます。これを行うには、昇格した Powershell セッションを開いて次のコマンドを入力します。

テキスト

[Environment]::SetEnvironmentVariable("OEC_HOME", <Path you extracted OEC package>, 'Machine')

OEC の実行方法について詳しくは、OEC の実行のドキュメントを参照してください。

OEC 用の Cherwell インテグレーションの設定

Cherwell インテグレーションに OEC ユーティリティを使用するには、インテグレーション設定で [OEC 経由で送信] を使用します。
Cherwell に関するその他の設定は、統合設定ページまたは OEC 設定ファイルを使用して行えます。統合ページの設定は設定ファイルより優先されます。

OEC 設定

To be able to execute actions in Cherwell, OEC gets the configuration parameters from the configuration file located at path /home/opsgenie/oec/conf/config.json (Linux) or %OEC_HOME%\conf\config.json (Windows).

設定パラメーター

apiKey — 上記で作成した Cherwell インテグレーションから API キーをコピーします。
apiUrl – Cherwell API の URL。例: http://localhost/CherwellAPI/。
username — Cherwell へのサインインに使用したユーザー名。
password — Cherwell へのサインインに使用したパスワード。
clientID —「OEC インテグレーションに Cherwell で必要な変更」の章で取得した clientId。

The package that you downloaded also includes OEC utility which is at path /usr/local/bin/OpsgenieEdgeConnector (Linux) or %OEC_HOME%\OpsgenieEdgeConnector64.exe (Windows) and the script that is needed to be run by OEC which is under /home/opsgenie/oec/scripts (Linux) or %OEC_HOME%\scripts\actionExecutor.py (Windows). After the configuration of OEC is done, you need to run it. In order to learn more about how to run OEC, you can refer to the Running OEC documentation.
After all is set, according to your action mappings incidents will be created / updated in Cherwell.

Cherwell から Opsgenieに送信されるペイロードの例

JSON

{
    "incident" : {
       "callSource" : "Walk in",
       "status" : "Reopened",
       "shortDescription" : "Printer Issue",
       "category" : "Network",
       "cause" : "Hardware Malfunction",
       "id" : "102256",
       "description" : "Having trouble with the network printer",
       "type" : "Incident",
       "priority" : "3",
       "service" : "Printing",
       "subcategory" : "Submit Incident",
       "isMajorIncident" : "FALSE",
       "isRecurringIncident" : "FALSE"
    }
}

このペイロードは Opsgenie によって次のように解析されます。