告警 Event

---

title: "告警 Event"
description: "Flashduty 告警 Event API 文档。"
date: "2025-01-20T10:00:00+08:00"
url: "https://developer.flashcat.cloud/zh/flashduty/event-api/alert-event"

---

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

一、请求描述

---

请求方式

请求参数：

请求响应

字段名称	必选	类型	描述
request_id	是	string	请求 ID，用于链路追踪
error	否	Error	错误描述，仅当出现错误时返回
data	否	Data	上报信息

Data:

字段名称	必选	类型	描述
alert_key	否	string	告警标识，可依据此值上报恢复事件。如果您上报事件时，已经指定了 alert_key，则此值不变。否则，系统自动生成。

Error:

字段名称	必选	类型	描述
code	是	string	错误码，枚举值参考 Code
message	否	string	错误描述

Code:

错误码	HTTP Status	描述
InvalidParameter	400	参数错误
InvalidContentType	400	Conten-Type 不支持
MethodNotAllowed	400	HTTP Method 不支持
Unauthorized	401	登录认证未通过
AccessDenied	403	权限认证未通过
RequestTooFrequently	429	请求过于频繁
RouteNotFound	404	请求 Method+Path 未匹配
ResourceNotFound	400	账户未购买资源，先前往费用中心线操作下单
NoLicense	400	账户无充足订阅 License，先前往费用中心升级或购买订阅
InternalError	500	内部或未知错误

二、请求示例

---

请求：

curl -X POST '{api_host}/event/push/alert/standard?integration_key={integration_key}' \
-H 'Content-Type: application/json' \
-d '{
    "event_status": "Warning",
    "title_rule": "cpu idle low than 20%",
    "labels": {
        "service": "engine",
        "cluster":"nj",
        "resource":"es.nj.01",
        "check":"cpu.idle<20%",
        "metric":"node_cpu_seconds_total"
    }
}' -v

成功响应：

{
    "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触发了新告警，则系统会进入第二层降噪检查，判断新告警是否可以被合并到某个活跃的故障中，如果可以，则只会并入已有的故障，而不会产生新故障。

更多内容请参考 告警降噪。