Skip to content

Commit cd7fdd0

Browse files
committed
update docs
1 parent bbf74db commit cd7fdd0

18 files changed

Lines changed: 119 additions & 73 deletions

flashduty/en/1. On-call/1. Getting Started/1.3 FAQ.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,31 +20,27 @@ url: "https://docs.flashcat.cloud/en/flashduty/frequently-asked-questions?nav=01
2020
</details>
2121

2222
<details>
23-
<summary>What are active and inactive users?</summary>
23+
<summary>How does Flashduty On-call pricing work?</summary>
2424

25+
Flashduty On-call's pricing model is based on the number of licenses purchased, where each license corresponds to one account member. For example, if you only purchase one license, only one member can use all features of Flashduty On-call. However, you can still invite more members to join, but only members with licenses can perform operational configurations on the platform, while other members **cannot use any platform features** (limited to receiving incident notifications only). The specific differences are as follows:
2526

26-
FlashDuty's pricing model is based on the number of purchased licenses, with each license corresponding to an active user account. For example, if you only purchase one license, only one member can use all FlashDuty features as an active user. However, you can still invite more members to join, but only members with licenses can become active users and enjoy all features. The specific differences are as follows:
27+
#### License Allocation Methods
2728

28-
#### Active User
29+
- Administrators can actively allocate licenses to different members.
30+
- When allocating licenses, you can set the license type.
31+
- Fixed type: Valid for the entire purchase period, cannot be preempted, suitable for scenarios requiring participation in incident handling and business configuration.
32+
- Temporary type: Automatically released at the end of each cycle, can be occupied through allocation or preemption when sufficient licenses are available.
2933

30-
- A user who has used the product in the current month is considered an active user, with each active user occupying one license. The count resets at the beginning of the next month.
31-
- Logging in will occupy one license, making the user an active user.
32-
- When an active user is deleted, their corresponding license will be released.
33-
- Active users have full access to all features (subject to version and role permission limitations).
34-
- Active users can transfer their own license to other inactive users.
34+
#### Members Without Licenses
3535

36-
37-
#### Inactive User
38-
39-
- Inactive users do not have any feature usage permissions, including viewing incident lists/details, **only passively receiving alert messages** via email, SMS, and IM group messages.
40-
- In the configuration of the escalation policy, you can choose to notify the incident message to inactive users.
41-
- Inactive users cannot view or close incidents.
42-
- Inactive users share the email, SMS, and phone notification quota with active users.
43-
- When logging in to the console for viewing/processing, they will be prompted with no permissions.
36+
- Cannot use any features, including viewing incident lists/details, **can only passively receive alert messages**, such as receiving incident messages via email, SMS, phone calls, or IM group messages.
37+
- When configuring assignment strategies, you can choose to notify members without licenses about incident messages.
38+
- Members without licenses, even if they receive incident messages, cannot view, close, or perform other operations on them.
39+
- Members without licenses share the tenant's email, SMS, and phone package quotas.
40+
- Members without licenses will be prompted that they don't have permission when trying to view/handle operations after logging into the console.
4441

4542
</details>
4643

47-
4844
<details>
4945
<summary>What notification methods does Flashduty On-call support?</summary>
5046

flashduty/en/1. On-call/4. Configure On-call/4.1 Channels.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,18 @@ Log in to the console and navigate to: **Incident Management => Channel => Creat
3535
- **Channel Name:** Recommended to name and plan based on department, team, or business type for better understanding of the channel's purpose.
3636
- **Description:** Briefly summarize the business handled by this channel and the types of alerts it receives.
3737
- **Management Team:** Set the management team during creation. **Team members have full operational permissions** for the channel, while non-creators have read-only access to channel configurations.
38-
- **Auto-close Timeout:** Incidents not closed within N minutes will be **automatically closed by the system** (applies to all new incidents in this channel). Timeout-closed incidents will also **receive corresponding closure notifications** (notification channels depend on [escalation rule](https://docs.flashcat.cloud/en/flashduty/escalate-rule-settings?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5) configuration).
38+
- **Auto-close Timeout:**
39+
- Auto-close after incident trigger: Starts timing from the first incident trigger and automatically closes the incident after the specified time.
40+
- Auto-close after stopping new alert merging: Starts timing from the last new alert merge and automatically closes the incident after the specified time.
3941
- **Access Level:** The channel is visible to which users, **public** means all users can view and operate incidents within the channel, **private** means only the creator, management team, and main account can view and operate incidents within the channel.
4042
- If incident assignment planning isn't ready, you can **skip setting escalation rules** and configure them after creation.
4143
- Integration types added during creation are **exclusive integrations** that only apply to this channel and can be configured later after creation.
4244

45+
:::caution
46+
Auto-close after stopping new alert merging is generally effective in alert grouping scenarios. For example, if grouping strategies are enabled within this channel, the alert closing time will be determined based on when the last alert was grouped into the incident.
47+
48+
:::
49+
4350
## Managing Channels
4451
---
4552
### Channel Overview
@@ -78,4 +85,5 @@ Log in to the console and navigate to: **Incident Management => Channel => Creat
7885
- Alert grouping combines similar or related alerts into one incident.
7986
- Configure grouping by alert title, severity, or label dimensions.
8087
- Incident suppression automatically blocks notifications for identical incidents within a time period.
88+
- Flapping detection can automatically suppress notifications for identical incidents within a time period.
8189
- For more about **reduce noise**, see [Reduce Noise Settings](https://docs.flashcat.cloud/en/flashduty/noise-reduction-settings?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).

flashduty/en/1. On-call/4. Configure On-call/4.10 Alert Routing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Configuration path: **Integration Center => Alert Events => Select Integration D
2525
**6. Insert Routes:** With multiple routing rules, you can insert new routes before or after existing ones, eliminating the need to adjust order manually.
2626
**7. Default Route:** Shared integrations require at least one routing rule to receive alerts. A default routing rule is provided to distribute alerts to corresponding channels when no rules are configured or matched.
2727
**8. Target Channels:** You can select multiple channels to receive matched alerts.
28+
**9. Edit History:** Supports viewing historical configurations and quickly restoring to a specific version (the configuration button only appears when routes have been edited multiple times).
2829

2930
<img src="https://download.flashcat.cloud/flashduty/doc/en/fd/route-1.png" alt="drawing" width="800"/>
3031

flashduty/en/1. On-call/4. Configure On-call/4.2 Integrate Alerts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Access path for Private Integration: **Channel Details => Integrations => Privat
2626

2727
### Shared Integration
2828
Access path for shared integration: **Integration Center => Alert Events**.
29+
- When creating an integration, you can select the management team for that integration. If a management team is configured, only tenant administrators and team members will have permission to edit/configure that integration.
2930
- Alert event types created in the Integration Center are global and **must use routing rules to direct alerts to one or multiple channels**.
3031
- Each integration **must be configured with at least one receiving channel, otherwise the integration will not be effective and cannot receive alert events**.
3132
- Shared integrations can be configured with [label enrichment](https://docs.flashcat.cloud/en/flashduty/label-enrichment-settings?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5), [alert Pipeline](https://docs.flashcat.cloud/en/flashduty/alert-pipelines?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5), [routing rules](https://docs.flashcat.cloud/en/flashduty/alert-routings?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5).

flashduty/en/1. On-call/4. Configure On-call/4.3 Alert Noise Reduction.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Flashduty provides two alert grouping modes, **Intelligent Grouping** and **Rule
3535

3636
- **Intelligent Grouping:** When a newly triggered alert is highly similar to an active incident's content, the alert will be merged into the incident.
3737

38-
<img src="https://download.flashcat.cloud/flashduty/doc/en/fd/noise-4.png" alt="drawing" width="800"/>
38+
<img src="https://download.flashcat.cloud/flashduty/doc/en/fd/aggr-3.png" alt="drawing" width="800"/>
3939

4040
### Rule-based Grouping
4141

@@ -74,6 +74,15 @@ Through the console's incident details page, we can see the final [Incident-Aler
7474

7575
<img src="https://download.flashcat.cloud/flashduty/doc/en/fd/noise-2.png" alt="drawing" width="800"/>
7676

77+
## Flapping Detection
78+
---
79+
80+
The system will only mark an incident as flapping when the same incident frequently triggers and recovers, and flapping detection is enabled. A "same incident" refers to incidents with the same Alert Key. The calculation method for Alert Key may vary across different alert sources, typically using the alert ID pushed from upstream systems as the unique identifier for the incident.
81+
82+
- **Disabled by default:** No flapping detection is performed.
83+
- **Remind Only:** Incidents entering flapping state will continue to be notified according to the assignment strategy, serving as a reminder only.
84+
- **Remind and Suppress:** Incidents entering flapping state will not trigger notifications after the initial alert.
85+
7786
## FAQ
7887
---
7988

flashduty/en/1. On-call/4. Configure On-call/4.9 Preferences.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ url: "https://docs.flashcat.cloud/en/flashduty/preference-settings"
1212
<Video width="200" style="width: 140px;" src="https://download.flashcat.cloud/flashduty/video/preference.mp4"></Video>
1313
-->
1414

15-
## Account Center
15+
## Personal Center
1616
---
17-
- Access Account Center: Hover over the user icon in the top right corner and select Account Settings.
17+
- Access Personal Center: Hover your mouse over the user icon in the bottom left corner, select Basic Information, or click Platform Management in the bottom left corner.
1818
- View your account's personalized settings and configure personal contact information, account password, APP Key, notification methods, etc.
1919
- You can configure the following items in Account Settings:
2020
- Basic Information: Such as nickname, email, password, etc.
@@ -23,13 +23,20 @@ url: "https://docs.flashcat.cloud/en/flashduty/preference-settings"
2323

2424
<img src="https://download.flashcat.cloud/flashduty/doc/en/fd/pre-1.png" alt="drawing" width="800"/>
2525

26-
## Account Information
26+
## Basic
2727
---
2828
- There are two types of account identities: primary account and member account.
2929
- Account nicknames support both Chinese and English characters, mainly used for display purposes.
3030
- Verification code is required when modifying email or phone.
3131
- Currently supported regions for phone numbers: mainland China, United States, Canada, Indonesia, Germany, Malaysia, Australia, Singapore, Thailand, Russia, South Korea, Saudi Arabia, Vietnam, Japan.
3232

33+
34+
## Notification Methods
35+
---
36+
- Different notification methods can be configured for different alert severity levels.
37+
- Notifications will follow personal preferences **only when incidents are directly assigned to an individual, or when assigned through an escalation rule with personal chat enabled and set to follow personal preferences**.
38+
- When configuring IM applications like Dingtalk, WeCom, or Feishu/Lark, you need to first associate the application to receive corresponding notifications.
39+
3340
## APP Key
3441
---
3542
- APP key is an essential credential for API requests.
@@ -43,11 +50,13 @@ url: "https://docs.flashcat.cloud/en/flashduty/preference-settings"
4350

4451
:::
4552

46-
## Notification Methods
53+
54+
## Flashduty APP
4755
---
48-
- Different notification methods can be configured for different alert severity levels.
49-
- Notifications will follow personal preferences **only when incidents are directly assigned to an individual, or when assigned through an escalation rule with personal chat enabled and set to follow personal preferences**.
50-
- When configuring IM applications like Dingtalk, WeCom, or Feishu/Lark, you need to first associate the application to receive corresponding notifications.
56+
- iOS users can download the app from the App Store, while Android users can download it from major app stores (HarmonyOS is not currently supported).
57+
- After downloading, open the Flashduty APP and choose different login methods. Once logged in, your account will be linked.
58+
- Regarding app settings: You need to enable system notifications, and in Do Not Disturb mode, you can allow notifications for urgent incidents.
59+
5160

5261

5362
## FAQ

flashduty/zh/1. On-call/1. 快速开始/1.3 常见问题.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,27 +19,28 @@ url: "https://docs.flashcat.cloud/zh/flashduty/frequently-asked-questions"
1919
</details>
2020

2121
<details>
22-
<summary> 活跃用户和非活跃用户是什么?</summary>
22+
<summary> Flashduty On-call 的收费模式 </summary>
2323

24+
<summary> Flashduty On-call 的收费模式 </summary>
2425

25-
FlashDuty 的收费模式是基于购买的 License 数量,每个 License 对应一个活跃用户账号。例如,如果您只购买了一个 License,则仅有一个成员可以作为活跃用户使用 FlashDuty 的全部功能。不过您仍然可以邀请更多成员加入,但只有拥有 License 的成员才能成为活跃用户,其他成员将被视为非活跃用户,无法享受全部功能。具体区别如下:
2626

27-
#### 活跃用户
27+
Flashduty On-call 的收费模式是基于购买的 License 数量,每个 License 可以对应一个账户成员。例如,您只购买了一个 License,则仅有一个成员可以使用 Flashduty On-call 的全部功能。不过您仍然可以邀请更多成员加入,但只有拥有 License 的成员才能成对平台进行操作配置,其他成员则**无法使用平台任何功能**(仅限于接收故障通知)。具体区别如下:
2828

29-
- 当月使用过本产品的用户算作一个活跃用户,每一个活跃用户占用一个 License,下月开始时重新计算。
30-
- 只要登录就会抢占一个 License,即成为活跃用户。
31-
- 当一个活跃用户被删除,其对应 License 会被释放。
32-
- 活跃用户拥有所有功能的使用权限(但受限于版本和角色权限限制)。
33-
- 活跃用户可以将自己本身的 License 转移给其他非活跃用户。
29+
#### License 分配方式
3430

31+
- 管理者可以通过主动分配的方式,将 License 分配给不同成员。
32+
- 在分配 License 的时候,可以设置 License 的类型。
33+
- 固定类型:在购买有效期内长期有效,不会被抢占,适用于需要参与处理故障、参与配置业务的场景。
34+
- 临时类型:每个周期结束时自动释放,在有足够 License 的情况下,可以通过分配或抢占的模式占用。
3535

36-
#### 非活跃用户
36+
#### 无 License 的成员
37+
38+
- 不能使用任何功能,包括查看故障列表/详情,**只能被动接收告警消息**,比如将故障消息通过邮件、短信、电话等IM群消息的方式通知到该成员。
39+
- 在配置分派策略的时候是可以选择将故障消息通知给没有 License 的成员。
40+
- 没有 License 的成员,即使接收到故障消息,也无法对其进行查看、关闭等操作。
41+
- 没有 License 的成员共享租户的的邮件、短信、电话套餐额度。
42+
- 没有 License 的成员在登录控制台进行查看/处理等操作的时候,会提示没有权限。
3743

38-
- 非活跃用户不拥有任何功能的使用权限,包括查看故障列表/详情,**只能被动接收告警消息**,比如将故障消息通过邮件、短信、电话等IM群消息的方式通知到该成员。
39-
- 在配置分派策略的时候是可以选择将故障消息通知给非活跃用户的。
40-
- 非活跃用户即使接收到故障消息,也无法对其进行查看、关闭等操作。
41-
- 非活跃用户共享活跃用户的邮件、短信、电话套餐额度。
42-
- 非活跃用户在登录控制台进行查看/处理等操作的时候,会提示没有权限。
4344

4445
</details>
4546

flashduty/zh/1. On-call/2. 故障管理/2.7 了解告警降噪.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ Flashduty 提供了两种聚合模式,分别是 **智能聚合** 和 **规则
5454

5555
#### 智能聚合
5656

57-
- **智能聚合:** 当新触发告警与活跃故障的内容高度相似时,将告警合入故障。
57+
- **智能聚合:** 当新触发告警与活跃故障的内容高度相似时,将告警合入故障,支持指定参与计算的字段,至多10个,请合理选择
5858

59-
<img src="https://download.flashcat.cloud/flashduty/doc/aggr-3.png" width="600">
59+
<img src="https://download.flashcat.cloud/flashduty/doc/zh/fd/aggr-3.png" width="600">
6060

6161

6262
#### 规则聚合

flashduty/zh/1. On-call/3. 配置管理/4.1 协作空间管理.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/channel-settings"
99

1010
## 视频介绍
1111
---
12-
<Video src="https://download.flashcat.cloud/flashduty/video/channel.mp4"></Video>
12+
<Video width="200" style="width: 140px;" src="https://download.flashcat.cloud/flashduty/video/channel.mp4"></Video>
1313

1414
## 创建协作空间
1515
---
@@ -32,18 +32,24 @@ url: "https://docs.flashcat.cloud/zh/flashduty/channel-settings"
3232
- **空间名称:** 建议以部门、小组、业务类型进行命名和规划,以便更直观的了解该空间的用途。
3333
- **描述信息:** 建议简单概述该空间所承接的业务以及接入哪种类型的告警。
3434
- **管理团队:** 创建时可以设置该空间的管理团队,**团队所属成员对该空间有全部操作权限**,非创建者对该空间的配置只读。
35-
- **超时自动关闭:** 即超过N分钟未关闭的故障**系统会将其自动关闭**(对该空间下所有新故障生效),超时关闭的故障也**会有相应的关闭通知**(通知渠道取决于[分派策略](https://docs.flashcat.cloud/zh/flashduty/escalate-rule-settings)的配置)。
35+
- **超时自动关闭:**
36+
- 故障触发后自动关闭:从故障首次触发开始计时,到达指定时间后自动关闭故障。
37+
- 停止合入新告警后自动关闭:从最后一次合入新告警开始计时,到达指定时间后自动关闭故障。
3638
- **访问级别:** 即该空间对哪些用户可见,**公开** 表示对账户内所有用户可见,**私有** 表示仅对创建者、管理团队以及主体账户可见。
3739
- 未规划好该空间的故障如何分派时,可以**跳过设定分派策略**,创建完成后可以继续配置分派策略。
3840
- 创建时接入的集成类型**属于专属集成**,仅对该空间生效,同样可以忽略且创建完成后进行配置。
3941

42+
:::caution
43+
停止合入新告警后自动关闭,一般是在聚合告警场景下有效,比如该协作空间内开启了聚合策略,则告警关闭的时间点会按照最后一条告警被聚合进故障的时间来确定。
44+
45+
:::
4046

4147
## 管理协作空间
4248
---
4349
### 空间概览
4450
- 账户成员可以看到全部协作空间,但只能操作其负责的协作空间。
4551
- 鼠标悬放在某个协作空间处,点击五角星即可完成**收藏和取消收藏**
46-
- 默认看到的是全部协作空间,可以**通过"我管理的"、"我收藏的"查看与“我”有关的协作空间**
52+
- 默认看到的是全部协作空间,可以**按照团队维度进行筛选或点击"我收藏的"查看与“我”有关的协作空间**
4753
- 当协作空间很多,但自己关注的空间排序比较靠后时,可以**通过右上角的排序功能将自己关注的协作空间往前排序**
4854
- 排序时可以自由编排,且**只对当前用户生效,不影响其他用户**
4955

@@ -77,5 +83,5 @@ url: "https://docs.flashcat.cloud/zh/flashduty/channel-settings"
7783
### 降噪配置
7884
- 聚合降噪是将相似或相关联的告警进行合并为一个故障。
7985
- 可以根据告警标题、告警级别、标签维度进行配置聚合。
80-
- 故障收敛可以将某段时间内相同的故障自动屏蔽通知
86+
- 抖动检测可以将某段时间内相同的故障自动屏蔽通知
8187
- 更多**降噪配置**相关请参考[降噪配置](https://docs.flashcat.cloud/zh/flashduty/noise-reduction-settings)部分。

0 commit comments

Comments
 (0)