Webhookのアラートチャネルの作成

Webhook とは、リンク先の URL に配信される JSON ドキュメントを含んだ HTTP POST メッセージです。条件を満たした場合、もしくはデプロイが発生した場合に、New Relic の Webhook 機能は、イベント内容や New Relic へのバックリンクなどの関連情報を設定されているURL宛に送信します。

以下の手順は、既存のアラート機能についてです。New Relic Alerts の Webhook の作成手順とは別物です。

Webhook の処理手順

New Relic は、Web アプリケーション、サーバー監視、キートランザクション、モバイルアプリ、プラグインごとに1つの Webhoook を提供しています。New Relic は、デプロイやアラート等のタイプのイベントにおいて JSON ハッシュのトップレベルの値をプッシュします。

アカウントオーナーや管理者が Webhook 通知設定を行う前に、Webhook 受信側のエンドポイント(URL)を設定する必要があります。エンドポイントが New Relic から Post を受信したときに、想定した動作を行うようにしてください。設定後にアプリやサーバーにおいて(Webアプリの警告やデプロイなど)サポート対象のイベントが発生すると、New Relic は JSON エンコードしたイベント詳細のデータを設定済みの URL に Post します。Post を受信した側は、設定済みの処理を開始します。

ポート番号を Webhook URL に含めたい場合は、リクエスト可能なポートであることを確認してください。リクエスト対象外の場合、Webhook は動作しません。

Webhook のフォーマット

Webhooks は、alert キー/プロパティを格納したフォームエンコードされた JSON です。詳細レベルを提供するには、messageshort descriptionlong description を使います。以下は、Webアプリケーションのアラートポリシーにおける Webhook の例です。

  • Message: “Error rate > 5%” (アラートを開閉するため)
  • Short description: “New alert for Default application alert policy: Error rate > 5%” (アラートをオープンするため) そして “Alert ended for Default application alert policy: Error rate > 5%” (アラートをクローズするため)
  • Long description: “Alert opened for Default application alert policy — Triggered by: Error rate > 5% — Apps currently involved: RPM Local” (アラートをオープンするため) and “Alert ended for Default application alert policy — Triggered by: Error rate > 5% — Apps currently involved: RPM Local, Local Aggregator” (アラートをクローズするため)

アラートポリシーの様々な種類ごとの Webhook のついては、Webhook の例 をご覧ください。

Webhook チャネルの作成

screen alert channel webhook.png
Alerts > Alert policies > Channels and groups: アカウントオーナーと管理者のみ、アラートの通知チャネルとして Webhook を設定できます。

アカウントの所有者または管理者: New Relic において、Webhook 通知を許可する方法は以下のとおりです。

  1. New Relic のメニューバーから、Alerts > Alert policies > Channels and groups を選択します。
  2. Channels セクションにて、Create channel > Webhook を選択します。
  3. Webhook 名、ターゲットURL、説明(任意)を入力します。
  4. 通知レベルを選択します。
  5. Integrate with Webhooks [Webhook を設定]を押します。

Webhook チャネルのテスト

推奨: アカウントの所有者または管理者が、Webhook URL を追加したり、変更した後は、テストメッセージを送信してください。

  1. New Relic のメニューバーから、Alerts > Alert policies > Channels and groups を選択します。
  2. Channelsセクションにて、Webhook を選択し、webhook を選びます。
  3. send test message [テストメッセージの送信]を押します。
  4. 指定した URL のおいて、webhook からのメッセージが受信されたことを確認します。

トラブルシューティングとして、RequestBin のようなサイトも使えます。

関連情報

関連する情報は以下のとおりです。