Skip to content

Commit cb5778f

Browse files
committed
Merge branch 'main' of github.com:flashcatcloud/flashduty-docs
2 parents 3351d02 + 2828e3a commit cb5778f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+438
-114
lines changed

docs.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,12 @@
422422
"zh/monitors/alert-rules/victorialogs"
423423
]
424424
},
425+
{
426+
"group": "活跃告警",
427+
"pages": [
428+
"zh/monitors/alert-rules/active-alerts"
429+
]
430+
},
425431
{
426432
"group": "规则仓库",
427433
"pages": [
@@ -847,6 +853,12 @@
847853
"en/monitors/alert-rules/victorialogs"
848854
]
849855
},
856+
{
857+
"group": "Active Alerts",
858+
"pages": [
859+
"en/monitors/alert-rules/active-alerts"
860+
]
861+
},
850862
{
851863
"group": "Rule Repository",
852864
"pages": [

en/developer/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Visit the [API documentation](https://developer-en.flashcat.cloud/en/flashduty/o
3636

3737
## MCP Server
3838

39-
The Flashduty MCP Server implements the [Model Context Protocol](https://modelcontextprotocol.io/), providing AI tools with 16 tools across 6 functional modules:
39+
The Flashduty MCP Server implements the [Model Context Protocol](https://modelcontextprotocol.io/), providing AI tools with 18 tools across 6 functional modules:
4040

4141
| Module | Tools | Capabilities |
4242
|--------|-------|-------------|
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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, title, 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+
| **Job** | The job label value carried by the alert |
24+
| **Instance** | The instance label value carried by the alert |
25+
| **Last updated** | The most recent time this alert was updated |
26+
| **Hash** | The unique identifier hash of the alert |
27+
| **Extra labels** | Other additional label information carried by the alert |
28+
29+
## Filtering and searching
30+
31+
The conditions bar at the top of the page helps you quickly locate the alerts you care about:
32+
33+
- **Severity**: Filter by Critical, Warning, or Info
34+
- **Title**: Filter by the title of the alert event
35+
- **Hash**: Filter by the unique identifier hash of the alert
36+
- **Job**: Filter by the job label value
37+
- **Instance**: Filter by the instance label value
38+
- **Extra labels**: Filter by other additional labels
39+
40+
All filter conditions use an "AND" relationship — only alerts matching all conditions are displayed.
41+
42+
## Customizing columns
43+
44+
Click the column configuration button in the upper-right corner of the list to:
45+
46+
- **Show/hide columns**: Check or uncheck columns to control which ones are displayed
47+
- **Reorder columns**: Drag and drop to adjust the display order of columns
48+
49+
The system remembers your column display preferences and automatically applies them on your next visit.
50+
51+
<Tip>
52+
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.
53+
</Tip>
54+
55+
## Deleting alerts
56+
57+
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:
58+
59+
<Steps>
60+
<Step title="Select alerts">
61+
Check the alerts you want to delete in the list. Multiple selection is supported.
62+
</Step>
63+
<Step title="Confirm deletion">
64+
Click the batch delete button. After confirmation, the selected alerts will be removed from the active alerts list.
65+
</Step>
66+
</Steps>
67+
68+
<Warning>
69+
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.
70+
</Warning>

en/monitors/faq/faq.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ The overview page provides a global view of alert rules, consisting of the follo
2929
|------|-------------|
3030
| **Alert rule total trend** | An area chart showing how the total number of alert rules changes over time. The x-axis represents dates and the y-axis represents rule count, helping you track overall growth or reduction trends |
3131
| **Alert rules by channel** | A pie chart showing the distribution of alert rules across channels. The top 10 channels are displayed by default; the remainder are aggregated as "Others." You can click to expand and view all details |
32-
| **Triggered rules by top-level group** | Shows the health status of alert rules by top-level group. Each group displays as a card with a "normal/total" ratio and progress bar. Green indicates all normal; red indicates rules currently triggered. Click a card to jump to that group's rule list |
3332
| **System event list** | Displays system events generated by the alert engine (such as engine disconnection, configuration anomalies, etc.), with pagination and delete support, helping you promptly discover and address infrastructure-level issues |
3433

3534
<Tip>

en/monitors/quickstart/quickstart.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,10 @@ If you need stable rule bindings that are unaffected by data source renames, pre
9595

9696
Configure how to query data sources and how to evaluate alert conditions. Please read the usage instructions on the right side of **Query Detection Method** on the page.
9797

98+
| Config Item | Description |
99+
|--------|------|
100+
| **Query Offset** | Sets the query time offset (in seconds) to handle data source ingestion lag. For example, setting it to 60 shifts the query window back by 60 seconds, ensuring data has been fully written before querying |
101+
98102
### Detection Frequency and Effective Time
99103

100104
![Detection frequency & effective time](https://docs-cdn.flashcat.cloud/imges/mon/0980d71a653985a1706243fc6795685e.png)

en/on-call/channel/escalation-rule.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ src="https://download.flashcat.cloud/flashduty/video/escalate-rule.mp4"
2020

2121
An escalation rule contains four core elements. The system matches rules from top to bottom, **stopping after the first successful match**.
2222

23+
You can enable or disable individual escalation rules. Disabled rules are skipped during matching and will not trigger notifications. You can also copy an escalation rule to the current channel or another channel to quickly reuse existing configurations.
24+
2325
### 1. Trigger Conditions
2426

2527
Determines which incidents trigger the current rule.
@@ -88,8 +90,8 @@ In each escalation level, you can enable the **Loop Notification** feature. When
8890

8991
**Escalation Conditions**:
9092

91-
- **Timeout without acknowledgment**: No one acknowledges within N minutes after incident trigger
92-
- **Timeout without closure**: Incident not resolved within N minutes after trigger
93+
- **Not closed**: Incident not closed within N minutes after trigger
94+
- **Not closed and not acknowledged**: Incident neither closed nor acknowledged within N minutes after trigger
9395

9496
The minimum escalation timeout is 1 minute.
9597

en/on-call/channel/noise-reduction.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Flashduty On-call provides two grouping modes:
104104
| **Aggregation Window** | Optional toggle. When disabled, new alerts continue merging into the incident until the incident is closed. When enabled, alerts within the window are merged; alerts arriving after the window expires are grouped into a new incident |
105105
| **Window Timing Start** | Only configurable when the aggregation window is enabled. **Incident trigger** (default): Fixed timer starts from incident creation, stops grouping when the window duration is reached. **Alert merges into incident**: Timer resets each time a new alert merges in, the window recalculates from the last merge |
106106
| **Window Duration** | Only configurable when the aggregation window is enabled. Set the duration of the aggregation window |
107-
| **Alert Storm Warning** | When merged alert count reaches the configured threshold, the system records an alert storm event in the incident timeline and triggers a warning notification, prompting urgent handling |
107+
| **Alert Storm Warning** | When merged alert count reaches a configured threshold, the system records an alert storm event in the incident timeline and triggers a warning notification, prompting urgent handling. You can configure up to 5 thresholds, each ranging from 2 to 10,000 |
108108
| **Strict Grouping** | When enabled, empty label values are treated as different; when disabled, empty values are treated as the same (not supported for intelligent grouping) |
109109

110110
<Tabs>
@@ -234,6 +234,7 @@ Define which alerts should be silenced, supports multiple condition combinations
234234
| **Severity** | Match by alert level | Only silence `Info` level |
235235
| **Title** | Match by alert title keywords | Title contains "Planned Maintenance" |
236236
| **Description** | Match by alert description content | Description contains "restart" |
237+
| **Integration** | Match by alert integration source | Only silence alerts from a specific integration |
237238
| **Labels** | Match by label key-value pairs | `host=db-master-01` |
238239

239240
**Combination Logic**:

en/on-call/configuration/schedule.mdx

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Understanding these concepts before configuration will help you better plan your
2929
| **Override** | Temporarily adjust the on-call person for a specific time period without modifying permanent rules (commonly used for leave, temporary coverage) |
3030
| **Date Mask** | Select which days to participate in on-call, e.g., Team A on-call Monday to Friday, Team B on weekends |
3131
| **Continuous Rotation** | When enabled, rotation boundaries are calculated based on shift start time, preventing shifts from being split at 00:00. Only supported when date mask is configured. See [Date mask and continuous rotation](#date-mask-and-continuous-rotation) for details |
32+
| **Fair Rotation** | The system automatically adjusts rotation order to ensure each member gets opportunities in different time periods, preventing someone from always being on-call during weekends |
3233

3334
![Schedule Concepts](https://docs-cdn.flashcat.cloud/images/png/3423a4f3133d5caa1f0aaebca970d404.png)
3435

@@ -39,20 +40,39 @@ Understanding these concepts before configuration will help you better plan your
3940
<Steps>
4041
<Step title="Create a Schedule">
4142
Go to **Schedule Management**, click "Create Schedule"
43+
- **Schedule Name**: 1–40 characters, must be unique within the account
44+
- **Owning Team**: Specifies which team manages this schedule; team members gain edit permissions for this schedule
4245
- **Schedule Description**: Supports Markdown syntax, content can be included in notifications
43-
- **Owning Team**: Specifies which team manages this schedule, not the on-call personnel
4446
</Step>
45-
<Step title="Set Notification Reminders">
46-
To prevent forgetting shifts or handoffs, the system provides two reminder types:
47-
- **Handoff Notification**: N minutes before rotation (e.g., 15 minutes ahead), notifies both the outgoing and incoming personnel
48-
- **On-duty Notification**: During on-call periods, sends a daily notification at a fixed time (e.g., 9:00 AM) reminding who's currently on-call
49-
- **Channels**: Supports email, SMS, phone, IM (Feishu/Lark, Dingtalk, WeCom)
47+
<Step title="Set Shift Notifications">
48+
To prevent forgetting shifts or handoffs, the system provides two notification triggers:
49+
- **Advance Notification**: Notifies both outgoing and incoming personnel N minutes before handoff (in 5-minute increments)
50+
- **Scheduled Notification**: Sends a daily notification at a fixed time (e.g., 8:00 AM) reminding who is currently on-call
51+
52+
After enabling either notification trigger, you need to configure notification channels:
53+
54+
- **Personal Channels**: Send notifications directly to on-call personnel
55+
- **Follow personal preference**: Each responder receives notifications via their personally configured channels
56+
- **Follow unified settings**: Administrators select notification channels (SMS, email, and integrated IM apps)
57+
- **Group Chat Channels**: Send notifications to group chats, supporting the following platforms:
58+
- Feishu app, DingTalk app, Slack app (select chat groups via integrated IM apps)
59+
- WeCom bot, DingTalk bot, Feishu bot (send via webhook URL)
60+
- Slack bot, Telegram bot, Zoom bot
5061
</Step>
5162
<Step title="Define On-call Rules">
5263
This is the core step. You can add one or more layers of rules. Each layer includes:
53-
- **On-call Personnel**: Select members participating in rotation
54-
- **Rotation Cycle**: Supports day, week, custom duration
55-
- **Time Restriction**: (Optional) This rule only takes effect during specific time periods
64+
65+
- **On-call Personnel**: Select members participating in rotation, supports grouping and primary/backup roles
66+
- **Rotation Cycle**: Supports four units — hour, day, week, and month — with values from 1 to 30. For example, "2 days" means rotation every 2 days
67+
- **Handoff Time**: When the rotation cycle is 1 week, you can specify the day and time for handoff
68+
- **Fair Rotation**: When enabled, the system automatically adjusts rotation order to prevent someone from always being on-call during weekends
69+
- **Date Mask**: Select which days of the week to schedule on-call. See [Date mask and continuous rotation](#date-mask-and-continuous-rotation) for details
70+
- **Time Restriction**: (Optional) Restrict actual on-call hours within each rotation cycle, with the following modes:
71+
- **No restriction**: Members are on-call for the entire rotation cycle
72+
- **Daily**: Set daily on-call time ranges (e.g., 09:00–18:00), multiple periods can be added
73+
- **Weekly**: Set day+time on-call ranges (e.g., Monday 09:00 – Friday 18:00), multiple periods can be added
74+
75+
<Note>When date mask is enabled, the "Weekly" restriction mode is unavailable since the date mask already provides day-of-week control. After setting time restrictions, there may be gaps with no one on-call — ensure other rules provide coverage.</Note>
5676
</Step>
5777
</Steps>
5878

@@ -162,6 +182,17 @@ Consider enabling continuous rotation in the following scenarios:
162182
</Tab>
163183
</Tabs>
164184

185+
## View schedule details
186+
187+
---
188+
189+
Click a schedule name to enter the detail page, where you can view the scheduling calendar and manage on-call rules. The upper right corner provides these options:
190+
191+
- **View switcher**: Toggle between "Week", "Two Weeks", and "Calendar" (month view)
192+
- **Highlight my shifts**: When enabled, your on-call shifts are highlighted for quick identification
193+
194+
Click any time slot in the calendar to view the current responders or create an override.
195+
165196
## View Personal Schedule
166197

167198
---

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

Lines changed: 2 additions & 2 deletions
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 |
@@ -137,7 +137,7 @@ The incident details page supports one-click AI summary generation to help you q
137137
- **Impacts**: Key affected resources such as services, systems, environments, and instances
138138
- **Actions**: Immediately actionable investigation and remediation steps (up to 3)
139139

140-
You can choose from different AI models (default is DeepSeek V3) and regenerate as needed. The generated summary supports real-time streaming output and can be saved as the incident description.
140+
You can choose from different AI models (default is DeepSeek V3; DeepSeek R1 is also available for deep thinking and reasoning capabilities) and regenerate as needed. The generated summary supports real-time streaming output and can be saved as the incident description.
141141

142142
<Tip>
143143
AI Summary is only available for incidents automatically triggered by alerts. Manually created incidents do not support this feature.

en/on-call/integration/alert-integration/alert-pipelines.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,10 @@ Pipeline's inhibition feature is similar to channel inhibit rules, both supporti
114114
When an entire datacenter loses network, all alerts from that datacenter (regardless of business line) should be inhibited. Configuring one rule at the integration layer is much more efficient than configuring separately in dozens of channels.
115115
</Tip>
116116

117+
<Note>
118+
Inhibition only matches source alerts that have been active within the last 10 minutes (600 seconds). If a source alert was triggered more than 10 minutes ago and has not been updated since, it will not be used for inhibition matching. Ensure your source alerts remain active within this time window.
119+
</Note>
120+
117121
## Reference Historical Data
118122

119123
When editing alert processing rules, the right side of the page provides a **Related Alerts** panel showing historical alert data ingested through the current integration. You can write processing rules while referencing actual alert content, ensuring that condition expressions and action configurations meet expectations.

0 commit comments

Comments
 (0)