You need to enable JavaScript to run this app.
导航
创建 Webhook 集成配置
最近更新时间:2024.03.12 17:09:56首次发布时间:2024.03.04 10:31:02

Webhook 集成配置用于管理钉钉、飞书、企业微信、自定义 Webhook 等 Webhook 告警通知渠道。本文介绍创建 Webhook 集成配置的操作步骤。

背景信息

日志服务支持通过 Webhook 集成方式管理 Webhook 地址,将告警通知发送给飞书群、钉钉群、企业微信群或其他自定义 Webhook 地址(例如自建系统、第三方告警系统等)。通过此方式管理 Webhook 地址时,告警系统会根据各个请求的返回体判断告警通知是否发送成功。另外,Webhook 集成方式可集中管理您所有的 Webhook 地址,您只需在告警组中绑定对应的 Webhook 集成配置,无需反复配置 Webhook 地址。

Webhook 安全配置

日志服务告警支持如下安全配置。

  • 飞书和钉钉渠道
    • 自定义关键词
      如果在飞书或钉钉机器人中配置了自定义关键词,则需要在日志服务的告警通知内容中至少添加其中 1 个关键词。使用此方式时,建议在钉钉或飞书侧将其中一个关键字设置为告警
    • 签名校验
      如果在飞书或钉钉机器人中配置了加签密钥,则需要在日志服务侧的 Webhook 集成配置中输入该加签密钥。
  • 其他自定义 Webhook 地址
    通过 HTTP 请求头进行权限校验,即在请求头中添加"Authorization": "Bearer ${token}",其中需将${token}替换为您自定义的 Token。

操作步骤

  1. 登录日志服务控制台
  2. 在顶部导航栏中选择目标日志项目所在的地域。
  3. 在左侧目录中选择日志服务 > Webhook 管理
  4. Webhook 管理页面中,单击创建 Webhook 集成
  5. 在创建 Webhook 集成配置对话框中,完成如下配置。
    1. 设置 Webhook 集成配置的名称。
    2. 选择通知渠道类型。
      支持飞书、钉钉、企业微信和自定义 Webhook。
    3. 根据您所选择的通知渠道类型,完成如下配置。
      • 飞书

        配置

        说明

        请求地址

        Webhook 地址。您需要先在飞书中添加自定义机器人,然后在此处输入飞书机器人的 Webhook 地址。详细说明请参考自定义机器人使用指南

        加密密钥

        Webhook 加密密钥。选填,仅在飞书机器人中设置安全设置签名校验时,需在此处输入飞书机器人的签名密钥。详细说明请参考自定义机器人使用指南

      • 钉钉

        配置

        说明

        请求地址

        Webhook 地址。您需要先在钉钉中添加自定义机器人,然后在此处输入钉钉机器人的 Webhook 地址。详细说明请参考企业内部应用机器人的创建和安装

        加密密钥

        Webhook 加密密钥。您在钉钉机器人中设置了签名值时,需在此处输入钉钉机器人的签名值。详细说明请参考开发机器人

      • 企业微信

        配置

        说明

        请求地址

        Webhook 地址。您需要先在企业微信中添加自定义机器人,然后在此处输入企业微信机器人的 Webhook 地址。详细说明请参考群机器人配置说明

      • 自定义 Webhook

        配置

        说明

        请求方法

        请求该 Webhook 地址的方法。支持 POST、PUT。

        请求地址

        Webhook 地址。

        • 对于自建系统,您需要在服务端实现一个回调接口以供日志服务后端调用,并提供请求地址。
        • 对于第三方告警系统,请参考对应的官方文档获取自定义回调地址及请求体结构。

        请求头

        请求该 Webhook 地址的请求头。
        日志服务提供默认请求头"content-type": "application/json" ,您也可以单击添加一行,追加请求头。日志服务会在每一条告警通知的请求头中封装这些信息。

    4. 单击确定

相关操作

创建 Webhook 集成配置后,您还可以在 Webhook 管理页面中进行如下操作。

操作

说明

查看 Webhook 集成配置

找到目标 Webhook 集成配置,在其操作列单击查看详情,查看相关配置。

编辑 Webhook 集成配置

找到目标 Webhook 集成配置,在其操作列单击编辑,编辑相关配置。

复制 Webhook 集成配置

找到目标 Webhook 集成配置,在其操作列单击复制,复制一个 Webhook 集成配置。

删除 Webhook 集成配置

找到目标 Webhook 集成配置,在其操作列展开折叠菜单并单击删除,删除该 Webhook 集成配置。