このページの目次
New Relic のアラートで Issue が発生したときに、Waroom のインシデントを自動で起票できます。Issue がクローズされると、インシデントも解決済になります。
New Relic の Workflow から、Webhook の Destination を通じて Waroom に通知を送る構成です。
前提
- Waroom で、インシデントを起票するサービスを作成済みであること(サービスを作成するを参照)
- New Relic で、Destination と Workflow を作成できる権限があること
1. Waroom でインテグレーションを追加する
- Waroom の「インテグレーション」を開き、「New Relic」のタイルをクリックします。
- 「インテグレーションを追加する」をクリックします。
- 「サービス」で、インシデントを起票するサービスを選び、「追加」をクリックします。
- 1 つのサービスに追加できる New Relic のインテグレーションは 1 つです。
- 一覧に追加された行の「Key」をコピーします。これが Integration Key です。
Integration Key を知っていれば誰でもそのサービスにインシデントを起票できます。外部に公開しないでください。漏れた場合は、インテグレーションを削除して追加し直すと新しい Key が発行されます。
2. New Relic に Webhook の Destination を作成する
New Relic のドキュメント を参考に、Webhook の Destination を作成します。
- New Relic の「Destinations」で、「Webhook」の Destination を作成します。
- 次のように入力して保存します。
| 項目 | 設定値 |
|---|---|
| Webhook name | 任意(例: Waroom) |
| Endpoint URL | https://api.app.waroom.com/v1/events/new_relic |
| Use authorization | Bearer Token を選び、手順 1 でコピーした Integration Key を入力 |
Waroom は Authorization: Bearer {{ Integration Key }} ヘッダーで認証します。
3. Workflow に通知を追加する
- 「Alerts」→「Workflows」で、インシデントを起票したい Workflow を作成または編集します。
- 「Notify」で「Webhook」を選び、手順 2 で作成した Destination を選びます。
- 「Payload」に次のテンプレートを設定します。
{
"new_relic": {
"id": {{ json issueId }},
"issueUrl": {{ json issuePageUrl }},
"title": {{ json annotations.title.[0] }},
"priority": {{ json priority }},
"impactedEntities": {{ json entitiesData.names }},
"totalIncidents": {{ json totalIncidents }},
"state": {{ json state }},
"trigger": {{ json triggerEvent }},
"isCorrelated": {{ json isCorrelated }},
"createdAt": {{ createdAt }},
"updatedAt": {{ updatedAt }},
"sources": {{ json accumulations.sources }},
"alertPolicyNames": {{ json accumulations.policyName }},
"alertConditionNames": {{ json accumulations.conditionName }},
"workflowName": {{ json workflowName }}
}
}
- Issue がクローズされたときにもインシデントを解決済にしたい場合は、Workflow の通知設定で、Issue のクローズ時にも通知するようにしてください。
設定後、「Send test notification」で疎通を確認できます。テスト通知でインシデントが起票された場合は、確認後に Waroom 側でクローズしてください。
4. Payload の項目
| 項目 | 内容 |
|---|---|
id | 必須。集約キー。同じ値の通知を 1 つのインシデントにまとめます |
title | 必須。インシデントのタイトル |
priority | Issue の優先度。Waroom の重要度に変換します |
state | Issue の状態。Waroom のステータスに変換します |
issueUrl / totalIncidents / trigger / isCorrelated / workflowName | インシデントの詳細とイベントのカスタムプロパティに記録します |
impactedEntities / sources / alertPolicyNames / alertConditionNames | インシデントの詳細に記録します |
id と title に加えて、priority と state のどちらか一方が必要です。足りない場合、Waroom は 400 を返して起票しません。
priority は次のように変換されます。
New Relic の priority | Waroom の重要度 |
|---|---|
CRITICAL | Critical |
HIGH | High |
MEDIUM | Info |
LOW | Low |
| 上記以外・未指定 | Unknown |
state は次のように変換されます。
New Relic の state | Waroom のインシデント |
|---|---|
CREATED / ACTIVATED | ステータス 検知 で起票 |
INVESTIGATING | ステータス 調査中 で起票(Payload で state を書き換えて送る場合) |
CLOSED | ステータスを 解決済 にする |
| 上記以外・未指定 | ステータス 検知 で起票 |
5. インシデントの集約
id が同じ通知は、同じインシデントのイベントとしてまとめます。
- 同じ
idで、ステータスが「検知」「調査中」「対応中」のインシデントがあれば、そのインシデントにイベントを追加します。 - 該当するインシデントがなければ、新しいインシデントを起票します。
CLOSEDの通知を受け取ると、まとめ先のインシデントを解決済にします。CLOSEDの通知で、まとめ先のインシデントが見つからない場合は起票しません。- 通知を受け取るたびに、まとめ先のインシデントの重要度とステータスは、その通知の
priorityとstateに応じた値に更新されます。たとえば Waroom でステータスを「対応中」にしたあとにACTIVATEDの通知が届くと、ステータスは「検知」に戻ります。
6. Slack 通知とオンコール
- インシデントを新しく起票したとき、解決済にしたとき、重要度が変わったときに、Slack の通知チャンネルに通知します。投稿者は「New Relic Integration」と表示されます。
- オンコールのトリガーは、インシデントを新しく起票したときだけ評価します。トリガーの作成元フィルターでは
integrationに該当します。既存のインシデントにまとめた通知では架電しません。
トラブルシューティング
| 症状 | 確認すること |
|---|---|
401 が返る | Destination の Bearer token が、追加したインテグレーションの Key と一致しているか |
400 が返る | Payload に id・title があり、priority か state の少なくとも一方があるか |
| 復旧してもインシデントが解決済にならない | Workflow で、Issue のクローズ時にも通知する設定になっているか |
解決しない場合は
まずは よくあるご質問 をご確認ください。それでも解決しない場合は、以下からお問い合わせください。