Skip to content

Commit ba3f02f

Browse files
authored
Merge pull request #24 from flashcatcloud/doc-review/2026-03-17-194121
docs: comprehensive coverage audit fixes across all modules
2 parents b5b2053 + 2bb6b76 commit ba3f02f

41 files changed

Lines changed: 761 additions & 73 deletions

Some content is hidden

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

docs.json

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,9 @@
218218
"zh/on-call/integration/instant-messaging/wecom",
219219
"zh/on-call/integration/instant-messaging/dingtalk",
220220
"zh/on-call/integration/instant-messaging/slack",
221-
"zh/on-call/integration/instant-messaging/microsoft-teams"
221+
"zh/on-call/integration/instant-messaging/microsoft-teams",
222+
"zh/on-call/integration/instant-messaging/telegram",
223+
"zh/on-call/integration/instant-messaging/zoom"
222224
]
223225
},
224226
{
@@ -622,7 +624,9 @@
622624
"en/on-call/integration/instant-messaging/wecom",
623625
"en/on-call/integration/instant-messaging/dingtalk",
624626
"en/on-call/integration/instant-messaging/slack",
625-
"en/on-call/integration/instant-messaging/microsoft-teams"
627+
"en/on-call/integration/instant-messaging/microsoft-teams",
628+
"en/on-call/integration/instant-messaging/telegram",
629+
"en/on-call/integration/instant-messaging/zoom"
626630
]
627631
},
628632
{

en/monitors/engine/engine.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,13 @@ API Keys are used for authentication between the alert engine and the SaaS. You
7575
| **Rename** | Click the Key name to edit and rename it |
7676
| **Delete** | Delete unused API Keys; requires the API Key delete permission |
7777

78+
The management panel also displays the current status of each API Key:
79+
80+
| Status | Description |
81+
|--------|-------------|
82+
| **Enabled** (green icon) | The API Key is active; engine instances can use it to communicate with the SaaS |
83+
| **Disabled** (yellow icon) | The API Key has been disabled; engine instances using it will be unable to communicate with the SaaS |
84+
7885
<Warning>
7986
After deleting an API Key, all engine instances using that Key will be unable to communicate with the SaaS. Ensure you have switched related engines to another valid API Key before deletion.
8087
</Warning>

en/monitors/faq/faq.mdx

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,18 @@ On the alert rules list page, there is a **Debug Log Switch** that you can enabl
2323
<Accordion title="What information does the overview dashboard display?">
2424
**Menu Entry**: Overview
2525

26-
The overview page provides a global view of alert rules, including:
27-
28-
- **Rule Statistics**: Displays the total number of alert rules and the distribution across statuses
29-
- **Channel Distribution**: Shows the number of associated alert rules per channel
30-
- **Problem List**: Displays currently triggered alert events, helping you quickly identify active issues
26+
The overview page provides a global view of alert rules, consisting of the following cards:
27+
28+
| Card | Description |
29+
|------|-------------|
30+
| **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 |
31+
| **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 |
33+
| **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 |
34+
35+
<Tip>
36+
The overview page checks whether you have installed an alert engine. If not, a prompt guides you to the alert engine page to complete installation.
37+
</Tip>
3138
</Accordion>
3239

3340
<Accordion title="How do I quickly clone an alert rule?">

en/on-call/channel/create-edit.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ Proper planning can significantly improve operational efficiency.
5151
- **Auto-close after incident trigger**: Timer starts from when the incident is first triggered, suitable for alerts without automatic recovery
5252
- **Auto-close after alerts stop merging**: Timer starts from the last alert merge, suitable for scenarios with alert grouping enabled
5353
</Step>
54+
<Step title="Configure Close with Alerts (Optional)">
55+
Enabled by default. When enabled, incidents automatically close when all associated alerts recover. When disabled, alert recovery does not auto-close the incident — you need to close it manually or rely on the auto-close timeout policy.
56+
</Step>
5457
<Step title="Enable Outlier Incident Detection (Optional)">
5558
When enabled, incident lists and notification content will include an "Outlier Incident" indicator for quick identification. [Learn more](/en/on-call/incident/outlier-incidents)
5659
</Step>
@@ -128,6 +131,7 @@ Go to Channel Details → **Basic Settings** to modify:
128131
- Channel name, description
129132
- Management team
130133
- Auto-close timeout policy
134+
- Close with alerts toggle
131135

132136
### Disabling and Deleting
133137

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Determines how users are reached.
6969
<Tab title="Group Chat (Reach Groups)">
7070
Send to instant messaging groups, with support for @ mentioning relevant personnel.
7171

72-
- **IM App Groups**: Supports Feishu/Lark, Dingtalk, WeCom groups, requires completing [IM Integration](/en/on-call/integration/instant-messaging/lark) first
72+
- **IM App Groups**: Supports Feishu/Lark, Dingtalk, WeCom, Slack, and Microsoft Teams groups, requires completing [IM Integration](/en/on-call/integration/instant-messaging/lark) first
7373
- **Group Bots**: Supports Feishu/Lark, Dingtalk, WeCom, Telegram, Zoom, and other Webhook bots. Telegram requires configuring a Webhook notification address and Chat IDs, Zoom requires configuring a Webhook address and Verify Token, and supports enabling @ mention functionality. See [Notification Channel Configuration](/en/on-call/configuration/notifications)
7474
</Tab>
7575
</Tabs>

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

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ Flashduty On-call provides two grouping modes:
100100
| Configuration | Description |
101101
| :------- | :----------------------------------- |
102102
| **Grouping Window** | Only group alerts within the time window, alerts outside the window trigger new incidents |
103+
| **Window Type** | **Tumbling** (default): Fixed timer starts from incident creation, stops grouping when the window duration is reached. **Sliding**: Timer resets each time a new alert merges in, the window recalculates from the last merge |
103104
| **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 |
104105
| **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) |
105106

@@ -178,10 +179,22 @@ Go to Channel Details → Noise Reduction → **Flapping Detection**:
178179

179180
| Option | Behavior |
180181
| :-------- | :--------------- |
181-
| **Off** | Don't detect flapping status (default) |
182+
| **Off** | Don't detect flapping status |
182183
| **Alert Only** | Mark flapping status, continue notifications per policy |
183184
| **Alert Then Silence** | Mark flapping status, no more notifications after first alert |
184185

186+
<Note>
187+
Flapping detection is enabled by default for new channels (Alert Only mode).
188+
</Note>
189+
190+
### Configurable Parameters
191+
192+
| Parameter | Description | Default | Range |
193+
| :--- | :--- | :--- | :--- |
194+
| **State changes** (max_changes) | Number of alert state changes within the observation window to trigger flapping detection | 4 | 2–100 |
195+
| **Observation window** (in_mins) | Time window for counting state changes | 60 minutes | 1–1440 minutes |
196+
| **Mute duration** (mute_mins) | Duration to mute notifications after flapping is detected (only applies in "Alert Then Silence" mode) | 120 minutes | 0–1440 minutes |
197+
185198
<Tip>
186199
"Same incident" refers to incidents with the same Alert Key, typically using the alert ID pushed from the upstream system as a unique identifier.
187200
</Tip>
@@ -314,8 +327,8 @@ When a new alert meets conditions, and there's an **active incident** (not close
314327
Up to 5000, mainly to ensure console rendering performance. Due to backend concurrent processing, actual count may slightly exceed this limit.
315328
</Accordion>
316329
<Accordion title="What's the maximum number of events a single alert can be associated with?" icon="circle-question">
317-
- **Rule-based Grouping**: No limit, maximum grouping window is 24 hours. After 24 hours from alert trigger, new events create new incidents
318-
- **Intelligent Grouping**: No limit, maximum grouping window is 30 days. After 30 days from alert trigger, new events create new incidents
330+
- **Rule-based Grouping**: No limit, default maximum grouping window is 24 hours. After 24 hours from alert trigger, new events create new incidents
331+
- **Intelligent Grouping**: No limit, default maximum grouping window is 24 hours, with certain subscription plans supporting extension up to 30 days. After exceeding the window, new events create new incidents
319332
</Accordion>
320333
</AccordionGroup>
321334

en/on-call/configuration/personal-settings.mdx

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,39 @@ APP Keys are used for API request authentication.
7373

7474
---
7575

76+
### Download the app
77+
7678
| Platform | Download Method |
7779
| --- | --- |
7880
| **iOS** | Search "Flashduty" in App Store |
79-
| **Android** | Download from major app stores (Harmony OS not currently supported) |
81+
| **Android** | Available on major app stores including Xiaomi, Huawei, Honor, OPPO, and vivo — search "Flashduty" to download (Harmony OS not currently supported) |
82+
83+
If your phone brand is not listed above, you can click **Download here** on the APP management page to get an installation package QR code. Scan it with your phone to download.
84+
85+
### Device binding
86+
87+
After installing the app, you need to bind your mobile device to your Flashduty account to receive push notifications.
88+
89+
<Steps>
90+
<Step title="Go to APP management page">
91+
Navigate to **Personal Center → Flashduty APP**.
92+
</Step>
93+
<Step title="Scan QR code to bind device">
94+
The page displays a QR code. Open the Flashduty APP, tap the "Scan to Login" button, and scan the QR code on the page to complete device binding.
95+
</Step>
96+
</Steps>
97+
98+
Once bound, the page displays a list of linked devices, including device name, OS version, and device identifier. To unbind a device, hover over the device card and click the **Unbind** button.
99+
100+
<Note>
101+
- Binding a device does not automatically enable notifications — the actual notification method depends on your escalation rule settings
102+
- After unbinding a device, it will no longer receive push notifications
103+
- The QR code has an expiration time; the page automatically refreshes to generate a new QR code when it expires
104+
</Note>
105+
106+
### Push notifications
80107

81-
After downloading, select a login method to complete account linking. We recommend enabling system notification permissions and allowing urgent incident notifications in Do Not Disturb mode.
108+
The Flashduty APP supports free push notifications for alerts, ensuring critical alerts reach you instantly. You can acknowledge, resolve, and escalate alerts anytime, anywhere from your mobile device. We recommend enabling system notification permissions and allowing urgent incident notifications in Do Not Disturb mode to avoid missing important alerts.
82109

83110
## FAQ
84111

en/on-call/incident/handle-update-incident.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,11 @@ You can view each person's assignment time and acknowledgment time in the consol
9595

9696
## Snooze
9797

98-
After acknowledging an incident, responders may need time to investigate and handle it. **Snooze** can temporarily stop the incident from escalating per the expected escalation rule. After acknowledging, you can set a snooze duration such as 2 hours, 4 hours, 12 hours, or a custom expiration time within 24 hours.
98+
After acknowledging an incident, responders may need time to investigate and handle it. **Snooze** can temporarily stop the incident from escalating per the expected escalation rule. After acknowledging, you can choose from preset durations (default: 2 hours, 4 hours, 12 hours) or set a custom expiration time within 24 hours.
99+
100+
<Tip>
101+
Account administrators can customize the 3 snooze preset durations in **Account Settings** (in minutes, each value must be greater than 0 and no more than 24 hours). Changes take effect for all members.
102+
</Tip>
99103

100104
<Warning>
101105
If you've snoozed and the snooze time has passed but you still haven't resolved the incident, the system automatically reverts the incident to **Triggered** status and re-initiates assignment notifications.

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Incident details is the main entry point for investigating incidents, displaying
7878
| :---: | :--- | :--- |
7979
| 1 | Key Information | Incident title, severity, processing progress, ID number |
8080
| 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 |
81-
| 3 | Details | Incident description, label info; AI Summary can quickly extract incident details and output in three dimensions: event overview, impact scope, and actionable measures; labels support drag-to-sort and JSON view display |
81+
| 3 | Details | Incident description, label info, and AI Summary (see below for details); labels support drag-to-sort and JSON view display |
8282
| 4 | Associated Alerts | All [grouped](/en/on-call/channel/noise-reduction) alerts associated with the incident, supports filtering by progress and view switching |
8383
| 5 | Comprehensive Info | Shows incident attributes, processing status, [images](https://developer.flashcat.cloud/api-344943718), and responder info |
8484
| 6 | Custom Fields | Custom field configuration area |
@@ -104,10 +104,28 @@ The change event list displays the following information:
104104

105105
You can adjust the query scope through the filter at the top, including time range and change source. Expand any row to view a timeline visualization of that change event, allowing comparison with the incident trigger time.
106106

107+
### AI Summary
108+
109+
The incident details page supports one-click AI summary generation to help you quickly understand the full picture of an incident. Click the **AI Summary** button in the details area, and the system will automatically generate a structured summary based on the incident's associated alerts (up to 20), including:
110+
111+
- **Summary**: A one-sentence description of what happened
112+
- **Impacts**: Key affected resources such as services, systems, environments, and instances
113+
- **Actions**: Immediately actionable investigation and remediation steps (up to 3)
114+
115+
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.
116+
117+
<Tip>
118+
AI Summary is only available for incidents automatically triggered by alerts. Manually created incidents do not support this feature.
119+
</Tip>
120+
107121
### Images
108122

109123
When alerts associated with the incident include image information reported via API, the incident details right panel displays an **Images** section. You can click image thumbnails to preview them, and hover to view the Alt description and source links.
110124

125+
### Linked External Tickets
126+
127+
If you have configured ticket integrations such as Jira, ServiceNow, or ServiceDesk Plus, the comprehensive info area in the incident details right panel displays linked external ticket information. You can click directly to navigate to the corresponding external ticket system and view details.
128+
111129
## FAQ
112130

113131
<AccordionGroup>

en/on-call/incident/what-is-incident.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Flashduty On-call supports dedicated and shared integration modes:
123123
Flashduty On-call provides a custom event standard, allowing you to report alerts via standard protocol, suitable for any non-integrated monitoring system. For details, read [Custom Alert Events](https://developer.flashcat.cloud/api-110655782).
124124

125125
<Warning>
126-
To ensure system stability, Flashduty On-call has a **200qps** rate limit for API reporting. Exceeding this limit will reject reports.
126+
To ensure system stability, Flashduty On-call enforces rate limits per integration (**100 requests/second**, **1000 requests/minute**). Exceeding these limits returns a `429` status code — please wait and retry. See [Integrate Data - Rate Limits](/en/on-call/channel/integrate-data#rate-limits) for details.
127127
</Warning>
128128

129129
<Warning>

0 commit comments

Comments
 (0)