webhookペイロードのカスタマイズ

アドミンまたはオーナー

Webhookをアラート通知チャネルとして使用する場合は、New Relic Alertsのデフォルト値を使用できます。POSTメッセージのペイロードをカスタマイズして、システムインテグレーションをさらに高めることもできます。

Webhookを定義する

JSON Webhookを定義する場合は、"name":"value",の書式を使用します。例えば:

"current_state":"acknowledged",

フォームペイロードで静的なWebhookを定義する場合は、name="value"の形式を使用します。例えば:

current_state="acknowledged"

Webhookに自己署名したカスタムのSSL証明書は含めないでください。当社エージェントでは、デフォルトでSSLが有効になります。当社のセキュリティポリシーにより、カスタムSSL証明書は当社Trustストアにインポートされません。

Webhookの値

当社は、以下のデフォルトの動的なwebhookの値に対応しています。利便性を考慮して、値はアルファベット順に表示されていますが、Webhookの値は順不同で定義できます。独自のキーの値のペアを用いて、カスタム変数を追加することもできます。

キー 変数
"account_id"

$ACCOUNT_ID

設定可能な値: New RelicアカウントのID(文字列)

"account_name"

$ACCOUNT_NAME

設定可能な値: New Relicアカウントの名前(文字列)

"closed_violations_count_critical"

$CLOSED_VIOLATIONS_COUNT_CRITICAL

"closed_violations_count_warning"

$CLOSED_VIOLATIONS_COUNT_WARNING

"condition_id"

$CONDITION_ID

"condition_name"

$CONDITION_NAME

設定可能な値: (ユーザー定義文字列)

"current_state"

$EVENT_STATE

設定可能な値: [OPEN|ACKNOWLEDGED|CLOSED]

"details" $EVENT_DETAILS
"duration"

$DURATION

"event_type"

$EVENT_TYPE

許容数値: [INCIDENT]

"incident_acknowledge_url" $INCIDENT_ACKNOWLEDGE_URL
"incident_api_url" $INCIDENT_API_URL
"incident_id" $INCIDENT_ID
"incident_url" $INCIDENT_URL
"open_violations_count_critical"

$OPEN_VIOLATIONS_COUNT_CRITICAL

"open_violations_count_warning"

$OPEN_VIOLATIONS_COUNT_WARNING

"owner" $EVENT_OWNER
"policy_name"

$POLICY_NAME

設定可能な値: (ユーザー定義文字列)

"policy_url" $POLICY_URL
"runbook_url" $RUNBOOK_URL
"severity"

$SEVERITY

設定可能な値: [CRITICAL]

"targets"

$TARGETS

$TARGETS変数はFORMデータとともに使用できませんが、JSONデータと互換性があります。

静的なNRQLファセット型アラートの場合は、アラートをトリガーしたファセット名がターゲットの名前フィールドに自動入力されます。

"timestamp" $TIMESTAMP
"version" $VERSION
"violation_callback_url"

$VIOLATION_CALLBACK_URL

"violation_chart_url" $VIOLATION_CHART_URL

Webhookの書式の例

以下の例は、デフォルトの動的変数とカスタム変数の両方を使用したWebhookペイロードを示したものです。独自のペイロードを定義するにあたっては、動的変数の全てもしくは一部、並びに任意のカスタム変数を使用できます。

JSON Webhookの例

以下のWebhookの例には、読みやすくするために余分なスペースと改行が挿入されています。実際のWebhookの応答は、連続した1行のテキストとして配信されます。

{
"account_id": "$ACCOUNT_ID",
"account_name": "$ACCOUNT_NAME",
"closed_violations_count_critical": "$CLOSED_VIOLATIONS_COUNT_CRITICAL",
"closed_violations_count_warning": "$CLOSED_VIOLATIONS_COUNT_WARNING",
"condition_family_id": "$CONDITION_FAMILY_ID",
"condition_id": "$CONDITION_ID",
"condition_name": "$CONDITION_NAME",
"current_state": "$EVENT_STATE",
"details": "$EVENT_DETAILS",
"duration": "$DURATION",
"event_type": "$EVENT_TYPE",
"incident_acknowledge_url": "$INCIDENT_ACKNOWLEDGE_URL",
"incident_id": "$INCIDENT_ID",
"incident_url": "$INCIDENT_URL",
"open_violations_count_critical": "$OPEN_VIOLATIONS_COUNT_CRITICAL",
"open_violations_count_warning": "$OPEN_VIOLATIONS_COUNT_WARNING",
"owner": "$EVENT_OWNER",
"policy_name": "$POLICY_NAME",
"policy_url": "$POLICY_URL",
"runbook_url": "$RUNBOOK_URL",
"severity": "$SEVERITY",
"targets": "$TARGETS",
"timestamp": "$TIMESTAMP",
"violation_callback_url": "$VIOLATION_CALLBACK_URL",
"violation_chart_url": "$VIOLATION_CHART_URL",
"team": "DevOps"  <--[example of custom variable]
}
フォームWebhookの例

以下のWebhookの例には、読みやすくするために余分なスペースと改行が挿入されています。実際のWebhookの応答は、連続した1行のテキストとして配信されます。

account_id=$ACCOUNT_ID
account_name=$ACCOUNT_NAME
closed_violations_count_critical=$CLOSED_VIOLATIONS_COUNT_CRITICAL
closed_violations_count_warning=$CLOSED_VIOLATIONS_COUNT_WARNING
condition_family_id=$CONDITION_FAMILY_ID
condition_id=$CONDITION_ID
condition_name=$CONDITION_NAME
current_state=$EVENT_STATE
details=$EVENT_DETAILS
duration=$DURATION
event_type=$EVENT_TYPE
incident_acknowledge_url=$INCIDENT_ACKNOWLEDGE_URL
incident_id=$INCIDENT_ID
incident_url=$INCIDENT_URL
open_violations_count_critical=$OPEN_VIOLATIONS_COUNT_CRITICAL
open_violations_count_warning=$OPEN_VIOLATIONS_COUNT_WARNING
owner=$EVENT_OWNER
policy_name=$POLICY_NAME
policy_url=$POLICY_URL
runbook_url=$RUNBOOK_URL
severity=$SEVERITY
timestamp=$TIMESTAMP
violation_callback_url=$VIOLATION_CALLBACK_URL
violation_chart_url=$VIOLATION_CHART_URL
team="DevOps"  <--[example of custom variable]
テキスト形式出力
New Relic Alert
Incident open: CPU > 50% for 5 minutes
Policy: http://alerts.newrelic.com/accounts/1234/policies/5678
Chart URL: http://gorgon.nr-assets.net/image/12345678-abcd-efgh-ijkl-1234567890

For more details, see:
http://alerts.newrelic.com/accounts/1234/incidents/3456

その他のヘルプ

推奨する詳細情報: