Webhook カスタム¶

Webhook カスタムは、一般的なアラート通知方法です。Guance で発生したアラートイベントを、HTTP 受信をサポートする任意のシステムやプラットフォームにプッシュし、内部の運用管理システム、自動化プラットフォーム、またはサードパーティツールとの統合を実現できます。

設定手順¶

現在の通知オブジェクトの名前を定義します。通知オブジェクトのリストで識別するために使用します。
アラート通知を受信する HTTP インターフェースのアドレスを入力します。モニターがアラートをトリガーすると、Guance はそのアドレスに POST リクエストを送信します（❗️入力した Webhook URL が選択した通知プラットフォームの種類と一致していることを確認してください）。
通知とともに送信するメンバーを選択します。
必要に応じて、通知が送信されているかテストします（❗️この Webhook に対応するグループ/チャンネルにテストメッセージを送信します。対応する通知オブジェクト内でテスト情報が正常に送信されたかどうかを確認してください）。
操作権限を設定します。
確認します。

メンバーを選択する¶

通知とともに送信するメンバーを選択します。Webhook 通知時には、選択したメンバー情報も一緒に外部に送信されるため、サードパーティシステムがメンバーに基づいて権限割り当てや通知ルーティングを行うのに便利です。

ここで選択できるメンバーには、現在のワークスペース内のすべてのチームとワークスペースメンバーが含まれます：

通知内容¶

最終的に外部に送信される Webhook イベント通知には、以下の内容が含まれます。

イベント情報¶

bodyType は json テキストです：

POST http://my-system/accept-webhook
Content-Type: application/json

{
    "timestamp"               : 1625638440,
    "df_status"               : "warning",
    "df_event_id"             : "event-xxxxxxxxxx",
    "df_title"                : "web001存在问题",
    "df_message"              : "web001存在问题\nCPU使用率大于90\n内存使用率大于90",
    "df_dimension_tags"       : "{\"host\":\"web001\"}",
    "df_monitor_id"           : "monitor_xxxxxxxxxx",
    "df_monitor_name"         : "异常检测名",
    "df_monitor_checker_id"   : "rul_xxxxxxxxxx",
    "df_monitor_checker_name" : "异常检测项目名",
    "df_monitor_checker_value": "99",
    "df_event_link"           : "https://console.guance.com/keyevents/monitorChart?xxxxxxxxxx"
    "df_workspace_uuid"       : "wksp_xxxxxxxxxx",
    "df_workspace_name"       : "我的工作空间",
    "Result"                  : 99,
    "...其他更多字段": "略",

    // 以下为旧版字段
    "date"          : 1625638440,
    "workspace_uuid": "wksp_xxxxxxxxxx",
    "workspace_name": "我的工作空间",
}

メンバー情報¶

メンバーが設定されている場合、Webhook はメンバー情報を同期的に送信します。

ワークスペースの属性クレームを同期追加¶

ワークスペースに属性クレームが設定されている場合、関連するフィールドが自動的に通知内容に追加されます。

詳細は、属性クレームを参照してください。

説明

Webhook カスタム通知の送信内容のタイプは JSON 形式のみをサポートしています。各フィールドの詳細については、イベント生成を参照してください。

その他の実践例については、Guance Webhook カスタムアラート通知統合を参照してください。