Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion flashduty/en/1. On-call/2. Incidents/2.2 View Incidents.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Flashduty provides two entry points to view the incident list: one within the ch
8. **Pagination Settings**: Adjust page numbers and items per page.

:::highlight orange 💡
For performance reasons, when search conditions match more than **1000** incidents, the system only shows 1000+, rather than an exact number. Therefore, you can only view 1000 incidents through pagination. If you need to view more, please adjust your search time interval or use the [Incident Query](https://developer-en.flashcat.cloud/api-110655782) API to get all data.
For performance reasons, when search conditions match more than **1000** incidents, the system only shows 1000+, rather than an exact number. Therefore, you can only view 1000 incidents through pagination. If you need to view more, please adjust your search time interval or use the [Incident Query](https://docs.flashcat.cloud/en/api-reference/on-call/incidents/incident-list) API to get all data.
:::

### Using Group Views
Expand Down
2 changes: 1 addition & 1 deletion flashduty/en/1. On-call/2. Incidents/2.6 Custom Actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ After creation, you can find the action button under [Incident Details-More Acti
<img src="https://download.flashcat.cloud/flashduty/doc/en/fd/action-1.png" alt="drawing" width="800"/>
### How to implement webhook?

Visit [Webhook Getting Started](https://developer-en.flashcat.cloud/doc-2996930) to learn more.
Visit [Webhook Getting Started](https://docs.flashcat.cloud/en/on-call/integration/webhooks/incident-webhook) to learn more.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Each alert event in the integration center has label enrichment configuration op
### Types of Label Enrichment
- **Extract:** Using regular expressions to extract needed information from alert titles, detailed descriptions, and existing label fields to automatically generate additional labels.
- **Compose:** Composition rules can build new labels using Go template syntax, extracting label values with {{.Labels.Field}} format or generating new labels using fixed values.
- **Map:** Maps source key-value pairs to new key-value pairs through mapping relationships. Requires pre-creating [schema](https://developer-en.flashcat.cloud/api-142409927) mapping relationships and [uploading metadata](https://developer-en.flashcat.cloud/api-145679479) before configuration. See configuration examples below.
- **Map:** Maps source key-value pairs to new key-value pairs through mapping relationships. Requires pre-creating [schema](https://docs.flashcat.cloud/en/api-reference/on-call/alert-enrichment/mapping-schema-write-create) mapping relationships and [uploading metadata](https://docs.flashcat.cloud/en/api-reference/on-call/alert-enrichment/mapping-data-write-upsert) before configuration. See configuration examples below.
- **Delete:** Removes labels with specified names. If the label to be deleted doesn't exist, the operation is ineffective.

![2025-09-22-13-56-46](https://docs-cdn.flashcat.cloud/images/png/51492ca5b84e5f84f1b90c0c7c13800a.png)
Expand Down Expand Up @@ -132,6 +132,6 @@ In the mapping table details page, you can manage the mapping table data, includ

::: tip

If you do not want the source label to exist, you can achieve this through the delete rule. Also, label mapping supports API management, which can be referred to [Label Mapping API](https://developer-en.flashcat.cloud/api-142429470).
If you do not want the source label to exist, you can achieve this through the delete rule. Also, label mapping supports API management, which can be referred to [Label Mapping API](https://docs.flashcat.cloud/en/api-reference/on-call/alert-enrichment/mapping-data-write-upsert).

:::
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ url: "https://docs.flashcat.cloud/en/flashduty/customize-incident-attrs"

By referencing alert labels and attributes, you can customize incident severity and title information. This feature is mainly used in the following two scenarios:

1. When reporting custom alert events using the [Alert Event API](https://developer-en.flashcat.cloud/en/flashduty/event-api/alert-event?nav=01JCQ7A4N4WRWNXW8EWEHXCMF5), you can use the `title_rule` field to customize the alert title.
1. When reporting custom alert events using the [Alert Event API](https://docs.flashcat.cloud/en/on-call/integration/alert-integration/alert-sources/standard alert), you can use the `title_rule` field to customize the alert title.

```
# Example: Specify resource and check labels as alert title
Expand Down
4 changes: 2 additions & 2 deletions flashduty/en/1. On-call/6. Advanced/6.3 Insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,14 @@ Export incident list data in CSV format, supporting incident list, team, channel
</div>

#### Export Limitations
- Incident list exports exclude Labels data; for more detailed data, use the [Incident List](https://developer-en.flashcat.cloud/api-110655782) API.
- Incident list exports exclude Labels data; for more detailed data, use the [Incident List](https://docs.flashcat.cloud/en/api-reference/on-call/incidents/incident-list) API.
- Maximum query and export limit is 100,000 records; for more data, export in time segments.

### FAQ

<details>
<summary>How to query older data?</summary>
The insights dashboard currently supports querying last 180 days of data. For older data, use the [API query](https://developer-en.flashcat.cloud/api-213441443).
The insights dashboard currently supports querying last 180 days of data. For older data, use the [API query](https://docs.flashcat.cloud/en/api-reference/on-call/analytics/insight-incident-list).
</details>

<details>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Field|Required|Type|Description
Field|Required|Type|Description
:-:|:-:|:-:|:---
| alt | No | string | Image alternative text, limit 128 characters, truncated if exceeded.
| src | Yes | string | Image source, value: http/https URL or image_key returned by [Image Upload API](https://developer.flashcat.cloud/api-344943718). Limit 256 characters, discarded if exceeded
| src | Yes | string | Image source, value: http/https URL or image_key returned by Image Upload API. Limit 256 characters, discarded if exceeded
| href | No | string | Hyperlink reference path, limit 256 characters, truncated if exceeded

</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Flashduty has already adapted webhook protocols for several commonly used ticket
## Implementation Protocol
---

Please refer to the [Developer Documentation](https://developer-en.flashcat.cloud/en/flashduty/event-api/change-event) to complete the protocol development.
Please refer to the [Developer Documentation](https://docs.flashcat.cloud/en/on-call/integration/change-integration/custom-event) to complete the protocol development.

## Best Practices
---
Expand Down
2 changes: 1 addition & 1 deletion flashduty/en/5. Platform/1. Teams and Members.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ After deletion, other associated paths will become invalid immediately and canno
### Invitation Methods

- The console only supports email invitations, with the username defaulting to the email prefix, which can be modified in account settings after activation
- You can send invitations through [Open API](https://developer-en.flashcat.cloud/api-110655699), which supports phone invitations
- You can send invitations through [Open API](https://docs.flashcat.cloud/en/api-reference/platform/members/member-invite), which supports phone invitations
- The system will send SMS or email to invited colleagues, with a daily invitation limit of 200 people and a maximum of 10 people per invitation
- Additionally, you can contact the organization administrator to configure SSO, where new member accounts are created automatically upon login
- After sending an invitation, the account will be activated upon the recipient's login. Unactivated accounts cannot receive alert notifications
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Flashduty 提供了两个入口查看故障列表。一个是协作空间内,
8. **分页设置**:分页和单页条数调整。

:::highlight orange 💡
为了提升性能,当检索条件匹配到超过 **1000** 条故障,系统仅展示1000+,而不是精确的数字。因此,您通过跳页,也只能查看1000条故障,如果需要查看更多,请调整你的检索时间区间。或通过 [故障查询](https://developer.flashcat.cloud/api-110655782) API 获取全部数据。
为了提升性能,当检索条件匹配到超过 **1000** 条故障,系统仅展示1000+,而不是精确的数字。因此,您通过跳页,也只能查看1000条故障,如果需要查看更多,请调整你的检索时间区间。或通过 [故障查询](https://docs.flashcat.cloud/zh/api-reference/on-call/incidents/incident-list) API 获取全部数据。
:::

### 使用聚合视图
Expand Down Expand Up @@ -69,7 +69,7 @@ Flashduty 提供各种维度的筛选能力,并给您足够多的灵活度。
2. **操作区域**:各类高频操作按钮,在更多操作中,包含了自定义操作和低频操作按钮,其中创建作战室需要在IM集成中开启[作战室](https://docs.flashcat.cloud/zh/flashduty/war-room)。
3. **详细信息**:故障的描述、标签信息,其中AI总结可以快速提炼故障详情,并以事件概况、影响范围、可行措施三个维度进行输出,标签内容支持拖拽排序和以JSON视图展示。
4. **关联告警**:故障所关联的所有被[聚合](https://docs.flashcat.cloud/zh/flashduty/noise-reduction-settings)的告警,支持按处理进度筛选,以及支持视图切换。
5. **综合信息**:展示该故障的属性、处理状态、[图片](https://developer.flashcat.cloud/api-344943718)以及处理人员信息
5. **综合信息**:展示该故障的属性、处理状态、图片以及处理人员信息
6. **自定义字段**:自定义字段配置区域。

您可以切换上方 Tab 页,查看更详细的 **关联告警**,**时间线**,以及 **历史变更**,用于故障根因定位。对于已关闭的故障,系统还会展示 **问题修复** 页面,用于展示故障的根因和解决办法。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ url: "https://docs.flashcat.cloud/zh/flashduty/custom-actions"

### 如何实现 webhook?

前往 [Webhook 入门](https://developer.flashcat.cloud/doc-2996930)。了解更多。
前往 [Webhook 入门](https://docs.flashcat.cloud/zh/on-call/integration/webhooks/incident-webhook)。了解更多。
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,6 @@ Flashduty 故障详情中的故障标签以 key:value 的形式展示告警的

::: tip

如果不希望源标签还存在,可以通过删除规则实现。以及标签映射也支持API进行管理,具体可以参考[标签映射API](https://developer.flashcat.cloud/api-142429470)。
如果不希望源标签还存在,可以通过删除规则实现。以及标签映射也支持API进行管理,具体可以参考[标签映射API](https://docs.flashcat.cloud/zh/api-reference/on-call/alert-enrichment/mapping-data-write-upsert)。

:::
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ EndTime | int64 | 否 | 恢复时间,Unix 秒时间戳,默认为 0

10. **如何通过图片[Image](#Image)的 Src 属性获取对应的图片 URL**
- imageSrcToURL 可以实现,入参: $root 和 Src
- 若 Src 是 [图片上传](https://developer.flashcat.cloud/api-344943718)接口的 image_key, 则 转换成短时间内可访问的地址
- 若 Src 是 图片上传接口的 image_key, 则 转换成短时间内可访问的地址
- 若 Src 是 http/https 可访问地址,则直接返回该地址
- 钉钉/Slack App 使用本函数来展示图片
```
Expand All @@ -260,7 +260,7 @@ EndTime | int64 | 否 | 恢复时间,Unix 秒时间戳,默认为 0

11. **如何将图片转换并上传到第三方通知平台**
- transferImage 可以实现,入参: $root 和 Src
- Src 可以是 [图片上传](https://developer.flashcat.cloud/api-344943718) 接口的 image_key 或者 http/https 可访问图片地址
- Src 可以是 图片上传 接口的 image_key 或者 http/https 可访问图片地址
- 图片大小不能超过 10 MB
- 支持上传 JPG、JPEG、PNG、WEBP、GIF、BMP、ICO、TIFF、HEIC 格式的图片
- 需要开启 应用 获取与上传图片或文件资源 权限
Expand Down
2 changes: 1 addition & 1 deletion flashduty/zh/1. On-call/4. 高级功能/1. 引用变量.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/customize-incident-attrs"

通过引用告警标签、属性的变量,实现对故障的严重程度和标题以及描述等信息的修改与定制。主要应用在两种场景:

1. 通过告警 [Event API](https://developer.flashcat.cloud/zh/flashduty/event-api/alert-event) 上报自定义告警事件时,可以使用 title_rule 字段自定义告警的标题。
1. 通过告警 [Event API](https://docs.flashcat.cloud/zh/on-call/integration/alert-integration/alert-sources/standard alert) 上报自定义告警事件时,可以使用 title_rule 字段自定义告警的标题。

```
# 示例:指定resource和check标签作为告警标题
Expand Down
4 changes: 2 additions & 2 deletions flashduty/zh/1. On-call/4. 高级功能/3. 分析数据.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,14 @@ url: "https://docs.flashcat.cloud/zh/flashduty/insights"

#### 导出限制

- 故障列表导出时,不包含 Labels 数据,如果需要更详细的数据,建议通过[故障列表](https://developer.flashcat.cloud/api-110655782)的 API 查询。
- 故障列表导出时,不包含 Labels 数据,如果需要更详细的数据,建议通过[故障列表](https://docs.flashcat.cloud/zh/api-reference/on-call/incidents/incident-list)的 API 查询。
- 数据列表的查询和导出的数据量最大是 10 万条,如果需要更多数据,建议分时间段导出。

### 常见问题

<details>
<summary> 想要查询更久的数据怎么办?</summary>
目前分析看板中仅支持查询最近180天的数据,如果需要查询更久的数据,可以通过 [API 查询](https://developer.flashcat.cloud/api-213441443)。
目前分析看板中仅支持查询最近180天的数据,如果需要查询更久的数据,可以通过 [API 查询](https://docs.flashcat.cloud/zh/api-reference/on-call/analytics/insight-incident-list)。
</details>

<details>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ POST, Content-Type:"application/json"
字段|必含|类型|释义
:-:|:-:|:-:|:---
| alt | 否 | string | 图片的替代文本, 长度限制 128 字符,超长截断。
| src | 是 | string | 图片来源,值:http/https 开头的图片链接地址 或 [图片上传接口](https://developer.flashcat.cloud/api-344943718)返回的image_key,长度限制 256 字符,超长会被丢弃
| src | 是 | string | 图片来源,值:http/https 开头的图片链接地址 或 图片上传接口返回的image_key,长度限制 256 字符,超长会被丢弃
| href | 否 | string | 超链接引用路径,长度限制 256 字符,超长截断

</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Flashduty 已经适配部分常用工单、部署系统的 webhook 协议,对
## 实现协议
---

请您参照 [开发文档](https://developer.flashcat.cloud/zh/flashduty/event-api/change-event) 完成协议开发。
请您参照 [开发文档](https://docs.flashcat.cloud/zh/on-call/integration/change-integration/custom-event) 完成协议开发。

## 最佳实践
---
Expand Down
2 changes: 1 addition & 1 deletion flashduty/zh/5. 平台功能/1. 团队和成员.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/teams-and-members"
### 邀请方式

- 控制台仅支持邮件邀请,用户昵称默认为邮箱前缀,可在激活后进入账户设置页面修改
- 您可以通过 [Open API](https://developer.flashcat.cloud/api-110655699) 进行邀请,支持手机号邀请
- 您可以通过 [Open API](https://docs.flashcat.cloud/zh/api-reference/platform/members/member-invite) 进行邀请,支持手机号邀请
- 系统会向被邀请的同事发送短信或邮件,每天邀请数量上限为 200 人,单次邀请至多 10 人
- 除了以上方式,您也可以联系组织管理员配置单点登录,新成员登录自动创建账号
- 向对方发生邀请后,对方登录即可激活账号,未激活之前账号无法接收告警相关通知
Expand Down