mirror of
https://github.com/dromara/hertzbeat.git
synced 2026-09-17 09:40:58 +00:00
Compare commits
53
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6b2e66df65 | ||
|
|
ea5b678af5 | ||
|
|
fa24e5000f | ||
|
|
f242ead7a9 | ||
|
|
5402437eac | ||
|
|
ce61c7d456 | ||
|
|
320766a48e | ||
|
|
efb2ac02df | ||
|
|
06c939c810 | ||
|
|
e56823b240 | ||
|
|
3b18d1ddaf | ||
|
|
d44fe43eb0 | ||
|
|
a221ddfba2 | ||
|
|
8e31a3147b | ||
|
|
d2f9a56fe7 | ||
|
|
a0b41dc7bb | ||
|
|
3f572a1ddc | ||
|
|
767deccee5 | ||
|
|
9221e2f6c1 | ||
|
|
0a36b3df90 | ||
|
|
f3202133d8 | ||
|
|
6ee458c521 | ||
|
|
cbc1caf4ac | ||
|
|
86db630fc7 | ||
|
|
145c4d1d5e | ||
|
|
0217cbb7f9 | ||
|
|
9f5df95f29 | ||
|
|
0f955019bf | ||
|
|
129b6282d3 | ||
|
|
36c5d8f518 | ||
|
|
de8a473e24 | ||
|
|
ffc4641dc9 | ||
|
|
d0cb9f8bf3 | ||
|
|
0d4ff33f19 | ||
|
|
86f40e5e15 | ||
|
|
dbbbc045d4 | ||
|
|
b0fdd5e11d | ||
|
|
9c5ea20b15 | ||
|
|
7a74f80906 | ||
|
|
ee32a890eb | ||
|
|
ec1c04194b | ||
|
|
55d8dfdede | ||
|
|
918073dca7 | ||
|
|
2defaecd93 | ||
|
|
641ba47f4c | ||
|
|
ccbc2151ae | ||
|
|
1cb919a301 | ||
|
|
7351a03c81 | ||
|
|
26c3a802d1 | ||
|
|
47dbe2fd2a | ||
|
|
f4943e9d89 | ||
|
|
1f6614d1a1 | ||
|
|
4a96c02b9a |
@@ -1,15 +1,21 @@
|
||||
> HertzBeat 对外提供 api 接口,外部系统可以通过 Webhook 方式调用此接口将告警数据推送到 HertzBeat 告警平台。
|
||||
HertzBeat 提供 API 接口,外部系统可以通过 Webhook 方式调用此接口,将告警数据推送到 HertzBeat 告警平台。
|
||||
|
||||
### 接口端点
|
||||
|
||||
|
||||
## 接口端点
|
||||
|
||||
`POST /api/alerts/report`
|
||||
|
||||
### 请求头
|
||||
|
||||
- `Content-Type`: `application/json`
|
||||
- `Authorization`: `Bearer {token}`
|
||||
|
||||
### 请求体
|
||||
## 请求头
|
||||
|
||||
* `Content-Type`: `application/json`
|
||||
* `Authorization`: `Bearer {token}`
|
||||
|
||||
|
||||
|
||||
## 请求体
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -30,30 +36,32 @@
|
||||
}
|
||||
```
|
||||
|
||||
字段說明
|
||||
### 字段说明
|
||||
|
||||
- `labels`: 告警標籤
|
||||
- `alertname`: 告警規則名稱
|
||||
- `priority`: 告警級別 (warning, critical)
|
||||
- `instance`: 告警實例
|
||||
- `annotations`: 告警註釋信息
|
||||
- `summary`: 告警摘要
|
||||
- `description`: 告警詳細描述
|
||||
- `content`: 告警內容
|
||||
- `status`: 告警狀態 (firing, resolved)
|
||||
- `triggerTimes`: 告警觸發次數
|
||||
- `startAt`: 告警開始時間
|
||||
- `activeAt`: 告警激活時間
|
||||
- `endAt`: 告警結束時間
|
||||
* `labels`: 告警标签
|
||||
* `alertname`: 告警规则名称
|
||||
* `priority`: 告警级别 (`warning`, `critical`)
|
||||
* `instance`: 告警实例
|
||||
* `annotations`: 告警注释信息
|
||||
* `summary`: 告警摘要
|
||||
* `description`: 告警详细描述
|
||||
* `content`: 告警内容
|
||||
* `status`: 告警状态 (`firing`, `resolved`)
|
||||
* `triggerTimes`: 告警触发次数
|
||||
* `startAt`: 告警开始时间
|
||||
* `activeAt`: 告警激活时间
|
||||
* `endAt`: 告警结束时间
|
||||
|
||||
|
||||
### 配置验证
|
||||
|
||||
- 第三方系统触发告警后通过 webhook 回调 HertzBeat 的 `/api/alerts/report` 接口,将告警数据推送到 HertzBeat 告警平台。
|
||||
- 在 HertzBeat 告警平台中对告警数据处理查看,验证告警数据是否正确。
|
||||
## 配置验证
|
||||
|
||||
* 第三方系统触发告警后,通过 Webhook 回调 HertzBeat 的 `/api/alerts/report` 接口,将告警数据推送到 HertzBeat 告警平台。
|
||||
* 在 HertzBeat 告警平台中处理并查看告警数据,验证告警数据是否正确。
|
||||
|
||||
|
||||
### 数据流转:
|
||||
|
||||
## 数据流转
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
@@ -67,7 +75,8 @@ graph LR
|
||||
```
|
||||
|
||||
|
||||
### 常见问题
|
||||
|
||||
- 确保 HertzBeat URL 可以被第三方系统服务器访问。
|
||||
- 检查第三方系统日志中是否有告警发送成功失败的消息。
|
||||
## 常见问题
|
||||
|
||||
* 确保 HertzBeat URL 可以被第三方系统服务器访问。
|
||||
* 检查第三方系统日志中是否有告警发送成功或失败的消息。
|
||||
|
||||
Reference in New Issue
Block a user