いつもOpsAidをご利用いただき、ありがとうございます。
OpsAidの利用ガイドのご紹介です。
監視対象サービスからアラートが発生した日が休日だった、なんてことありますよね。
休日の場合は次の出勤時に確認で良いはずが、アラートが届いてしまうと、気になってしまい、しっかり体を休めることが難しくなることもあると思います。
そんな時はOpsAidの自動起票を利用しましょう！
そこで今回は、休日に受け取ったアラートは自動でbacklogに起票するルールの登録をご紹介します。
受信するアラートと対応条件は次の内容を想定し登録していきます。
アラートが発生したら、件名に ERROR を含むメールをOpsAidへ送信する
土曜と日曜に、件名にERRORを含むアラートを受信したら、backlogへ課題を起票する
プロジェクト作成
まずは、OpsAidの利用の流れ またはスタートガイド「プロジェクトを用意しよう」 に従ってアラートを受信するプロジェクトを登録します。
ルールを登録
アラートを受信するプロジェクトにどんなアラートが来たら、どんな対応をするか登録を行います。今回の対応条件は
アラートが発生したら、件名に ERROR を含むメールをOpsAidへ送信する
土曜と日曜にアラートを受信したら、backlogに課題を起票する
この流れに応じてルールを登録します。
①マッチ条件
■キーワード条件
どんなアラートを受信したら対応するか指定する部分です。
キーワード条件にて「件名」に「ERROR」が含まれた場合で設定します。
■時間条件
ここでは、時間の条件を登録できます。
今回は「週末（土曜日と日曜日）」の「0:00」から「24:00」までと登録します。
上記2つの設定により、土曜日と日曜日の終日、件名にERRORを含むアラートを受信したら、ルールを適用します。
※終日の場合は「0:00まで」と設定しても同様に機能します。
②アクション設定
マッチ条件にマッチしたアラートを受信した場合どんなアクションを行うか設定する部分です。今回はbacklogに自動起票するルールを設定します。
アクション設定より「backlog」を選択し、次の手順で設定します。
認証情報：直接入力
API KEY：起票するユーザーのAPIキー 利用したいアカウントでbacklogにログインします。ログインした状態で、 個人設定＞API画面 に進み、APIキーを発行してください。 ※backlogヘルプセンター：API設定 こちらもご参考ください
エンドポイント：起票先backlogのAPIエンドポイント 例）例) https://(yourspace).backlog.jp/api/v2
プロジェクトID：起票先backlogプロジェクトのプロジェクトID backlogのプロジェクト設定画面のURL https://(yourspace).backlog.com/EditProject.action?project.id=(ID) の（ID）の部分の値がプロジェクトIDとなります。
種別：起票する課題の種別ID プロジェクト設定＞種別＞種別名 画面のURL https://(yourspace).backlog.com/EditIssueType.action?issueType.id=(ID) の、(ID)の部分の値が種別IDとなります。
優先度：中
その他の項目は任意で設定します。
③インシデント設定
ここはルール条件にマッチした場合に作成するインシデントの設定をする部分です。
ステータス完了
担当者：ユーザー01
アラート受信時の動き
上記ルールを登録すると、監視対象サービスからアラートが発生すると下記の流れで自動対応が行われます。
土曜日または日曜日の0:00から24:00の間に、監視対象サービスから、プロジェクトのメールアドレスへ向けて、件名にERRORを含むアラートを送信する。
OpsAidでプロジェクトがアラートを受信する。
プロジェクトに登録されたルールに、アラートがマッチするかチェックする。アラートの件名にERRORが含まれており、土曜日または日曜日の0:00から24:00の間に受信したので、作成したルールの実行条件にマッチする。
ルールの実行条件にマッチしたので、自動でルールのアクションが実行され、Backlogに課題が投稿される。
ルールの実行条件にマッチしたので、自動でインシデントが起票される。
アクションの結果を受けて、ルールの実行結果が起票したインシデントに記録される。
問題なく終了したら、インシデントのステータスが完了となる。
このように、休日に受け取ったアラートをbacklogに自動起票が可能です。お休みの日はOpsAidを利用して、しっかり休みましょう！
OpsAid利用マニュアルも合わせてご確認ください。