Skip to content

Commit cc3827c

Browse files
authored
Merge pull request #13 from flashcatcloud/doc-review/2026-03-17
fix: correct on-call docs inaccuracies found by doc-review
2 parents 9161e19 + 1c0fc60 commit cc3827c

File tree

20 files changed

+42
-38
lines changed

20 files changed

+42
-38
lines changed

en/on-call/advanced/reference-variables.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,18 @@ Use `[TPL]` as prefix and `${}` to reference variables. Variable content is extr
4848

4949
### Reference via Golang Template Syntax
5050

51-
Use `[TPL]` as prefix and `{{}}` to reference variables (can reference both labels and attributes); if extraction fails, `<no value>` is used as a placeholder.
51+
Use `[TPL]` as prefix and `{{}}` to reference variables (can reference both labels and attributes); if extraction fails, returns an empty string for missing labels.
5252

5353
| Rule | Variable Values | Generated Content |
5454
| --- | --- | --- |
5555
| `[TPL]{{.Labels.resource}} / {{.Labels.check}}` | `{"resource": "127.0.0.1", "check": "cpu idle low"}` | 127.0.0.1 / cpu idle low |
56-
| `[TPL]{{.Labels.resource}} / {{.Labels.check}}` | `{"resource": "127.0.0.1"}` | 127.0.0.1 / `<no value>` |
56+
| `[TPL]{{.Labels.resource}} / {{.Labels.check}}` | `{"resource": "127.0.0.1"}` | 127.0.0.1 / |
5757
| `[TPL]{{.EventSeverity}} / Host Down` | `{"EventSeverity": "Warning"}` | Warning / Host Down |
5858

59+
<Note>
60+
`${}` syntax and `{{}}` syntax behave differently when a label is missing: `${}` returns `<no value>`, while `{{}}` returns an empty string.
61+
</Note>
62+
5963
#### Supported Attributes
6064

6165
| Field | Type | Description |

en/on-call/analytics/insights.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ When customizing filter conditions, the system remembers your selections. Even a
3333
| Team | Select team names to query, supports multiple selection. Dashboard data updates based on selected teams |
3434
| Channel | Select channel names to query, supports multiple selection. Dashboard data updates based on selected channels |
3535
| Severity | Select severity levels to query, supports multiple selection. Dashboard data updates based on selected severity levels |
36-
| Time Range | Select time range to query. Supports this week, last two weeks, this month, last month, and custom time ranges, but only up to the last **180 days** of data |
36+
| Time Range | Select time range to query. Supports this week, last two weeks, this month, last month, and custom time ranges, but only up to the last **1 year** of data |
3737
| Data Interval | Supports day, week, and month dimensions. Defaults to hourly queries, but when time range exceeds 31 days, daily preview is not available |
3838
| Sorting | Team, channel, and individual dimension dashboards support ascending and descending order. Defaults to showing TOP 10 data; expand to show more |
3939

@@ -124,7 +124,7 @@ Export incident list data in CSV format. Supports exporting incident list, team,
124124

125125
<AccordionGroup>
126126
<Accordion title="How can I query older data?">
127-
Currently, insights only supports querying the last 180 days of data. For older data, use the [API Query](https://developer.flashcat.cloud/api-213441443).
127+
Currently, insights only supports querying the last 1 year (depending on your plan's data retention period) of data. For older data, use the [API Query](https://developer.flashcat.cloud/api-213441443).
128128
</Accordion>
129129

130130
<Accordion title="Why can't I view data at daily granularity when the time range exceeds 31 days?">

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,10 @@ Quickly create temporary silence rules based on existing incidents.
233233

234234
**Operation Path**: Incident Details → More Actions → **Quick Silence**
235235

236-
- Rule name defaults to incident ID + title
236+
- Rule name defaults to "Quick Silence - #short-ID", with the incident title included in the description
237237
- Effective scope is the incident's channel (cannot be changed)
238238
- Default effective for 24 hours, automatically deleted after expiration
239-
- Conditions default to exact match of incident labels
239+
- Conditions default to severity and filtered label matching (automatically excluding numeric, overly long, and special labels)
240240

241241
<Frame caption="Quick Silence Configuration">
242242
![Quick Silence](https://docs-cdn.flashcat.cloud/images/png/e80c2632d9065b28499edfa5a81a8505.png)

en/on-call/configuration/custom-fields.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ Click **Create Custom Field**, enter the following information:
7272
| Type | Description |
7373
| :--- | :--- |
7474
| **Text** | Plain text input, max 500 characters |
75-
| **Single-select** | Dropdown with single selection, max 10 options, each up to 200 characters |
76-
| **Multi-select** | Dropdown with multiple selection, max 10 options, each up to 200 characters |
75+
| **Single-select** | Dropdown with single selection, max 20 options, each up to 200 characters |
76+
| **Multi-select** | Dropdown with multiple selection, max 20 options, each up to 200 characters |
7777
| **Checkbox** | Checkbox toggle |
7878
</Step>
7979
<Step title="Complete Creation">

en/on-call/configuration/templates.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,10 @@ Complete variable list for incident objects:
116116
<Accordion title="Assignment - Assignment Configuration">
117117
| Field | Type | Required | Description |
118118
| :--- | :--- | :---: | :--- |
119-
| PersonIDs | []string | | Person ID list, only exists when assigned by person |
119+
| PersonIDs | []int64 | | Person ID list, only exists when assigned by person |
120120
| EscalateRuleID | string | | Escalation rule ID |
121121
| EscalateRuleName | string | | Escalation rule name |
122-
| LayerIdx | string | | Assignment level, starts from 0 |
122+
| LayerIdx | int | | Assignment level, starts from 0 |
123123
| Type | string || Assignment type: assign / reassign / escalate / reopen |
124124
</Accordion>
125125

@@ -140,10 +140,9 @@ Complete variable list for incident objects:
140140
| Description | string || Alert description, may be empty |
141141
| AlertSeverity | string || Severity: Critical / Warning / Info |
142142
| AlertStatus | string || Alert status: Critical / Warning / Info / Ok |
143-
| Progress | string || Processing progress: Triggered / Processing / Closed |
144143
| StartTime | int64 || Trigger time, Unix timestamp in seconds |
144+
| LastTime | int64 | | Latest event time, Unix timestamp in seconds |
145145
| EndTime | int64 | | Recovery time, Unix timestamp in seconds |
146-
| CloseTime | int64 | | Close time, Unix timestamp in seconds |
147146
| Labels | map | | Label KV |
148147
</Accordion>
149148
</AccordionGroup>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ 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 like 2 hours, 4 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 set a snooze duration such as 2 hours, 4 hours, 12 hours, or a custom expiration time within 24 hours.
9999

100100
<Warning>
101101
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/outlier-incidents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ When enabled, incident lists and notification content will include an "Outlier"
6464

6565
<AccordionGroup>
6666
<Accordion title="Does outlier incident detection need to be enabled separately?">
67-
No setup or enabling needed. By default, all Professional subscription and above versions trigger outlier incident detection.
67+
Enabled by default for Pro and above plans, but can be disabled in the channel's basic settings. See the "Enable and disable" section above.
6868
</Accordion>
6969
</AccordionGroup>
7070

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ When rewriting titles or descriptions, you can use Go Template syntax to referen
105105
| `[TPL]{{.Labels.xxx}}` | Reference specific label | `[TPL]{{.Labels.host}}` |
106106
| `[TPL]{{.Title}}` | Reference current title | `[TPL][Forwarded] {{.Title}}` |
107107
| `[TPL]{{.Description}}` | Reference current description | `[TPL]Details: {{.Description}}` |
108-
| `[TPL]{{.Severity}}` | Reference current severity | `[TPL]Current Level: {{.Severity}}` |
108+
| `[TPL]{{.EventSeverity}}` | Reference current severity | `[TPL]Current Level: {{.EventSeverity}}` |
109109

110110
<Tip>
111111
Before configuring Pipeline, we recommend observing raw alert data for a period to identify which fields (Labels) are stable and which need cleansing.

en/on-call/integration/alert-integration/label-enhancement.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,8 @@ Prepare a CSV format mapping table file to map resource type IDs in alerts to ac
179179
| Description | Service purpose description | Query asset info by host IP |
180180
| Request URL | API request address | `https://mapping-api.example.com/v1/enrich-event` |
181181
| Headers | HTTP request header configuration | `X-Auth-Token: your-token` |
182-
| Timeout | Request timeout in seconds | 1 |
183-
| Retry Count | Number of retries after failure | 1 |
182+
| Timeout | Request timeout, 1-3 seconds, default 2 seconds | 1 |
183+
| Retry Count | Retry count on failure, 0-1 times, default 0 times | 1 |
184184

185185
<Tip>
186186
If the API uses HTTPS with an untrusted certificate, you can enable the `Skip Certificate Verification` option.
@@ -244,7 +244,6 @@ Flashduty will call your API via `POST` method with the following request body:
244244
"description": "CPU usage for instance '10.0.1.1:9100' is over 95%",
245245
"title": "High CPU Usage on instance 10.0.1.1:9100",
246246
"alert_key": "d41d8cd98f00b204e9800998ecf8427e",
247-
"alert_id": "62d6c0f6b8f1b2b3c4d5e6f7",
248247
"event_severity": "Critical",
249248
"event_status": "Critical",
250249
"event_time": 1678886400,

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Confirm reported alerts can hit configured routing rules. We recommend configuri
118118
</Accordion>
119119

120120
<Accordion title="When flow control is set to 'Stop', will default route still match?">
121-
Yes. Default route is a fallback rule not subject to flow control restrictions.
121+
No. The default route only takes effect when no routing rules match the alert. If any rule has already matched (regardless of whether flow control is set to 'continue' or 'stop'), the default route will not be triggered.
122122
</Accordion>
123123
</AccordionGroup>
124124

0 commit comments

Comments
 (0)