Skip to content

Commit 185784e

Browse files
authored
Merge pull request #107 from flashcatcloud/test
update docs
2 parents 6a95c3b + 3126a8a commit 185784e

6 files changed

Lines changed: 224 additions & 3 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,10 @@ date: "2023-12-18T10:00:00+08:00"
7272
请你严格依照 @polish_instructions.md 的要求,对文档 @your_doc_name 进行润色。
7373
```
7474

75+
<<<<<<< HEAD
76+
完成润色后,可在 VSCode / Cursor 中打开文档,然后在文档 tab 页中右击,点击 `格式化文档`
77+
78+
=======
7579
完成润色后,可在 VSCode / Cursor 中打开文档,然后在文档 tab 页中右击,点击 `格式化文档`
7680

7781
- i18n

flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.52 WecomAlert Integration.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,88 @@ The system will generate a unique Wecom alert integration URL for you. This URL
5959

6060
By default, the system always creates new alerts for each message, but you can switch to these modes:
6161

62+
**Trigger or Close Alert Based on Rules**: In this mode, when receiving a new message, the system matches messages according to your rules and triggers new alerts or closes existing alerts based on the matching results.
63+
64+
- You need to fill in at least one **trigger** rule
65+
- You must set up regex extraction rules for Alert Key. The system uses this field to find historical alerts for updates or closure. **If regex extraction fails, the system will use the message title to generate an Alert Key** to ensure alerts won't be lost due to configuration errors
66+
- You can choose whether to discard messages when none of the rules match
67+
68+
Configuration example:
69+
70+
- Receive all messages, close the alert when the message content contains **RESOLVED**, otherwise trigger a new alert
71+
- Extract Alert Key from messages using the rule **/(.*)/**.
72+
73+
74+
### Notes
75+
- Wecom alert integration URL only supports Text and Markdown message types; other message types cannot be received
76+
- Flashduty will generate a default alert title: "Wecom robot Alert , If you need to change the title, you can customize it using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines)"
77+
78+
## Severity Mapping
79+
---
80+
81+
Currently, all alerts pushed to Flashduty through the Wecom integration are set to Warning severity. However, you can customize the severity using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines).
82+
83+
---
84+
title: "Wecom Alert Integration"
85+
description: "Generate a unique Wecom robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Wecom"
86+
date: "2025-05-19T10:00:00+08:00"
87+
url: "https://docs.flashcat.cloud/en/flashduty/Wecom-alert-integration-guide"
88+
---
89+
90+
Generate a unique Wecom robot address in Flashduty, and synchronize the occurrence and recovery of alerts through Wecom.
91+
92+
<div class="hide">
93+
94+
## Operation Steps
95+
---
96+
97+
### Create Wecom Alert Integration
98+
99+
You can obtain a Wecom alert integration address through either of these two methods:
100+
101+
#### Using Dedicated Integration
102+
103+
Choose this method when you don't need to route alert events to different channels. It's simpler and recommended.
104+
105+
<details>
106+
<summary>Expand</summary>
107+
108+
1. Go to the Flashduty console, select **Channel**, and enter a specific channel's details page
109+
2. Select the **Integration** tab, click **Add Integration** to enter the integration page
110+
3. Choose **Wecom Alert** integration and click **Save** to generate a card
111+
4. Click the generated card to view the **Wecom Alert Integration URL**, copy it for later use, and you're done
112+
113+
</details>
114+
115+
#### Using Shared Integration
116+
117+
Choose this method when you need to route alerts to different channels based on the alert event's payload information.
118+
119+
<details>
120+
<summary>Expand</summary>
121+
122+
1. Go to the Flashduty console, select **Integration Center => Alert Events** to enter the integration selection page
123+
2. Select **Wecom Alert** integration:
124+
- **Integration Name**: Define a name for the current integration
125+
- **Message Type**: Select Wecom alert message type, currently only Text and Markdown are supported
126+
- **Push Mode**: Choose when to trigger or recover alerts for Wecom notifications
127+
3. Copy the **Wecom Alert Integration URL** for later use
128+
4. Configure the default route and select the corresponding channel (after integration creation, you can go to `Routes` to configure more routing rules)
129+
5. Done
130+
131+
</details>
132+
</div>
133+
134+
### Customize Wecom Alert Integration
135+
136+
#### Wecom Alert Integration URL
137+
138+
The system will generate a unique Wecom alert integration URL for you. This URL is compatible with Wecom robot message protocol. When platforms only support Wecom robot channels, you can use this URL to receive corresponding messages.
139+
140+
#### Push Mode
141+
142+
By default, the system always creates new alerts for each message, but you can switch to these modes:
143+
62144
**Trigger or Close Alert Based on Rules**: In this mode, when receiving a new message, the system matches messages according to your rules and triggers new alerts or closes existing alerts based on the matching results.
63145

64146
- You need to fill in at least one **trigger** rule
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: "Harbor Alert Events"
3+
description: "Sync Harbor 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 Harbor 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 **Harbor** 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 **Harbor** 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 Harbor
48+
---
49+
50+
### Configure Webhooks
51+
52+
1. Log in to the Harbor interface with an account that has at least project administrator privileges.
53+
2. Go to `Projects`, select a project, and select `Webhooks`.
54+
3. Select notify type `HTTP`, so the webhook will be send to a HTTP endpoint.
55+
4. Select payload format as `Default or CloudEvents` when choose the HTTP notify type.
56+
5. Select events that you want to subscribe.
57+
6. Enter the alert integration's <span class='integration_url'>PUSH URL</span> in the Endpoint URL field.
58+
7. Click Add to create the webhook.
59+
60+
## Severity Mapping
61+
---
62+
63+
Currently, all alerts pushed to Flashduty through the Harbor integration are set to Warning severity. However, you can customize the severity using the [alert pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines).
64+
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: "Harbor 告警集成"
3+
description: "通过 webhook 的方式同步 Harbor 的告警事件到 Flashduty,实现告警事件自动化降噪处理"
4+
date: "2025-05-19T10:00:00+08:00"
5+
url: "https://docs.flashcat.cloud/zh/flashduty/harboe-integration-guide"
6+
---
7+
8+
通过 webhook 的方式同步 Harbor 的告警事件到 Flashduty,实现告警事件自动化降噪处理。
9+
10+
<div class="hide">
11+
12+
## 在 Flashduty
13+
---
14+
15+
### 创建 Harbor 告警集成
16+
17+
您可通过以下2种方式,获取一个企微机器人告警集成地址,任选其一即可。
18+
19+
#### 使用专属集成
20+
21+
当您不需要将告警事件路由到不同的协作空间,优先选择此方式,更简单。
22+
23+
<details>
24+
<summary>展开</summary>
25+
26+
1. 进入 Flashduty 控制台,选择 **协作空间**,进入某个空间的详情页面
27+
2. 选择 **集成数据** tab,点击 **添加一个集成**,进入添加集成页面
28+
3. 选择 **Harbor** 集成,点击 **保存**,生成卡片。
29+
4. 点击生成的卡片,可以查看到 **Harbor 告警集成地址**,复制备用,完成。
30+
31+
</details>
32+
33+
#### 使用共享集成
34+
35+
当您需要根据告警事件的 Payload 信息,将告警路由到不同的协作空间,优先选择此方式。
36+
37+
<details>
38+
<summary>展开</summary>
39+
40+
1. 进入 Flashduty 控制台,选择 **集成中心=>告警事件**,进入集成选择页面。
41+
2. 选择 **Harbor** 集成:
42+
- **集成名称**:为当前集成定义一个名称。
43+
- **推送模式**:选择企微告警在何种情况下触发或恢复告警。
44+
3. 复制当前页面的 **Harbor 告警集成地址** 备用。
45+
4. 配置默认路由,并选择对应的协作空间(集成创建后可以前往 `路由` 进行更多路由规则的配置)。
46+
5. 完成。
47+
48+
</details>
49+
50+
## 在 Harbor
51+
---
52+
</div>
53+
54+
55+
### 配置 Webhook 通道
56+
57+
1. 使用至少具有项目管理员权限的帐户登录 Harbor 界面。
58+
2. 转到`项目`,选择一个项目,然后选择 `Webhook`
59+
3. 选择通知类型 `HTTP`,以便 webhook 将发送到 HTTP 端点。
60+
4. 当选择 HTTP 通知类型时,选择有效负载格式为 `Default 或 CloudEvents`
61+
5. 选择您要`订阅的事件`
62+
6. `Endpoint URL` 输入告警集成的<span class='integration_url'>推送地址</span>。
63+
7. 单击 添加 以创建 webhook。
64+
65+
## 严重程度映射关系
66+
---
67+
68+
当前 Harbor 告警集成推送到 Flashduty 的严重程度均为 Warning,但您可以通过[告警处理 Pipeline](https://docs.flashcat.cloud/zh/flashduty/alert-pipelines) 来自定义严重程度。

src/en.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ import Monit from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integra
5252
import Rum from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.50 RUM Alert Integration.md?raw";
5353
import Cloudflare from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.51 Cloudflare Integration.md?raw";
5454
import WecomAlert from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.52 WecomAlert Integration.md?raw";
55-
55+
import Harbor from "../flashduty/en/1. On-call/8. Integrations/8.1 Alerts integration/8.1.53 Harbor Alert Integration.md?raw";
5656
/** ⬆️⬆️⬆️⬆️ 告警集成 ⬆️⬆️⬆️⬆️ */
5757

5858
/** ⬇️⬇️⬇️⬇️ 变更事件 ⬇️⬇️⬇️⬇️ */
@@ -154,6 +154,7 @@ const docs = {
154154
Rum,
155155
Cloudflare,
156156
WecomAlert,
157-
ServiceDeskPlusSync
157+
ServiceDeskPlusSync,
158+
Harbor
158159
};
159160
export default docs;

src/zh.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ import Monit from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8
5252
import Rum from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.50 RUM 告警集成指引.md?raw";
5353
import Cloudflare from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.51 Cloudflare 集成指引.md?raw";
5454
import WecomAlert from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.52 企微告警集成指引.md?raw";
55+
import Harbor from "../flashduty/zh/1. On-call/5. 集成引导/8.1 告警集成/8.1.53 Harbor 告警集成指引.md?raw";
5556
/** ⬆️⬆️⬆️⬆️ 告警集成 ⬆️⬆️⬆️⬆️ */
5657

5758
/** ⬇️⬇️⬇️⬇️ 变更事件 ⬇️⬇️⬇️⬇️ */
@@ -151,6 +152,7 @@ const docs = {
151152
Rum,
152153
Cloudflare,
153154
WecomAlert,
154-
ServiceDeskPlusSync
155+
ServiceDeskPlusSync,
156+
Harbor
155157
};
156158
export default docs;

0 commit comments

Comments
 (0)