Webhook の情報のカスタマイズ

管理者 または オーナー Webhook をアラート通知チャネルとして使う場合、New Relic Alerts のデフォルト値を使うこともできますし、より適した情報を送るために POST メッセージに入れる情報をカスタマイズすることもできます。

Webhook values

Webhook を定義する際は、"name":"value", フォーマットを使います。以下がその例です。

"current_state":"acknowledged",

New Relic Alerts は、以下の Webhook の値をサポートします。ここでは分かりやすいように、アルファベット順にしていますが、実際に設定する際は、順不同で結構です。$VARIABLE の部分は実際の値を指定してください。また、値は引用符で囲んでください。

キー 変数
“account_id” $ACCOUNT_ID
設定可能な値: New Relic アカウント ID (文字列)
“account_name” $ACCOUNT_NAME
設定可能な値: New Relic のアカウント名 (文字列)
“condition_id” $CONDITION_ID
“condition_name” $CONDITION_NAME
設定可能な値: (ユーザーが定義した文字列)
“current_state” $EVENT_STATE
設定可能な値: [OPEN|ACKNOWLEDGED|CLOSE]
“details” $EVENT_DETAILS
“event_type” $EVENT_TYPE

設定可能な値:

  • VIOLATION_OPEN, VIOLATION_CLOSE
  • INCIDENT_OPEN, INCIDENT ACKNOWLEDGED, INCIDENT_RESOLVED, INCIDENT_CLOSED
  • NOTIFICATION_FAILURE, NOTIFICATION_QUEUED, NOTIFICATION_SENT
  • NOTIFICATION_INFORMATION, NOTIFICATION_INFORMATION_SENT, NOTIFICATION_INFORMATION_FAILURE
  • NOTIFICATION_TEST, NOTIFICATION_TEST_SENT, NOTIFICATION_TEST_FAILURE
“incident_acknowledge_url” $INCIDENT_ACKNOWLEDGE_URL
“incident_api_url” $INCIDENT_API_URL
“incident_id” $INCIDENT_ID
“incident_url” $INCIDENT_URL
“owner” $EVENT_OWNER
“policy_name” $POLICY_NAME
設定可能な値: (user-defined string)
“policy_url” $POLICY_URL
“runbook_url” $RUNBOOK_URL
“severity” $SEVERITY
設定可能な値: [INFO|WARN|CRITICAL]
“targets” $TARGETS
“timestamp” $TIMESTAMP
“version” $VERSION

Webhook フォーマットの例

以下は、Apdex 設定が「Apdex < 0.80 for at least 10 minutes」であり、ウェブアプリのアラートポリシーのインシデントをオープンする際の Webhook の例です。この例では、すべての利用可能な変数を記載していますが、実際には、必要な変数のみで結構です。 以下の Webhook の例では、読みやさを考慮し、余分なスペースや改行を入れています。実際の Webhook のデータは、1行の連続した値の文字列​として送信されます。

// この例をコピー&ペーストする場合は、すべての値を自身が利用する値に変更してください。
{
“current_state”:”OPEN”,  <–[OPEN|ACKNOWLEDGED|CLOSE]
“details”:”Apdex < .80 for at least 10 min”,
“severity”:”WARN”,       <–[INFO|WARN|CRITICAL]
“incident_api_url”:”https://alerts.newrelic.com/api/explore/applications/incidents/1234“,
“incident_url”:”https://alerts.newrelic.com/accounts/99999999999/incidents/1234“,
“owner”:”user name”,
“policy_url”:”https://alerts.newrelic.com/accounts/99999999999/policies/456“,
“runbook_url”:”https://localhost/runbook”,
“policy_name”:”APM Apdex policy”,
“condition_id”:987654,
“condition_name”:”My APM Apdex condition name”,
“event_type”:”INCIDENT”,
“incident_id”:1234,
“targets”:[
  {
   “id”:”23456“,
   “name”:”My Application”,
   “link”:”https://alerts.newrelic.com/accounts/99999999999/applications/23456?tw[start]=1425415729&tw[end]=1425417529”
   “labels”:{
     “Service”:”Account Service”,
     “Product”:”APM”,
     “Team”:”APM Team”,
   },
   “type”:”APM:Application”,
  }
 ]
“timestamp”:1425417514074
}