跳转至

Webhook 自定义

Webhook 自定义是一种通用的告警通知方式。您可以将观测云产生的告警事件,推送到任意支持 HTTP 接收的系统或平台,实现与内部运维系统、自动化平台或第三方工具的集成。

配置步骤

  1. 定义当前通知对象名称,用于在通知对象列表中识别;
  2. 填写接收告警通知的 HTTP 接口地址。当监控器触发告警时,观测云会向该地址发送 POST 请求(❗️需确认您填写的 Webhook URL 与所选的通知平台类型一致);
  3. 选择需要随通知一同发送的成员
  4. 按需测试通知是否已发送(❗️向此 Webhook 对应的群/频道发送一条测试消息,请前往对应通知对象内查看测试信息是否成功发送);
  5. 配置操作权限
  6. 确认。

选择成员

选择需要随通知一同发送的成员。Webhook 通知时,会将所选成员信息一并对外发送,方便第三方系统根据成员做权限分配或通知路由。

此处可选成员包含当前工作空间内的所有团队和工作空间成员:

通知内容

最终对外发送的 Webhook 事件通知包含以下内容:

事件信息

bodyTypejson 文本:

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 格式,各字段的详情可参考 事件产生

更多实践案例,可参考 观测云 Webhook 自定义告警通知集成

文档评价

文档内容是否对您有帮助? ×