标准告警事件集成指引

---

title: "标准告警事件集成指引"
description: "通过标准协议推送自有系统告警事件到 Flashduty，实现告警事件自动化降噪处理。"
date: "2024-05-11T10:00:00+08:00"
url: "https://docs.flashcat.cloud/zh/flashduty/custom-alert-integration-guide"

---

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

:::tips
Flashduty 已经适配了大部分常用告警系统的 webhook 协议，对于这些系统您应该首先使用对应的集成，更加简单方便。本集成提供了一个标准的 HTTP 接口，需要允许您开发适配。好处是您可以推送任何你想进行oncall的告警事件。
:::

一、请求描述

---

请求方式

请求参数：

请求响应

二、请求示例

---

请求：

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

成功响应：

{
    "request_id": "0ace00116215ab4ca0ec5244b8fc54b0"
}

失败响应：

{
    "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 联系我们。