Skip to content

Commit cb05f13

Browse files
pijiang3pijiang3
committed
add volcengine detect docs
1 parent 769a554 commit cb05f13

4 files changed

Lines changed: 173 additions & 2 deletions

File tree

‎flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.48 Volcengine Detect Integration.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: "Volcengine Cloud-Detect Alert Events"
3+
description: "Sync Volcengine Cloud-Detect alert events to Flashduty via webhook for automated alert noise reduction"
4+
date: "2024-07-05T10:00:00+08:00"
5+
url: "https://docs.flashcat.cloud/en/flashduty/volcengine-tls-integration-guide"
6+
---
7+
8+
Sync Volcengine Cloud-Detect alert events to Flashduty via webhook for automated alert noise reduction.
9+
10+
<div class="hide">
11+
12+
## In Flashduty
13+
---
14+
You can obtain an integration push URL through either of these two methods:
15+
16+
### Using Private Integration
17+
18+
Choose this method when you don't need to route alert events to different channels - it's simpler.
19+
20+
<details>
21+
<summary>Expand</summary>
22+
23+
1. Go to the Flashduty console, select **Channel**, and enter a channel's details page
24+
2. Select the **Integrations** tab, click **Add Integration** to enter the integration page
25+
3. Choose **Volcengine Detect** integration and click **Save** to generate a card
26+
4. Click the generated card to view the **Push URL**, copy it for later use, and you're done
27+
28+
</details>
29+
30+
### Using Shared Integration
31+
32+
Choose this method when you need to route alerts to different channels based on the alert event payload.
33+
34+
<details>
35+
<summary>Expand</summary>
36+
37+
1. Go to the Flashduty console, select **Integration Center=>Alert Events** to enter the integration selection page
38+
2. Select **Volcengine Detect** integration:
39+
- **Integration Name**: Define a name for this integration
40+
3. Configure the default route and select the corresponding channel (after the integration is created, you can go to `Route` to configure more routing rules)
41+
4. Click **Save** and copy the newly generated **push URL** for later use
42+
5. Done
43+
44+
</details>
45+
</div>
46+
47+
## In Volcengine
48+
---
49+
50+
<div class="md-block">
51+
52+
## 一、Create Notification Object
53+
54+
### Step 1: Create Notification Object
55+
1. Login to your `Volcengine` console, find `Alert Manager` in the `Notify Object` menu
56+
2. Click `System Integration`, click `Create System Integration` or edit the existing endpoint
57+
3. 在编辑页面中，名称填写 `Flashduty` ，`回调 URL` 处填写告警集成的<span class='integration_url'>推送地址</span>。
58+
5. Click `OK` to complete the configuration
59+
60+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-1.png" />
61+
62+
### Step 2: Use Notification Object in Alert Policy
63+
1. Login to your `Volcengine` console, find `Alert Manager` in the `Alert Policy` menu
64+
2. Click `Create Alert Policy` or edit the existing alert policy
65+
3. In the edit page, select the created `Flashduty` Endpoint
66+
4. Configure other settings as needed, and click `OK` to complete the configuration
67+
68+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-2.png" />
69+
70+
</dev>
71+
72+
## 二、Status Mapping
73+
74+
<div class="md-block">
75+
76+
| Detect | Flashduty | Status |
77+
| ---------- | -------- | ---- |
78+
| P0 | Critical | Critical|
79+
| P2 | Warning | Warning|
80+
81+
</div>
82+

‎flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.48 火山引擎云拨测集成指引.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
---
2+
title: "火山引擎云拨测告警事件"
3+
description: "通过 webhook 的方式同步 火山引擎云拨测的告警事件到 Flashduty，实现告警事件自动化降噪处理"
4+
date: "2024-07-05T10:00:00+08:00"
5+
url: "https://docs.flashcat.cloud/zh/flashduty/volcengine-detect-integration-guide"
6+
---
7+
8+
通过 webhook 的方式同步 火山引擎云拨测的告警事件到 Flashduty，实现告警事件自动化降噪处理。
9+
10+
<div class="hide">
11+
12+
## 在 Flashduty
13+
---
14+
您可通过以下2种方式，获取一个集成推送地址，任选其一即可。
15+
16+
### 使用专属集成
17+
18+
当您不需要将告警事件路由到不同的协作空间，优先选择此方式，更简单。
19+
20+
<details>
21+
<summary>展开</summary>
22+
23+
1. 进入 Flashduty 控制台，选择 **协作空间**，进入某个空间的详情页面
24+
2. 选择 **集成数据** tab，点击 **添加一个集成**，进入添加集成页面
25+
3. 选择 **火山引擎云拨测** 集成，点击 **保存**，生成卡片。
26+
4. 点击生成的卡片，可以查看到 **推送地址**，复制备用，完成。
27+
28+
29+
</details>
30+
31+
### 使用共享集成
32+
33+
当您需要根据告警事件的 Payload 信息，将告警路由到不同的协作空间，优先选择此方式。
34+
35+
<details>
36+
<summary>展开</summary>
37+
38+
1. 进入 Flashduty 控制台，选择 **集成中心=>告警事件**，进入集成选择页面。
39+
2. 选择 **火山引擎云拨测** 集成：
40+
- **集成名称**：为当前集成定义一个名称。
41+
3. 配置默认路由，并选择对应的协作空间（集成创建后可以前往 `路由` 进行更多路由规则的配置）。
42+
4. 点击 **保存** 后，复制当前页面的新生成的 **推送地址** 备用。
43+
5. 完成。
44+
45+
</details>
46+
</div>
47+
48+
## 在 火山引擎
49+
---
50+
51+
<div class="md-block">
52+
53+
## 一、告警推送配置
54+
55+
### 步骤1：创建通知对象
56+
57+
1. 登录您的 `火山引擎` 控制台，在 `告警管理` 菜单中，找到 `通知对象管理`。
58+
2. 点击 `系统集成`，点击`创建系统集成`或编辑已有的通知对象。
59+
3. 在编辑页面中，名称填写 `Flashduty` ，`回调 URL` 处填写告警集成的<span class='integration_url'>推送地址</span>。
60+
4. 点击 `确定` 完成配置。
61+
62+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-1.png" />
63+
64+
### 步骤2：在告警策略中使用通知对象
65+
66+
1. 登录您的 `火山引擎` 控制台，在 `告警管理` 菜单中，找到 `告警策略`。
67+
2. 点击`创建告警策略`或编辑已有的报警器。
68+
3. 在编辑页面中，`通知对象` 处选择创建的 `Flashduty` 通知对象。
69+
4. 其他按需配置即可，点击 `确定` 完成配置。
70+
71+
<img alt="drawing" width="600" src="https://download.flashcat.cloud/flashduty/doc/zh/fd/volcengine-2.png" />
72+
73+
74+
75+
</dev>
76+
77+
## 二、状态对照
78+
79+
<div class="md-block">
80+
81+
| 火山引擎 | Flashduty | 状态 |
82+
| ---------- | -------- | ---- |
83+
| 严重告警 | Critical | 严重 |
84+
| 普通告警 | Warning | 警告 |
85+
86+
</div>
87+

‎src/en.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ import Keep from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integrat
4747
import ElastAlert2 from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.45 ElastAlert2 Integration.md?raw";
4848
import DingtalkAlert from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.46 DingtalkAlert Integration.md?raw";
4949
import FeishuAlert from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.47 Feishu(Lark)Alert Integration.md?raw";
50-
50+
import VolcEngineDetect from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.48 Volcengine Detect Integration.md?raw";
5151
/** ⬆️⬆️⬆️⬆️ 告警集成 ⬆️⬆️⬆️⬆️ */
5252

5353
/** ⬇️⬇️⬇️⬇️ 变更事件 ⬇️⬇️⬇️⬇️ */
@@ -141,6 +141,7 @@ const docs = {
141141
ElastAlert2,
142142
DingtalkAlert,
143143
FeishuAlert,
144+
VolcEngineDetect,
144145
Link,
145146
ServiceNowSync,
146147
};

‎src/zh.ts‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ import Keep from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.
4747
import ElastAlert2 from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.45 ElastAlert2 集成指引.md?raw";
4848
import DingtalkAlert from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.46 钉钉告警集成指引.md?raw";
4949
import FeishuAlert from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.47 飞书 Lark 告警集成指引.md?raw";
50-
50+
import VolcEngineDetect from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.48 火山引擎云拨测告警集成指引.md?raw";
5151
/** ⬆️⬆️⬆️⬆️ 告警集成 ⬆️⬆️⬆️⬆️ */
5252

5353
/** ⬇️⬇️⬇️⬇️ 变更事件 ⬇️⬇️⬇️⬇️ */
@@ -139,6 +139,7 @@ const docs = {
139139
ElastAlert2,
140140
DingtalkAlert,
141141
FeishuAlert,
142+
VolcEngineDetect,
142143
Link,
143144
ServiceNowSync,
144145
};

0 commit comments

Comments
 (0)