Skip to content

Commit 43609a2

Browse files
ysyneuysyneu
authored
Merge pull request #36 from flashcatcloud/doc-review/2026-03-28-100000
docs: enhance docs with active alerts, SSO external members, and more
2 parents 7fc4630 + fa4f395 commit 43609a2

11 files changed

Lines changed: 178 additions & 2 deletions

File tree

‎docs.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,12 @@
421421
"zh/monitors/alert-rules/victorialogs"
422422
]
423423
},
424+
{
425+
"group": "活跃告警",
426+
"pages": [
427+
"zh/monitors/alert-rules/active-alerts"
428+
]
429+
},
424430
{
425431
"group": "规则仓库",
426432
"pages": [
@@ -845,6 +851,12 @@
845851
"en/monitors/alert-rules/victorialogs"
846852
]
847853
},
854+
{
855+
"group": "Active Alerts",
856+
"pages": [
857+
"en/monitors/alert-rules/active-alerts"
858+
]
859+
},
848860
{
849861
"group": "Rule Repository",
850862
"pages": [

‎en/monitors/alert-rules/active-alerts.mdx‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "Active alerts"
3+
description: "View all currently firing alerts to quickly understand your system's overall alert status"
4+
keywords: ["active alerts", "alert rule", "alert list", "severity", "labels"]
5+
---
6+
7+
The active alerts page provides a consolidated view of all currently firing alerts, helping you quickly understand the overall alert status of your system. You can filter and browse by severity, folder, alert rule, labels, and more.
8+
9+
<Note>
10+
The active alerts feature requires monit-edge version >= v0.36.0. Please ensure you have upgraded to this version or later. If you have not installed it yet, go to the [alert engine management](/en/monitors/engine/engine) page to complete the deployment.
11+
</Note>
12+
13+
## Viewing active alerts
14+
15+
**Menu entry**: Select a folder, then switch to the "Active Alerts" tab
16+
17+
The active alerts list displays currently firing alerts in a table format. Default columns include:
18+
19+
| Column | Description |
20+
|--------|-------------|
21+
| **Severity** | The severity level of the alert: Critical, Warning, or Info |
22+
| **Title** | The title of the alert event |
23+
| **Alert rule** | The name of the alert rule that produced this alert |
24+
| **Labels** | Label information carried by the alert, such as job, instance, etc. |
25+
| **Last triggered** | The most recent time this alert was triggered |
26+
27+
## Filtering and searching
28+
29+
The conditions bar at the top of the page helps you quickly locate the alerts you care about:
30+
31+
- **Severity**: Filter by Critical, Warning, or Info
32+
- **Folder**: Filter by the folder that the alert rule belongs to
33+
- **Alert rule**: Filter by a specific alert rule
34+
- **Labels**: Filter by alert label key-value pairs
35+
36+
All filter conditions use an "AND" relationship — only alerts matching all conditions are displayed.
37+
38+
## Customizing columns
39+
40+
Click the column configuration button in the upper-right corner of the list to:
41+
42+
- **Show/hide columns**: Check or uncheck columns to control which ones are displayed
43+
- **Reorder columns**: Drag and drop to adjust the display order of columns
44+
45+
The system remembers your column display preferences and automatically applies them on your next visit.
46+
47+
<Tip>
48+
When you add a label-type column, the corresponding label filter automatically appears in the conditions bar, making it easy to quickly filter by that label.
49+
</Tip>
50+
51+
## Deleting alerts
52+
53+
If certain active alerts no longer need attention (for example, the alert rule has been adjusted but old alerts have not yet automatically recovered), you can manually delete them:
54+
55+
<Steps>
56+
<Step title="Select alerts">
57+
Check the alerts you want to delete in the list. Multiple selection is supported.
58+
</Step>
59+
<Step title="Confirm deletion">
60+
Click the batch delete button. After confirmation, the selected alerts will be removed from the active alerts list.
61+
</Step>
62+
</Steps>
63+
64+
<Warning>
65+
Deletion only removes the alert from the active alerts list. If the alert condition is still met, the alert will reappear the next time the alert engine runs its check.
66+
</Warning>

‎en/on-call/incident/search-view-incident.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Incident details is the main entry point for investigating incidents, displaying
8383
| # | Area | Description |
8484
| :---: | :--- | :--- |
8585
| 1 | Key Information | Incident title, severity, processing progress, ID number |
86-
| 2 | Action Area | Various high-frequency action buttons; more actions include custom actions and low-frequency buttons; War Room creation requires enabling [War Room](/en/on-call/advanced/war-room) in IM integration |
86+
| 2 | Action Area | Various high-frequency action buttons; more actions include custom actions and low-frequency buttons; War Room creation requires enabling [War Room](/en/on-call/advanced/war-room) in IM integration. The snooze button supports customizable duration presets — you can access settings from the snooze dropdown to configure 3 preset durations (in hours or minutes), defaulting to 2 hours, 4 hours, and 12 hours |
8787
| 3 | Details | Incident description, label info, and AI Summary (see below for details); labels support drag-to-sort and JSON view display |
8888
| 4 | Associated Alerts | All [grouped](/en/on-call/channel/noise-reduction) alerts associated with the incident, supports filtering by progress and view switching |
8989
| 5 | Comprehensive Info | Shows incident attributes, processing status, [images](https://developer.flashcat.cloud/api-344943718), and responder info |

‎en/on-call/integration/alert-integration/routing-rules.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ When using name mapping mode, if corresponding channel doesn't exist, delivers t
5151
| Filter Rules | Filter by channel to quickly locate all rules delivering to a specific channel, ideal for scenarios with many rules |
5252
| Edit History | View historical configuration versions, compare differences, and quickly restore (see details below) |
5353
| Route Preview | After editing routing rules, click the preview button and select up to 20 real alerts to see how the modified rules would route each alert. The system displays routing differences between old and new rules, including added, removed, and unchanged channels |
54+
| Copy Rules | Click the copy button to copy routing rules from another integration to the current one. Three modes are supported: **Prepend** (insert copied rules before existing ones), **Append** (add copied rules after existing ones), and **Replace** (replace all existing rules with copied ones) |
5455

5556
### Edit History
5657

‎en/on-call/statuspage/publish-events.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ Each timeline update can include:
9898

9999
<Tip>
100100
For maintenance events in "Scheduled" status, you can add timeline updates with timestamps earlier than the planned start time to record preparatory notes or pre-start context. Additionally, when you edit the first timeline update's timestamp to an earlier value, the system automatically adjusts the event's start time to match, ensuring timeline consistency.
101+
102+
For incident events and maintenance events in other statuses, the timeline update timestamp must be after the event start time.
101103
</Tip>
102104

103105
### Close an event

‎en/platform/configure-sso.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,19 @@ When using the LDAP protocol, you can automatically synchronize Flashduty roles
120120
- The Group DN in mapping rules must be the full path of the Group in LDAP
121121
</Note>
122122

123+
## External member management
124+
125+
---
126+
127+
When you enable single sign-on, members automatically created through their first SSO login are marked as **external members**. You can enable the **Prevent editing external members** option in SSO settings (disabled by default). When enabled, these external members become read-only in Flashduty — you cannot modify their roles or delete them in Flashduty. All member management must be done through the identity provider.
128+
129+
This feature is ideal for organizations that need to centrally manage user permissions in the identity provider, ensuring member information in Flashduty always stays in sync.
130+
131+
<Note>
132+
- This option only affects external members created via SSO; manually invited members are not affected
133+
- If the SSO configuration is deleted, existing external members remain read-only by default
134+
</Note>
135+
123136
## Login Domain Management
124137

125138
---

‎zh/monitors/alert-rules/active-alerts.mdx‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: "活跃告警"
3+
description: "查看当前正在触发的所有告警，快速了解系统整体告警状态"
4+
keywords: ["活跃告警", "告警规则", "告警列表", "严重程度", "标签"]
5+
---
6+
7+
活跃告警页面汇总展示当前所有正在触发的告警，帮助您快速了解系统的整体告警状态。您可以按严重程度、文件夹、告警规则、标签等维度进行筛选和查看。
8+
9+
<Note>
10+
活跃告警功能依赖 monit-edge 版本 >= v0.36.0，请确保您已升级至该版本或以上。如尚未安装，请前往[告警引擎管理](/zh/monitors/engine/engine)页面完成部署。
11+
</Note>
12+
13+
## 查看活跃告警
14+
15+
**菜单入口**：选择一个文件夹后，切换到「活跃告警」标签页
16+
17+
活跃告警列表以表格形式展示当前正在触发的告警，默认列包括：
18+
19+
| 列名 | 说明 |
20+
|------|------|
21+
| **严重程度** | 告警的严重级别，包括 Critical（严重）、Warning（一般）、Info（轻微） |
22+
| **标题** | 告警事件的标题 |
23+
| **告警规则** | 产生该告警的告警规则名称 |
24+
| **标签** | 告警携带的标签信息，如 job、instance 等 |
25+
| **最近触发时间** | 该告警最近一次触发的时间 |
26+
27+
## 筛选与搜索
28+
29+
页面顶部提供筛选条件栏，帮助您快速定位关注的告警：
30+
31+
- **严重程度**：按 Critical、Warning、Info 筛选
32+
- **文件夹**：按告警规则所属的文件夹筛选
33+
- **告警规则**：按具体的告警规则筛选
34+
- **标签**：按告警携带的标签键值对筛选
35+
36+
各筛选条件之间为"与"的关系，同时满足所有条件的告警才会被展示。
37+
38+
## 自定义列
39+
40+
点击列表右上角的列配置按钮，您可以：
41+
42+
- **显示/隐藏列**：勾选或取消勾选需要展示的列
43+
- **调整列顺序**：拖拽调整各列的显示顺序
44+
45+
系统会记住您的列显示偏好，下次访问时自动应用。
46+
47+
<Tip>
48+
当您添加标签类型的列时，对应的标签筛选条件也会自动出现在条件栏中，方便您快速过滤。
49+
</Tip>
50+
51+
## 删除告警
52+
53+
如果某些活跃告警已不再需要关注（例如告警规则已调整但旧告警尚未自动恢复），您可以手动删除：
54+
55+
<Steps>
56+
<Step title="选择告警">
57+
在列表中勾选需要删除的告警，支持多选。
58+
</Step>
59+
<Step title="确认删除">
60+
点击批量删除按钮，确认后所选告警将从活跃告警列表中移除。
61+
</Step>
62+
</Steps>
63+
64+
<Warning>
65+
删除操作仅将告警从活跃告警列表中移除。如果告警条件仍然满足，下次告警引擎执行检查时，该告警会重新出现。
66+
</Warning>

‎zh/on-call/incident/search-view-incident.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Flashduty On-call 提供各种维度的筛选能力，并给您足够多的灵
8484
| 序号 | 区域 | 说明 |
8585
| :---: | :--- | :--- |
8686
| 1 | 关键信息 | 故障的标题、严重程度、处理进度、ID 编号 |
87-
| 2 | 操作区域 | 各类高频操作按钮，在更多操作中，包含了自定义操作和低频操作按钮，其中创建作战室需要在 IM 集成中开启[作战室](/zh/on-call/advanced/war-room) |
87+
| 2 | 操作区域 | 各类高频操作按钮，在更多操作中，包含了自定义操作和低频操作按钮，其中创建作战室需要在 IM 集成中开启[作战室](/zh/on-call/advanced/war-room)。暂缓按钮支持自定义快捷时长预设，您可以在暂缓下拉菜单中进入设置，配置 3 个预设时长（支持小时或分钟），默认为 2 小时、4 小时和 12 小时 |
8888
| 3 | 详细信息 | 故障的描述、标签信息和 AI 总结（详见下方说明），标签内容支持拖拽排序和以 JSON 视图展示 |
8989
| 4 | 关联告警 | 故障所关联的所有被[聚合](/zh/on-call/channel/noise-reduction)的告警，支持按处理进度筛选，以及支持视图切换 |
9090
| 5 | 综合信息 | 展示该故障的属性、处理状态、[图片](https://developer.flashcat.cloud/api-344943718)以及处理人员信息 |

‎zh/on-call/integration/alert-integration/routing-rules.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ keywords: ["路由规则", "告警路由", "分发策略", "协作空间", "分
5252
| 筛选规则 | 按协作空间筛选，快速定位投递到某个空间的所有规则，适合规则数量较多的场景 |
5353
| 编辑历史 | 查看历史配置版本，对比差异并快速恢复（详见下方说明） |
5454
| 路由预览 | 编辑路由规则后，点击预览按钮，选择最多 20 条真实告警，查看修改后的路由匹配结果。系统将展示每条告警在新旧规则下的路由差异，包括新增、移除和不变的协作空间 |
55+
| 复制规则 | 点击复制按钮，从其他集成中复制路由规则到当前集成。支持三种模式：**前置添加**（在现有规则前插入）、**追加**（在现有规则后追加）和 **覆盖**（替换全部现有规则） |
5556

5657
### 编辑历史
5758

‎zh/on-call/statuspage/publish-events.mdx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ description: "了解如何在状态页中发布故障和维护事件，管理事
9898

9999
<Tip>
100100
对于处于"已计划"状态的维护事件，你可以添加时间戳早于计划开始时间的时间线更新，用于记录准备工作或前置说明。此外，当你将第一条时间线更新的时间戳修改为更早的值时，系统会自动将事件的开始时间调整为该时间戳，以确保时间线的一致性。
101+
102+
对于故障事件以及其他状态的维护事件，时间线更新的时间戳必须晚于事件的开始时间。
101103
</Tip>
102104

103105
### 关闭事件

0 commit comments

Comments
 (0)