在 Flashduty On-call
您可通过以下两种方式获取集成推送地址,任选其一即可。
使用专属集成
- 进入 Flashduty 控制台,选择 协作空间,打开一个协作空间
- 选择 配置 → 集成数据 → 专属集成,点击 新增一个集成
- 选择 UpGuard,点击 保存
- 打开生成的集成卡片,复制 推送地址
使用共享集成
- 进入 Flashduty 控制台,选择 集成中心 → 告警事件
- 选择 UpGuard,填写集成名称
- 配置默认路由并选择协作空间;创建后可在 路由 中增加更多规则
- 点击 保存,复制生成的 推送地址
在 UpGuard 中配置
1
新增 Webhook 集成
- 登录 UpGuard,进入 Integrations,新增一个 Webhook 集成
- 选择触发条件(Triggers)
- 填写集成名称,并把 Flashduty 集成的完整推送地址粘贴到 Webhook 地址,地址中需包含
integration_key
2
填写请求体模板
UpGuard 用 Liquid 模板生成请求体,Flashduty 解析下面这个模板渲染出的 JSON。请把它粘贴到请求体(payload)中,字符串字段需要带引号:
id 必须保留,缺少 notification.id 的请求会被拒绝。context 里的字段按触发条件不同而不同,不存在的字段会渲染为空,Flashduty 会忽略空值。3
开启集成并测试
- 点击 Send test message,确认 Flashduty 收到告警。UpGuard 的文档没有给出测试消息的内容,Flashduty 按普通通知处理,会创建一条告警,验证后请手动关闭
- 启用该集成
4
开启超时自动关闭
请在接收这些告警的协作空间中开启 超时自动关闭,建议时长 7 天。UpGuard 不发送恢复通知,不开启时这些告警会一直保持未关闭状态。
事件类型
Alert Key
Flashduty 使用
notification.id 作为 Alert Key:id 不同的通知各自对应一条告警,id 相同的重复投递合并到同一条告警;缺少 notification.id 的请求会被拒绝。UpGuard 的文档没有说明该编号的唯一性范围,上线前建议用测试消息和一次真实触发确认两条通知的 id 不同。
状态和告警等级
UpGuard 的通知不带严重程度,所有通知都按 Warning 创建。需要区分时,可在协作空间的告警处理规则中按
notification_type 标签调整等级。
标签
告警标题取自
description(例如 The score for 'Example Company' dropped below 600 with a score of 599),为空时使用通知类型。
注意事项
- UpGuard 的通知可能包含泄露、身份等敏感信息,模板里只填写上文列出的字段即可,不要添加凭证或个人数据
- UpGuard 从固定的一组 IP 发起请求,列表见 webhook-ips.json,如果 Flashduty 前置了 IP 白名单,请放行
- 如果
description中出现双引号,渲染出的 JSON 会不合法,请求会被拒绝为参数错误
排查问题
- Flashduty 没有收到推送:确认 Webhook 地址完整且包含
integration_key,集成已启用 - 返回参数错误:提示缺少
notification.id时,检查请求体模板是否保留了id;提示 JSON 不合法时,检查字符串字段是否带引号 - 告警一直不关闭:UpGuard 没有恢复通知,请开启协作空间的超时自动关闭