いつもOpsAidをご利用いただき、ありがとうございます。
OpsAidの利用ガイドのご紹介です。
アラートを受け取ったとき、他のシステムと連携して対応することはよくありますよね。
そんな時はOpsAidの他システムのAPIを実行する！を利用しましょう。
そこで今回は、他システムのAPIを実行する登録方法をご紹介します。
受信するアラートと対応条件は次の内容を想定し登録していきます。
▼監視対象サーイブ
アラートが発生したら、件名に ERROR を含むメールをOpsAidへ送信する
▼OpsAidの動き
アラートを受信したら、他システムのAPI（https://service01/api/action）を実行する
POST形式で、下記パラメータを付与する
key1:VALUE1
key2:VALUE2
プロジェクトに担当者を登録する
まずは、OpsAidの利用の流れ またはスタートガイド「プロジェクトを用意しよう」 に従ってアラートを受信するプロジェクトを登録します。
ルールを登録
アラートを受信するプロジェクトにどんなアラートが来たら、どんな対応をするか登録を行います。今回はルールを1件登録します。
■マッチ条件
＜キーワード条件＞
どんなアラートを受信したら対応するか指定する部分です。
キーワード条件にて「件名」に「ERROR」が含まれた場合で設定します。
■アクション設定
マッチ条件にマッチしたアラートを受信した場合どんなアクションを行うか設定する部分です。今回は他システムのAPIの実行をするので、「Webhook」で設定していきます。
URL：https://service01/api/action
METHOD:POST
送信データ：JSON形式で記述
この設定により、ルールが適用されると指定したメソッドと送信データでURLへリクエストを送信します。200 OKのレスポンスが返却された場合、結果[OK]でアクションを終了します。200 OK以外のレスポンスが返却された場合、結果[NG]でアクションを終了します。
■インシデント設定
ここはルール条件にマッチした場合に作成するインシデントの設定をする部分です。
ステータス：完了
担当者：ユーザー01
これでのルール設定は完了です。
アラート受信時の動き
上記ルールを登録すると、監視対象サービスからアラートが発生すると下記の流れで自動対応が行われます。
監視対象サービスから、プロジェクトのメールアドレスへ向けて、件名にERRORを含むアラートを送信する
OpsAidでプロジェクトがアラートを受信する
プロジェクトに登録されたルールに、アラートがマッチするかチェックする。アラートの件名にERRORが含まれているので、作成したルールの実行条件にマッチする
ルールの実行条件にマッチしたので、自動でルールのアクションが実行される
・HTTPSで設定されたAPIに接続し、データが送信される
・API呼出しに対する結果は、呼び出したAPIによって異なります
5. ルールの実行条件にマッチしたので、自動でインシデントが起票される
6．アクション結果を受けて、ルールの実行結果が起票したインシデントに記録される
7．問題無く終了したら、インシデントのステータスが完了となる
このように、他システムのAPIを実行することが可能のです！
是非ご利用ください！
OpsAid利用マニュアルも合わせてご確認ください。