Flashcat API
FlashdutyNightingaleFlashcat帮助文档官网控制台
FlashdutyNightingaleFlashcat帮助文档官网控制台
  1. Event API
  • 介绍
  • Open API
    • 快速入门
    • 关于分页
    • 成员管理
      • 邀请成员
      • 重置信息
      • 删除成员
      • 成员列表
    • 团队管理
      • 团队列表
      • 基本信息
      • 团队删除
      • 团队Upsert
    • 值班管理
      • 创建值班表
      • 更新值班表
      • 预览值班表
      • 删除值班表
      • 查看值班详情
      • 查看值班列表
      • 个人值班日程
      • 根据ID列表获取值班表信息
      • 角色信息
    • 信息获取
      • 人员
      • 团队
      • 协作空间
    • 偏好设置
      • 查看偏好设置
      • 修改偏好设置
    • 协作空间
      • 分派策略
        • 策略详情
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 订阅规则
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 排除规则
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 静默策略
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 抑制策略
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 空间列表
      • 空间详情
      • 空间创建
      • 空间更新
      • 空间启用
      • 空间禁用
      • 空间删除
      • 空间排序
      • 空间收藏
      • 取消收藏
      • 机器人列表
      • 按集成查询空间名称
    • 模板管理
      • 模板列表
      • 模板详情
      • 模板启用
      • 模板禁用
      • 模板删除
      • 模板预览
      • 模板创建
      • 模板更新
    • 故障管理
      • 聚合视图
        • 视图删除
        • 视图列表
        • 视图创建
        • 视图更新
      • 创建故障
      • 分派故障
      • 添加处理人
      • 认领故障
      • 取消认领
      • 关闭故障
      • 重开故障
      • 删除故障
      • 屏蔽故障
      • 取消屏蔽
      • 合并故障
      • 评论故障
      • 故障详情
      • 故障列表
      • 故障列表-卡片视图
      • 故障列表-按ID查询
      • 历史故障列表
      • 故障时间线
      • 标题更新
      • 描述更新
      • 影响更新
      • 根因更新
      • 解决方案更新
      • 严重程度更新
      • 关联告警列表
      • 自定义字段更新
      • 触发自定义操作
    • 告警管理
      • 聚合视图
        • 视图删除
        • 视图列表
        • 视图创建
        • 视图更新
      • 告警详情
      • 关闭告警
      • 告警列表-卡片视图
      • 告警列表
      • 告警列表-按ID查询
      • 关联-事件列表
      • 时间线
      • 合并到故障
    • 变更管理
      • 变更列表
    • 自定义字段
      • 字段列表
      • 字段详情
      • 字段删除
      • 字段创建
      • 字段更新
    • 服务日历
      • 日历列表
      • 日历详情
      • 日历创建
      • 日历更新
      • 日历删除
      • 日历事件设置
      • 日历事件删除
      • 日历事件列表
    • 标签增强
      • Mapping
        • 查询schema
        • 创建schema
        • 更新schema
        • 删除schema
        • 查询data
        • 更新data
        • 删除data
        • 清空data
        • csv上传data
        • csv下载data
      • 规则详情
      • 规则更新
    • 告警处理
      • 规则详情
      • 规则更新
    • 集成路由
      • 路由历史列表
      • 路由列表
      • 路由详情
      • 路由更新
    • License管理
      • License成员列表
      • 修改成员License类型
    • 分析看板
      • 告警标签TOP
      • 账户维度指标
      • 故障明细查询
      • 故障明细导出
      • 团队维度指标
      • 团队维度指标导出
      • 空间维度指标
      • 空间维度指标导出
      • 个人维度指标
      • 个人维度指标导出
      • 通知数量
      • 变更数量
  • Webhook
    • 快速入门
    • 自定义操作
    • 故障 Webhook
    • 告警 Webhook
  • Event API
    • 快速入门
    • 告警 Event
    • 变更 Event
  1. Event API

告警 Event

通过标准协议推送自有系统告警事件到 Flashduty,实现告警事件自动化降噪处理。

一、请求描述#


请求方式#

POST, Content-Type:"application/json"

请求参数:#

Headers:#

字段必含类型释义
Content-Type是string固定值:application/json。

Query Strings:#

字段必含类型释义
integration_key是string集成秘钥,用于访问控制。添加集成后获得。

Payload:#

字段必含类型释义
title_rule是string告警标题,不超过512个字符,超出后将自动截断。

支持根据告警内容动态生成标题,生成规则请参考 定制故障标题。
event_status是string告警状态。

枚举值(首字母大写):Critical:严重,Warning:警告,Info:提醒,Ok:恢复。

当指定为Ok时,意味着对告警进行自动恢复。
alert_key否string告警标识,用于对已经存在的告警进行更新或自动恢复。

您可以自定义此值,但不可超过255个字符。您也可以依赖系统自动生成,该值会在响应中返回。

如果您上报的是恢复事件,则此值必须存在。
description否string告警描述,不超过2048个字符,超出后将自动截断。
labels否map告警标签集合,key 为标签名称,value 为标签值:

1. 标签的 key 和 value 均为 string 类型,区分大小写。
2. 标签的 key 不要超过128个字符,遵循Prometheus标签命名规范。value 不超过2048个字符,超出后将自动截断。
3. 至多传入50个标签。标签内容参考最佳实践。

示例:"resource": "171.26.23.22", "check": "api latency > 500ms"

请求响应#

字段名称必选类型描述
request_id是string请求 ID,用于链路追踪
error否Error错误描述,仅当出现错误时返回
data否Data上报信息
Data:
字段名称必选类型描述
alert_key否string告警标识,可依据此值上报恢复事件。如果您上报事件时,已经指定了 alert_key,则此值不变。否则,系统自动生成。
Error:
字段名称必选类型描述
code是string错误码,枚举值参考 Code
message否string错误描述
Code:
错误码HTTP Status描述
InvalidParameter400参数错误
InvalidContentType400Conten-Type 不支持
MethodNotAllowed400HTTP Method 不支持
Unauthorized401登录认证未通过
AccessDenied403权限认证未通过
RequestTooFrequently429请求过于频繁
RouteNotFound404请求 Method+Path 未匹配
ResourceNotFound400账户未购买资源,先前往费用中心线操作下单
NoLicense400账户无充足订阅 License,先前往费用中心升级或购买订阅
InternalError500内部或未知错误

二、请求示例#


请求:
成功响应:
{
    "request_id": "0ace00116215ab4ca0ec5244b8fc54b0",
    "data": {
        "alert_key": "9qJ798NJoXS4UMVB5SHsNj"
    }
}
失败响应:
{
    "request_id": "0ace00116215abc0ba4e52449bd305b0",
    "error": {
        "code": "InvalidParameter",
        "message": "integration_key is not a valid one"
    }
}

三、最佳实践 #


1.
当告警状态发生变更时,向 Flashduty发送事件
2.
当告警恢复时,发送一个 status 为 Ok 的事件,来关闭告警。否则,告警将一直处于打开状态。如果您的告警系统没有恢复事件,建议您手动发送恢复事件
3.
标签是事件的描述,应尽量丰富标签内容(发送时指定,或者通过配置 enrichment 规则来生成新的标签),比如:
告警的发生来源,如 host,cluster,check 或 metric 等
告警的归属信息,如 team,owner 等
告警的类别信息,如 class(api,db,net)

四、常见问题#


为什么在Flashduty没有收到告警?

在 Flashduty#

1.
查看集成是否展示了 最新事件时间?如果没有,代表Flashduty没有收到推送,直接优先您的系统。
2.
如果您使用的是 共享集成,优先确认您是否配置了 路由规则。不设置路由规则,系统会直接拒绝新的推送,因为没有协作空间可以承接您的告警。这种情况下,直接配置路由规则到您期望的空间即可。

在您的系统#

1.
确认您请求的地址,和集成详情中的地址完全一致。
2.
确认您的服务可以访问外网 api.flashcat.cloud 域名。如果不可以,您首先需要为 server 开通外网,或单独针对 Flashduty 的域名开通外网访问。
3.
打印 Flashduty 服务的响应结果,查看是否有明确信息。
如果以上步骤执行之后,仍然没有查询到问题根因,请 携带请求响应中的 request_id 联系我们。
为什么推送请求成功?但是没有看到新告警或故障产生?
Flashduty 使用2层降噪机制:
1.
首先对告警event进行去重检查,如果您推送的event和之前推送的event内容完全一致,则新的event将被直接丢弃。
2.
如果新的event的状态和描述和其对应的告警的上一条event的状态、标题、描述均一致,则新的event将被直接丢弃,同时更新归属告警属性。
3.
新的event可能由于匹配到排除、丢弃、抑制或静默规则,而被丢弃。
4.
当新的event触发了新告警,则系统会进入第二层降噪检查,判断新告警是否可以被合并到某个活跃的故障中,如果可以,则只会并入已有的故障,而不会产生新故障。
更多内容请参考 告警降噪。

添加官方技术人员微信

在这里,获得使用上的任何帮助,快速上手企业告警一站式响应平台FlashDuty

微信扫码交流
修改于 2025-01-21 07:34:51
上一页
快速入门
下一页
变更 Event
Built with