版本要求:基础标签增强需要 On-call 标准版及以上订阅,高级标签增强(如 API 映射)需要专业版及以上。
了解更多
核心用途
标签贯穿 Flashduty On-call 的告警处理全流程:
配置标签增强
进入 集成详情 → 标签增强 → 添加规则。
增强类型
配置选项
多条规则从上到下依次执行。规则不匹配时跳过,不会生成对应标签。
配置示例
场景:告警事件来自邮件集成,需要从描述信息中提取关键信息作为标签应用到其他场景,比如将描述信息中的 IP 和触发值提取为独立的标签。 场景:公司的日志平台可以通过域名+事件ID+时间戳的方式直接访问到日志详情,但告警信息中只有事件ID和时间戳标签,所以需要根据这些信息组合成一个访问地址。 场景:当源告警信息中的标签值不固定且不能直观定位其含义时,可以通过映射的方式将源标签映射为新定义的标签和值。标签映射支持两种映射方式,在添加映射规则时通过内联单选切换选择 元数据表 或 API:示例:源告警中只有资源类型 ID 信息,希望将每个 ID 对应的资源类型名称也体现出来。准备映射表文件
准备 CSV 格式的映射表文件,目的是将告警中的资源类型 ID 与实际的资源类型名称进行映射。 创建映射表
- 进入
配置中心 → 映射数据 → 元数据表 → 创建映射表
- 填写基本信息,如名称、描述、管理团队等
- 在
映射表数据 处,上传准备好的 CSV 文件(如果数量较少,创建完成后可以在映射详情页面中编辑添加)
- 选择
源标签(如 ID),选择 目标标签(如 Type)
- 点击
创建,完成映射表创建
验证映射效果
告警原文:上报的告警信息中只有资源 ID,没有资源类型名称。映射效果:通过配置的映射关系,将资源 ID 映射出新的资源类型名称标签。 示例:需要根据告警中的主机信息从 mapping api 系统查询负责团队、服务等级等动态数据。创建映射服务
- 进入
配置中心 → 映射数据 → API → 创建API
- 填写服务配置信息:
如果 API 使用 HTTPS 且证书不受信任,可开启 跳过证书验证 选项。
配置映射规则
在标签增强中添加映射规则,通过单选切换选择映射类型为 API:
- 选择已创建的映射服务
- 配置
生成标签列表:指定希望从 API 返回的标签名称,如 owner_team、service_tier、host_ip
- 根据需要开启
覆盖 选项
验证映射效果
当告警触发时,Flashduty 会自动调用配置的 API 服务,将告警事件数据发送给外部系统,并将返回的标签添加到告警中。
映射数据管理
映射表数据管理
在映射表详情页面中,可以对映射表数据进行管理:
对于频繁变更的映射关系(如 Mapping api 数据同步),建议使用 API 映射方式,或通过 Flashduty API 自动化更新映射表数据。
映射服务 API 规范
当使用 API 映射时,您的外部 API 服务需要遵循以下规范:
请求规范
Flashduty 将通过 POST 方法调用您的 API,请求体包含以下内容:
响应规范
API 需要返回以下格式的 JSON 响应:
成功响应 (HTTP 200):
如果某个请求的标签无法找到对应的值,API 不应在 result_labels 中包含该 key。
安全约束
为确保安全性,以下 HTTP Header 被禁止在映射服务中使用:
建议使用 X-Custom- 或 X-Enrich- 前缀的自定义 Header 进行认证。
最佳实践
- 性能优先:API 位于告警处理的关键路径,必须保证低延迟(建议 < 1s)
- 实现缓存:对于相同的查询条件,建议实现缓存以提高性能
- 幂等设计:对于同一个事件,多次调用应返回相同的结果
- 安全认证:API 必须通过认证机制保护,防止未授权访问
延伸阅读