Skip to content

Commit 592a4dd

Browse files
authored
Merge pull request #27 from flashcatcloud/doc-review/2026-03-23-153833
docs: fix documentation drift (1-month diff review)
2 parents b135a53 + eec8204 commit 592a4dd

33 files changed

Lines changed: 1037 additions & 91 deletions

docs.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,7 @@
211211
"zh/on-call/integration/alert-integration/alert-sources/harbor",
212212
"zh/on-call/integration/alert-integration/alert-sources/ucloud-cloudwatch",
213213
"zh/on-call/integration/alert-integration/alert-sources/volcengine-rtc",
214+
"zh/on-call/integration/alert-integration/alert-sources/nagios",
214215
"zh/on-call/integration/alert-integration/alert-sources/label-mapping-api"
215216
]
216217
},
@@ -625,6 +626,7 @@
625626
"en/on-call/integration/alert-integration/alert-sources/harbor",
626627
"en/on-call/integration/alert-integration/alert-sources/ucloud-cloudwatch",
627628
"en/on-call/integration/alert-integration/alert-sources/volcengine-rtc",
629+
"en/on-call/integration/alert-integration/alert-sources/nagios",
628630
"en/on-call/integration/alert-integration/alert-sources/label-mapping-api"
629631

630632
]

en/monitors/data-sources/data-sources.mdx

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Data source management"
3-
description: "Configure and manage data sources for Monitors, including Prometheus, Elasticsearch, Loki, ClickHouse, MySQL, Oracle, PostgreSQL, and SLS"
4-
keywords: ["data source", "Prometheus", "Elasticsearch", "Loki", "ClickHouse", "MySQL", "Oracle", "PostgreSQL", "SLS"]
3+
description: "Configure and manage data sources for Monitors, including Prometheus, Elasticsearch, Loki, ClickHouse, MySQL, Oracle, PostgreSQL, SLS, and VictoriaLogs"
4+
keywords: ["data source", "Prometheus", "Elasticsearch", "Loki", "ClickHouse", "MySQL", "Oracle", "PostgreSQL", "SLS", "VictoriaLogs"]
55
---
66

77
Data sources are where the alert engine queries data. You need to configure data sources first so the alert engine can read data from them for anomaly detection.
@@ -10,7 +10,7 @@ Data sources are where the alert engine queries data. You need to configure data
1010

1111
## Supported data source types
1212

13-
Monitors supports the following 8 data source types:
13+
Monitors supports the following 9 data source types:
1414

1515
| Type | Description |
1616
|------|-------------|
@@ -22,6 +22,7 @@ Monitors supports the following 8 data source types:
2222
| **Oracle** | Relational database |
2323
| **PostgreSQL** | Relational database |
2424
| **SLS** | Alibaba Cloud Log Service |
25+
| **VictoriaLogs** | Log database, a logging solution from the VictoriaMetrics ecosystem |
2526

2627
## Data source list
2728

@@ -45,7 +46,7 @@ Click the **New** button and select the data source type (e.g., Prometheus, MySQ
4546

4647
| Config Item | Description |
4748
|-------------|-------------|
48-
| **Name** | Unique identifier for the data source; alert rules reference data sources by name (wildcards supported) |
49+
| **Name** | Unique identifier for the data source; alert rules can reference data sources via wildcard by name or exact match by ID (see below) |
4950
| **Notes** | Optional supplementary description |
5051
| **Associated Alert Engine** | Select the engine cluster responsible for querying this data source; typically choose a cluster in the same datacenter |
5152

@@ -58,8 +59,17 @@ Click **OK** to complete creation.
5859
</Step>
5960
</Steps>
6061

62+
### Two ways to bind data sources in alert rules
63+
64+
Alert rules support two methods for binding data sources. Both can be used together, and at least one must be specified. The rule applies to all data sources matched by either method (union).
65+
66+
| Binding Mode | Field | Matching Logic | Use Case |
67+
|--------------|-------|----------------|----------|
68+
| **Wildcard by name** | `Data Sources (Wildcard)` | Matches by name with wildcards. `*` matches all data sources; `Prom*` matches names with the Prom prefix | Dynamically match a group of data sources, e.g., data sources sharing a common naming prefix |
69+
| **Exact match by ID** | `Data Sources (Exact Match)` | Associates by data source ID; select specific data sources from a dropdown list | Precisely bind specific data sources, unaffected by data source renames |
70+
6171
<Warning>
62-
Data source names are used for association in alert rules (wildcard matching supported). Changing a data source name may cause existing alert rules to stop working. Please proceed with caution.
72+
Wildcard by name stores name strings — if a data source is renamed, existing wildcard rules may no longer match. Exact match by ID stores the data source ID and is unaffected by renames. If stability is a priority, prefer exact match.
6373
</Warning>
6474

6575
## Data source type configuration
@@ -92,9 +102,9 @@ Relational databases share a similar configuration structure:
92102

93103
Self-signed certificate and TLS client authentication configurations are also supported.
94104

95-
### Elasticsearch / Loki / ClickHouse / SLS
105+
### Elasticsearch / Loki / ClickHouse / SLS / VictoriaLogs
96106

97-
These data sources have connection configurations similar to Prometheus, including server address, authentication, and TLS settings. Refer to the creation form for specific parameters.
107+
These data sources have connection configurations similar to Prometheus, including server address, authentication, and TLS settings. The default server address for VictoriaLogs is `http://localhost:9428`. Refer to the creation form for specific parameters.
98108

99109
## Test a data source
100110

en/monitors/quickstart/quickstart.mdx

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,16 @@ There may be many alert rules. Monitors provides a tree-structured grouping for
7878

7979
![Data source selection](https://docs-cdn.flashcat.cloud/imges/mon/9971af45b4bc19bfe807898bf1bf10a0.png)
8080

81-
Monitors supports a single rule applying to multiple data sources using wildcards, such as `db-*` to apply to all data sources starting with `db-`.
81+
Monitors supports a single rule applying to multiple data sources with two binding methods:
8282

83-
<Warning>
84-
Data source configuration stores names rather than IDs (to support wildcards). If the data source name is changed, it will affect the alert rule's effectiveness. Please modify with caution.
85-
</Warning>
83+
- **Wildcard by name**: Match data sources by name using wildcards. `*` matches all data sources; `db-*` matches all data sources starting with `db-`. Stores name strings, so renaming a data source affects matching.
84+
- **Exact match by ID**: Select specific data sources from a dropdown by ID. Unaffected by data source renames.
85+
86+
Both methods can be used together, and at least one must be specified. The rule applies to all data sources matched by either method.
87+
88+
<Tip>
89+
If you need stable rule bindings that are unaffected by data source renames, prefer exact match. See [Data Source Management](/en/monitors/data-sources/data-sources) for details.
90+
</Tip>
8691

8792
### Query Detection Method
8893

@@ -119,6 +124,10 @@ After configuration is complete, if alert conditions trigger, the status before
119124

120125
![Alert rules list page](https://docs-cdn.flashcat.cloud/imges/mon/6f1fad7d65b5aee6b89bf0f0a564a1be.png)
121126

127+
<Tip>
128+
The search box in the alert rules list supports filtering by rule name, rule ID, or labels for quick navigation. You can also use the URL parameter `?rule_id=<ID>` to jump directly to a specific rule.
129+
</Tip>
130+
122131
Click `Triggered` to see the alert events generated by this rule (also viewable in On-call):
123132

124133
![Alert events list](https://docs-cdn.flashcat.cloud/imges/mon/3a307bf41012c5e085d81ca8b2dc443b.png)

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

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,19 @@ You can skip [escalation rules](/en/on-call/channel/escalation-rule) or [integra
7575

7676
## Configuring Core Capabilities
7777

78-
After creating a channel, complete the following configurations on the details page:
78+
After creating a channel, go to the **Configuration** tab on the details page to complete the following configurations. The Configuration tab uses a sidebar menu organized into functional groups:
79+
80+
- **Integrate Data**: Dedicated Integrations, Drop Rules
81+
- **Noise Reduction**: Alert Grouping, Flapping Detection, Silence Rules, Inhibit Rules
82+
- **Notification & Assignment**: Escalation Rules
83+
- **Settings**: Basic Info, Advanced Settings
7984

8085
### Integrate Alerts
8186

82-
Create alert integrations in the **Integrate Data** tab to bring monitoring system alerts into this channel.
87+
Create alert integrations in **Configuration****Integrate Data** **Dedicated Integrations** to bring monitoring system alerts into this channel.
8388

8489
- Each integration type generates an independent Webhook address
85-
- Configure **drop rules** to filter test data or invalid alerts
90+
- Configure rules in **Configuration****Integrate Data****Drop Rules** to filter test data or invalid alerts
8691

8792
<Warning>
8893
Dropped events will not appear anywhere. If you're not receiving alerts, check the drop rules first.
@@ -92,7 +97,7 @@ See [Integrate Data](/en/on-call/channel/integrate-data) for details.
9297

9398
### Configure Escalation Rules
9499

95-
Define incident notification paths in the **Escalation Rules** tab: who to notify, how to notify, and how to escalate on timeout.
100+
Define incident notification paths in **Configuration****Notification & Assignment****Escalation Rules**: who to notify, how to notify, and how to escalate on timeout.
96101

97102
- Multiple rules are matched from top to bottom by priority, matching stops on first match
98103
- Drag to adjust rule order
@@ -101,14 +106,14 @@ See [Configure Escalation Rules](/en/on-call/channel/escalation-rule) for detail
101106

102107
### Configure Noise Reduction
103108

104-
Converge massive alerts into fewer incidents in the **Noise Reduction** tab:
109+
Configure noise reduction capabilities under **Configuration****Noise Reduction** to converge massive alerts into fewer incidents:
105110

106-
| Capability | Description |
107-
| :--- | :--- |
108-
| **Alert Grouping** | Merge similar alerts from the same host or service into one incident |
109-
| **Flapping Detection** | Automatically identify and suppress alerts that oscillate repeatedly in a short time |
110-
| **Silence Rules** | Temporarily suppress alert notifications under specific conditions during scheduled maintenance windows or specific time periods |
111-
| **Inhibit Rules** | Reduce redundant notifications using dependencies between alerts |
111+
| Capability | Navigation Path | Description |
112+
| :--- | :--- | :--- |
113+
| **Alert Grouping** | Noise Reduction → Alert Grouping | Merge similar alerts from the same host or service into one incident |
114+
| **Flapping Detection** | Noise Reduction → Flapping Detection | Automatically identify and suppress alerts that oscillate repeatedly in a short time |
115+
| **Silence Rules** | Noise Reduction → Silence Rules | Temporarily suppress alert notifications under specific conditions during scheduled maintenance windows or specific time periods |
116+
| **Inhibit Rules** | Noise Reduction → Inhibit Rules | Reduce redundant notifications using dependencies between alerts |
112117

113118
See [Configure Noise Reduction](/en/on-call/channel/noise-reduction) for details.
114119

@@ -133,15 +138,15 @@ Links support two open modes: **Open in New Tab** and **Open in Embedded iframe*
133138

134139
### Changing Configuration
135140

136-
Go to Channel Details and modify configuration across two settings tabs:
141+
Go to Channel Details, then navigate to **Configuration****Settings** to modify configuration:
137142

138-
**Basic Settings**:
143+
**Basic Info** (Configuration → Settings → Basic Info):
139144
- Channel name, description
140145
- Owning team
141146
- Managing team (must be enabled by contacting the Flashduty team; up to 3 managing teams; when set, managing teams take over management permissions from the owning team)
142147
- Access level (public or private)
143148

144-
**Advanced Settings**:
149+
**Advanced Settings** (Configuration → Settings → Advanced Settings):
145150
- Close with alerts toggle
146151
- Auto-resolve timeout (toggle, window timing start, timeout duration)
147152
- Outlier incident detection

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ You can view each person's assignment time and acknowledgment time in the consol
9898
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.
9999

100100
<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.
101+
Account administrators can click the **configuration icon** (gear) directly in the snooze dropdown to customize the 3 snooze preset durations. Each preset supports selecting **hours** or **minutes** as the unit, and each value must be greater than 0 and no more than 24 hours. Changes take effect for all members.
102102
</Tip>
103103

104104
<Warning>

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,26 @@ Incident details is the main entry point for investigating incidents, displaying
8989
| 5 | Comprehensive Info | Shows incident attributes, processing status, [images](https://developer.flashcat.cloud/api-344943718), and responder info |
9090
| 6 | Custom Fields | Custom field configuration area |
9191

92-
You can switch tabs above to view more detailed **Associated Alerts**, **Timeline**, **Change History**, and **Post-Mortem**. Post-mortem supports creating and editing post-mortem reports directly from the incident details. See [Post-Mortem](/en/on-call/post-mortem/create-edit-post-mortem) for details. For incidents with existing resolution records, the system still displays the **Resolution** tab.
92+
You can switch tabs above to view more detailed **Associated Alerts**, **Timeline**, **Change History**, and **Post-Mortem**. For incidents with existing resolution records, the system still displays the **Resolution** tab.
93+
94+
### Post-Mortem
95+
96+
The incident details page has a built-in post-mortem editor, allowing you to complete the entire post-mortem workflow without leaving the page. The action area includes a shortcut button that navigates directly to the **Post-Mortem** tab.
97+
98+
In the Post-Mortem tab, you can perform the following actions:
99+
100+
| Action | Description |
101+
| :--- | :--- |
102+
| **Create** | Click the create button to start writing a post-mortem report |
103+
| **AI Generate** | Use AI to auto-generate initial post-mortem content, which you can then refine |
104+
| **Edit Title** | Modify the post-mortem report title to accurately reflect the incident |
105+
| **Edit Content** | Write and modify post-mortem content using the rich text editor |
106+
| **Publish** | Publish the post-mortem report to make it visible to the team |
107+
| **Re-edit** | Published post-mortem reports can be re-opened for editing |
108+
| **Delete** | Remove post-mortem reports that are no longer needed |
109+
| **Export Markdown** | Export the post-mortem report as Markdown for sharing or archiving on other platforms |
110+
111+
See [Post-Mortem](/en/on-call/post-mortem/create-edit-post-mortem) for details.
93112

94113
### Change History
95114

0 commit comments

Comments
 (0)