Skip to content

Commit b5ca90f

Browse files
authored
Merge pull request #194 from flashcatcloud/automation/doc-review-20260720-201703
docs: sync doc-review findings
2 parents a98b0b1 + 58a8189 commit b5ca90f

10 files changed

Lines changed: 118 additions & 8 deletions

File tree

‎en/ai-sre/sessions.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Sessions are isolated from one another: context, bound team, and environment do
2727

2828
The left sidebar is the single entry point for sessions. Click **New Chat** to start a fresh session. The list is sorted by most recent activity in descending order; only the most recent entries are shown initially, and older history is revealed incrementally with **Show more**.
2929

30+
In a blank AI SRE session, four scenario suggestion cards appear above the composer: **Investigate an incident**, **Query data with natural language**, **Reduce alert noise**, and **Schedule an automated inspection**. Selecting a card only fills the composer; it does not send the prompt. You can edit it before pressing Enter.
31+
3032
### Search and Filter
3133

3234
<Steps>
@@ -100,7 +102,7 @@ Type a message in the input box at the bottom and press Enter to send. The input
100102
Click the plus button at the lower left of the input box to choose files, or paste images directly. Supported formats include images, PDFs, text / Markdown / CSV, and Office documents (Word / Excel / PowerPoint), up to **20 MB** per file. A single message can carry at most **9 attachments**, and the total size of all attachments in one message cannot exceed **50 MB**; exceeding either limit shows a corresponding message. Screenshots can be pasted directly into the chat.
101103
</Accordion>
102104
<Accordion title="Context references" icon="link">
103-
When you enter AI SRE from an incident, alert, monitor rule, or host page, the related object is embedded into the input box as a **reference capsule** — a small inline tag indicating the kind of object referenced — an incident, alert event, alert, monitor rule, or host — that travels with the message so the agent can start its analysis from that object directly. Click the capsule to open the referenced object in a new tab, or click its close button to remove the reference before sending. A single message can carry multiple references. Besides objects carried in automatically from a related page, you can also type `@` directly in any session's input box to trigger an incident search dropdown (supporting fuzzy keyword search and a list of recent incidents); selecting one inserts the same kind of reference capsule — a standalone entry point available at any time.
105+
When you enter AI SRE from an incident, alert, monitor rule, or host page, the related object is embedded into the input box as a **reference capsule** — a small inline tag indicating the kind of object referenced — an incident, alert event, alert, monitor rule, host, or on-call analytics — that travels with the message so the agent can start its analysis from that object directly. Click the capsule to open the referenced object in a new tab, or click its close button to remove the reference before sending. A single message can carry multiple references. Besides objects carried in automatically from a related page, you can also type `@` directly in any session's input box to trigger an incident search dropdown (supporting fuzzy keyword search and a list of recent incidents); selecting one inserts the same kind of reference capsule — a standalone entry point available at any time.
104106
</Accordion>
105107
<Accordion title="Knowledge and skills" icon="book">
106108
When a session starts, the knowledge packs and skills for the bound team are loaded automatically. See <a href="/en/ai-sre/knowledge">Knowledges</a> and <a href="/en/ai-sre/skills">Skills</a> for details.

‎en/developer/cli.mdx‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,9 +220,9 @@ flashduty status-page migration-cancel <job-id>
220220

221221
Other available subcommands: `change-delete`, `change-info`, `change-list`, `change-timeline-delete`, `change-timeline-update`, `change-update`, `component-upsert`, `component-delete`, `section-upsert`, `section-delete`, `info`, `subscriber-list`, `subscriber-import`, `subscriber-export`, `template-list`, `template-upsert`, `template-delete`.
222222

223-
### rum — RUM application management
223+
### rum — RUM applications and session replay
224224

225-
Use these commands to manage RUM applications themselves, rather than querying individual RUM events. The current surface covers application detail, batch reads, listing, webhook testing, and create/update/delete operations.
225+
Use these commands to manage RUM applications and export session replay data. The application commands cover detail, batch reads, listing, webhook testing, and create/update/delete operations.
226226

227227
```bash
228228
flashduty rum application-info <application-id> # Get one application's detail
@@ -260,6 +260,33 @@ Core fields for `application-create` / `application-update`:
260260
`application-webhook-test` returns `ok`, `status_code`, and `message`, which makes it suitable for verifying that a RUM alert webhook really accepts a sample delivery from Flashduty.
261261
</Note>
262262

263+
#### Session replay
264+
265+
```bash
266+
flashduty rum session-replay-metadata <session-id> # Get the application, device, session-boundary, and view metadata for a replayable session
267+
flashduty rum session-replay-segments <session-id> # Read session replay segments
268+
```
269+
270+
For `session-replay-metadata`, use `--ts` to supply the session-start Unix timestamp in milliseconds when you need to disambiguate a reused session ID from different time windows.
271+
272+
Common `session-replay-segments` flags:
273+
274+
| Flag | Description |
275+
|------|-------------|
276+
| `--limit` | Number of segments to return, from 1 to 99; default: 20. |
277+
| `--search-after-ctx` | Pagination cursor from the previous page. In URL mode, read `search_after_ctx`; in streaming mode, read the `X-Search-After-Ctx` response header. |
278+
| `--ts` | Without `--search-after-ctx`, begin at the most recent full-snapshot segment at or before this timestamp. |
279+
| `--url-mode` | When `true`, return JSON containing presigned download URLs. By default it is `false` and streams segment bytes directly. URLs are valid for one hour. |
280+
| `--view-id` | Return segments for one view only; omit it to page through the whole session. |
281+
282+
### oncall — On-call licenses
283+
284+
```bash
285+
flashduty oncall license-list # List people with active On-call licenses in the current account
286+
```
287+
288+
This read-only command returns each person's ID, name, and license type: `fixed` is explicitly assigned, while `temporary` is active for the current temporary-license window.
289+
263290
### template — Notification templates
264291

265292
```bash

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,28 @@ Self-signed certificate and TLS client authentication configurations are also su
106106

107107
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.
108108

109+
## Reference credentials locally in Edge
110+
111+
With Edge `v0.46.0` or later, you can use environment variable references in supported data-source connection fields instead of placing credentials directly in the data-source configuration. Edge resolves each reference in its local process; the resolved credential is never written back to the synced data-source configuration, debug output, or API payloads.
112+
113+
<Steps>
114+
<Step title="Set environment variables for the Edge process">
115+
Set credentials in the environment of every Edge process that queries this data source. For example, set `SLS_ACCESS_KEY_ID` and `SLS_ACCESS_KEY_SECRET` for SLS. Restart the Edge process after changing its environment so the new values take effect.
116+
</Step>
117+
<Step title="Enter references in the data-source form">
118+
When editing a data source, enter `${env:VARIABLE_NAME}` in a supported authentication or connection field. For example, enter `${env:SLS_ACCESS_KEY_ID}` for the SLS **AccessKey ID** and `${env:SLS_ACCESS_KEY_SECRET}` for the **AccessKey Secret**.
119+
</Step>
120+
<Step title="Save and test">
121+
Save the data source, then use **Test** to verify the connection. Each referenced variable must exist in the corresponding Edge process environment.
122+
</Step>
123+
</Steps>
124+
125+
Variable names must start with an uppercase letter or underscore and may then contain only uppercase letters, digits, or underscores, such as `SLS_ACCESS_KEY_SECRET`.
126+
127+
<Warning>
128+
Environment variable references are not supported in the data-source **address**. They are also not supported in **Params** for Prometheus, Loki, or VictoriaLogs. Use this syntax only in supported authentication and connection fields.
129+
</Warning>
130+
109131
## Test a data source
110132

111133
In the data source list, click the **Test** button for the corresponding data source to open a query preview window, verify the connection, and preview query results.

‎en/monitors/targets/install-agent.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Prepare the following information before installation:
1313
| Item | Description |
1414
|---|---|
1515
| Agent package download URL | `https://static.flashcat.cloud/monitagent/monitagent-v0.0.20-linux-amd64.tar.gz`. For ARM CPUs, replace `amd64` with `arm64`. |
16-
| Edge address | For example, `ws://edge.example.com:6868` or `wss://edge.example.com:6868`. Edge version must be `>= v0.44.0`. View the Edge list and installation method [here](https://console.flashcat.cloud/monit/engine/list). |
16+
| Edge address | For example, `ws://edge.example.com:6868` or `wss://edge.example.com:6868`. Edge version must be `>= v0.46.0`. View the Edge list and installation method [here](https://console.flashcat.cloud/monit/engine/list). |
1717
| Local host object address | Use the current host's fixed private IP or DNS name, such as `10.0.1.12`. If omitted, the Agent uses the IP address associated with the local default route. |
1818
| Read-only accounts for databases and middleware | To diagnose MySQL, Redis, PostgreSQL, MongoDB, Kafka, Elasticsearch, and other services, prepare read-only accounts and credentials in advance. |
1919

‎en/rum/explorer/data-query.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ When you do not want to write DQL by hand, let AI turn a natural-language reques
4242
Time expressions such as “last hour,” “yesterday,” and “past 7 days” update the Explorer time picker; they are not written as DQL conditions such as `client_time`. Performance-duration conditions remain DQL, for example `view_loading_time:>2s`.
4343
</Note>
4444

45+
<Note>
46+
AI natural-language queries support a maximum time range of **14 days**. If the requested range is longer, the preview indicates that it has been truncated to the most recent 14 days; after you apply it, the time picker uses that truncated range. A relative range becomes the past 14 days, while an absolute range keeps the requested end time and starts 14 days earlier.
47+
</Note>
48+
4549
## Full-Text Search
4650

4751
<Warning>

‎zh/ai-sre/sessions.mdx‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ sidebarTitle: 控制台
2727

2828
左侧边栏是会话的统一入口。点击 **新对话** 即可开启一个全新会话;列表按最近活动倒序排列,初始显示最近的若干条,更多历史通过 **显示更多** 逐步展开。
2929

30+
在空白的 AI SRE 新会话中,输入框上方会显示四张场景建议卡片:**排查一个故障**、**用自然语言查数据**、**治理告警噪音**和**定时自动巡检**。点击卡片只会把预置提示填入输入框,不会立即发送;你可以修改后再按 Enter。
31+
3032
### 搜索与筛选
3133

3234
<Steps>
@@ -100,7 +102,7 @@ sidebarTitle: 控制台
100102
点击输入框左下角的加号按钮选择文件,或直接粘贴图片。支持图片、PDF、文本 / Markdown / CSV,以及 Office 文档(Word / Excel / PowerPoint),单个文件最大 **20MB**。单条消息最多上传 **9 个文件**,且全部附件总大小不超过 **50MB**;超出文件数或总大小上限时会分别给出提示。截图可直接在对话中粘贴。
101103
</Accordion>
102104
<Accordion title="上下文引用" icon="link">
103-
从故障、告警、监控规则或主机等页面进入 AI SRE 时,相关对象会作为**引用胶囊**自动嵌入输入框——它是一枚内联的小标签,标明所引用对象的类型——故障、告警事件、告警、监控规则或主机——并随消息一起发送给 Agent,让它直接基于该对象开始分析。点击胶囊可在新标签页打开对应对象;点击胶囊上的关闭按钮即可在发送前移除引用。一条消息可携带多个引用。除了从相关页面自动携带引用外,也可以在任意会话的输入框里直接输入 `@` 触发故障搜索下拉(支持关键词模糊匹配与近期故障列表),选中后插入与自动携带相同的引用胶囊——这是一个随时可用的独立引用入口。
105+
从故障、告警、监控规则或主机等页面进入 AI SRE 时,相关对象会作为**引用胶囊**自动嵌入输入框——它是一枚内联的小标签,标明所引用对象的类型——故障、告警事件、告警、监控规则、主机或告警分析——并随消息一起发送给 Agent,让它直接基于该对象开始分析。点击胶囊可在新标签页打开对应对象;点击胶囊上的关闭按钮即可在发送前移除引用。一条消息可携带多个引用。除了从相关页面自动携带引用外,也可以在任意会话的输入框里直接输入 `@` 触发故障搜索下拉(支持关键词模糊匹配与近期故障列表),选中后插入与自动携带相同的引用胶囊——这是一个随时可用的独立引用入口。
104106
</Accordion>
105107
<Accordion title="知识库与 Skill" icon="book">
106108
会话启动时会按绑定团队自动加载对应的知识库与 Skill;详见下文 <a href="/zh/ai-sre/knowledge">知识库</a> 与 <a href="/zh/ai-sre/skills">Skill</a>。

‎zh/developer/cli.mdx‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -220,9 +220,9 @@ flashduty status-page migration-cancel <job-id>
220220

221221
其他可用子命令:`change-delete`、`change-info`、`change-list`、`change-timeline-delete`、`change-timeline-update`、`change-update`、`component-upsert`、`component-delete`、`section-upsert`、`section-delete`、`info`、`subscriber-list`、`subscriber-import`、`subscriber-export`、`template-list`、`template-upsert`、`template-delete`。
222222

223-
### rum — RUM 应用管理
223+
### rum — RUM 应用与会话回放
224224

225-
用于管理 RUM 应用本身,而不是查询单条 RUM 事件。当前命令覆盖应用详情、批量读取、列表、Webhook 测试,以及创建、更新、删除。
225+
用于管理 RUM 应用和导出会话回放数据。应用命令覆盖详情、批量读取、列表、Webhook 测试,以及创建、更新、删除。
226226

227227
```bash
228228
flashduty rum application-info <application-id> # 查看单个应用详情
@@ -260,6 +260,33 @@ flashduty rum application-delete <application-id> # 删除应用
260260
`application-webhook-test` 会返回 `ok`、`status_code` 和 `message`,可用于验证 RUM 告警 Webhook 是否真正收到了平台发出的测试事件。
261261
</Note>
262262

263+
#### 会话回放
264+
265+
```bash
266+
flashduty rum session-replay-metadata <session-id> # 查看可回放会话的应用、设备、会话边界与 View 元数据
267+
flashduty rum session-replay-segments <session-id> # 读取会话回放分片
268+
```
269+
270+
`session-replay-metadata` 的 `--ts` 可填写会话开始时间的 Unix 毫秒时间戳,用于区分不同时间窗口中复用的会话 ID。
271+
272+
`session-replay-segments` 常用参数:
273+
274+
| 参数 | 说明 |
275+
|------|------|
276+
| `--limit` | 单次返回分片数,范围 1–99,默认 20。 |
277+
| `--search-after-ctx` | 上一页返回的分页游标;使用 URL 模式时从 `search_after_ctx` 字段取得,流式模式时从 `X-Search-After-Ctx` 响应头取得。 |
278+
| `--ts` | 未提供 `--search-after-ctx` 时,从该时间点或之前最近的完整快照分片开始读取。 |
279+
| `--url-mode` | 设为 `true` 时返回包含预签名下载 URL 的 JSON;默认 `false`,直接流式返回分片字节。URL 有效期为 1 小时。 |
280+
| `--view-id` | 只读取指定 View 的分片;省略时遍历整个会话。 |
281+
282+
### oncall — On-call 许可证
283+
284+
```bash
285+
flashduty oncall license-list # 列出当前账户中持有有效 On-call 许可证的成员
286+
```
287+
288+
该命令只读,返回成员 ID、名称及许可证类型:`fixed` 表示固定分配,`temporary` 表示当前临时许可证窗口内生效。
289+
263290
### template — 通知模板
264291

265292
```bash

‎zh/monitors/data-sources/data-sources.mdx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,28 @@ Monitors 支持以下 9 种数据源类型:
106106

107107
这些数据源的连接配置与 Prometheus 类似,包括服务地址、认证和 TLS 配置。其中 VictoriaLogs 的默认服务地址为 `http://localhost:9428`。具体参数请参考创建表单中的说明。
108108

109+
## 在 Edge 本地引用凭据
110+
111+
使用 `v0.46.0` 或更高版本的 Edge 时,你可以在受支持的数据源连接字段中使用环境变量引用,而不必将凭据直接写入数据源配置。Edge 会在本地进程中解析引用值;解析后的凭据不会回写到同步的数据源配置、调试输出或 API 载荷中。
112+
113+
<Steps>
114+
<Step title="设置 Edge 进程环境变量">
115+
在每个负责查询该数据源的 Edge 进程环境中设置凭据。例如,为 SLS 设置 `SLS_ACCESS_KEY_ID` 和 `SLS_ACCESS_KEY_SECRET`。修改环境变量后,重启 Edge 进程使新值生效。
116+
</Step>
117+
<Step title="在数据源表单中填写引用">
118+
编辑数据源时,在受支持的认证或连接字段中填写 `${env:变量名}`。例如,SLS 的 **AccessKey ID** 与 **AccessKey Secret** 可以分别填写 `${env:SLS_ACCESS_KEY_ID}` 和 `${env:SLS_ACCESS_KEY_SECRET}`。
119+
</Step>
120+
<Step title="保存并测试">
121+
保存数据源后,使用 **测试** 验证连接。每个引用的变量都必须存在于对应 Edge 进程环境中。
122+
</Step>
123+
</Steps>
124+
125+
变量名必须以大写字母或下划线开头,后续只能包含大写字母、数字或下划线,例如 `SLS_ACCESS_KEY_SECRET`。
126+
127+
<Warning>
128+
不能在数据源**连接地址**中使用环境变量引用;Prometheus、Loki 与 VictoriaLogs 的 **Params** 也不支持引用。请只在受支持的认证和连接字段中使用该语法。
129+
</Warning>
130+
109131
## 测试数据源
110132

111133
在数据源列表中,点击对应数据源的**测试**按钮,可以打开查询预览窗口,验证数据源连接是否正常并预览查询结果。

‎zh/monitors/targets/install-agent.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ keywords: ["monit-agent", "Agent 安装", "Edge 地址", "系统服务", "监控
1313
| 准备项 | 说明 |
1414
|---|---|
1515
| Agent 安装包下载地址 | `https://static.flashcat.cloud/monitagent/monitagent-v0.0.20-linux-amd64.tar.gz`。如果是 arm 的 CPU,则把 `amd64` 换成 `arm64`。 |
16-
| Edge 地址 | 例如 `ws://edge.example.com:6868` 或 `wss://edge.example.com:6868`。Edge 版本需要 `>= v0.44.0`,Edge 列表和安装方法[点此查看](https://console.flashcat.cloud/monit/engine/list)。 |
16+
| Edge 地址 | 例如 `ws://edge.example.com:6868` 或 `wss://edge.example.com:6868`。Edge 版本需要 `>= v0.46.0`,Edge 列表和安装方法[点此查看](https://console.flashcat.cloud/monit/engine/list)。 |
1717
| 本机对象地址 | 建议使用当前主机的固定内网 IP 或 DNS 名称,例如 `10.0.1.12`。不指定的话默认会使用本机默认路由对应的 IP。 |
1818
| 数据库/中间件只读账号 | 如需诊断 MySQL、Redis、PostgreSQL、MongoDB、Kafka、Elasticsearch 等服务,需提前准备对应的只读账号和凭据。 |
1919

‎zh/rum/explorer/data-query.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ Flashduty RUM 查看器提供了强大的检索能力,允许您通过灵活的
4343
“最近 1 小时”“昨天”“过去 7 天”等时间表达会更新查看器的时间选择器,不会被写成 `client_time` 等 DQL 条件。性能时长条件仍然属于 DQL,例如 `view_loading_time:>2s`。
4444
</Note>
4545

46+
<Note>
47+
AI 自然语言查询的时间范围最长为 **14 天**。如果请求的范围更长,预览会提示已截取最近 14 天;应用后时间选择器会使用截取后的范围。相对时间范围会改为过去 14 天,绝对时间范围会保留请求的结束时间,并向前取 14 天。
48+
</Note>
49+
4650
## 全文检索
4751

4852
<Warning>

0 commit comments

Comments
 (0)