创建操作
- 登录 Flashduty 控制台,进入【集成中心-Webhook】
- 点击添加 自定义操作 集成
- 配置 操作名称,此名称将以按钮的形式体现在故障详情中
- 配置 管理团队(可选),只有该团队成员可以编辑此集成配置
- 配置 协作空间,可以配置多个,但每个协作空间至多添加五个 自定义操作
- 配置 Endpoint、自定义 Headers
- 保存,完成
编辑已保存的操作
保存之后,Endpoint 和自定义 Payload 照常显示,可以直接修改。自定义 Headers 的取值按密钥处理,Flashduty 不会再把它们显示回来:详情页和编辑页里,每个 Header 的值都显示为******。
编辑时保存规则如下:
想更换某个 Header 的取值,需要重新输入一遍。如果改了 Endpoint,仍是
****** 的 Header 需要重新填写,否则已保存的值会被发送到新的地址;编辑页会在这些 Header 下方提示。
推送描述
请求方式
POST, Content-Type:“application/json”
请求 Payload
person、incident(含 Responder、AssignedTo、Image)的字段与故障 Webhook中的相同,差异如下:incident.alerts额外返回关联告警列表,字段见下方 Alert;无关联告警时不返回该字段。incident.links不返回,请使用故障 Webhook 获取。
自定义操作中的告警对象有以下限制:
- 不返回
incident、integration_ref_id、data_source_type。 integration_name、integration_type、channel_name、channel_status、responder_name、responder_email、data_source_name、data_source_ref_id恒为空字符串。data_source_id同integration_id,请使用integration_id。
请求响应
HTTP status code 为 200,认为推送成功。请求示例
自定义请求体与值映射
自定义操作与故障 Webhook 一样支持 自定义请求体 和 值映射,变量路径引用上方请求 Payload中的字段。语法和示例见故障 Webhook。使用场景
重启主机
当主机内存或 CPU 打满,触发主机重启脚本,快速完成主机重启。信息丰富
当故障发生时,回调您的服务,根据告警详情调取 Tracing、Logging、拓扑等信息,主动调用 Flashduty Open API 来更新故障信息,比如增加标签或设定自定义字段,辅助排障。回滚变更
当发生故障时,如果确定故障由变更导致,可以直接触发回调到您的部署平台,开启回滚进程,加速故障恢复。更新 status page
当确定故障影响到线上服务,可以触发外部 status page 更新,及时的通知到您的客户或上下游。常见问题
-
服务是否有响应超时时间?
- 服务需要在 2 秒内返回响应,超过 2 秒则认为响应失败
-
推送失败后是否会持续推送?
仅以下网络错误会重试,最多 1 次:
- 连接超时或读写超时(
i/o timeout) - 连接被对端提前关闭(
EOF)
- 连接超时或读写超时(
-
推送来源可信 IP 白名单?
47.94.95.118、123.56.8.183、47.94.193.81和1.13.19.96(SaaS 版本;私有化部署的推送来源为您自有环境的出口地址,请向您的基础设施团队确认)- 未来可能会更新,请定期查验