Skip to content

Commit d36a761

Browse files
author
niuweili
committed
feat: update docs
1 parent 52c6b21 commit d36a761

7 files changed

Lines changed: 23 additions & 24 deletions

File tree

flashduty/zh/2. RUM/2. 应用管理/1. 应用管理.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ RUM 应用是承载前端性能监控数据的容器,用于采集、存储和
2626

2727
- **应用类型**:选择应用对应的前端技术类型,目前只支持`JavaScript (JS)`
2828
- **管理团队**: 设置该应用的管理团队,**团队所属成员对该应用有全部操作权限**,非创建者对该应用的配置只读。
29-
- **地理信息**:默认情况下,自动启用用户数据采集。如果需要禁用客户端 IP 或地理位置数据的自动用户数据采集,请关闭地理信息收集的开关。有关详细信息,请参阅[RUM 浏览器数据采集][05]
29+
- **地理信息**:默认情况下,自动启用用户数据采集。如果需要禁用客户端 IP 或地理位置数据的自动用户数据采集,请关闭地理信息收集的开关。有关详细信息,请参阅[RUM 浏览器数据采集](https://docs.flashcat.cloud/zh/flashduty/rum/data-collection)
3030
- **告警配置**:默认情况下,自动开启告警通知,方便您及时处理错误。有关详细信息,请参阅[告警通知][06]
3131

3232
## SDK 配置
@@ -35,7 +35,7 @@ RUM 应用是承载前端性能监控数据的容器,用于采集、存储和
3535

3636
<Video src="https://docs-cdn.flashcat.cloud/videos/rum-app-set-sdk.mov"></Video>
3737

38-
您可以在应用配置-SDK 配置中修改参数来实时预览初始化 SDK 的代码,以便您快速接入 SDK,有关更多配置说明可见[初始化参数][08]
38+
您可以在应用配置-SDK 配置中修改参数来实时预览初始化 SDK 的代码,以便您快速接入 SDK,有关更多配置说明可见[初始化参数](https://docs.flashcat.cloud/zh/flashduty/rum/sdk-integration#初始化参数)
3939

4040
:::tip
4141
在应用管理中修改 SDK 配置并不会实时生效到已集成的客户端。所有配置更改需要在您的前端代码中更新并重新部署才能生效。这意味着当您调整采样率、服务名称等参数后,需要在前端代码中相应地更新 SDK 初始化参数,并重新部署应用。

flashduty/zh/2. RUM/2. 应用管理/2. SDK接入.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ flashcatRum.init({
127127
| actionNameAttribute | String || 指定您自己的属性以用于命名操作。`false` |
128128
| sessionSampleRate | Number || 要跟踪的会话百分比:100 为所有,0 为无。仅跟踪的会话发送 RUM 事件。默认值:`100` |
129129
| silentMultipleInit | Boolean || 如果 RUM 浏览器 SDK 已在页面上初始化,则初始化会静默失败。默认值:`false` |
130-
| proxy | Boolean || 可选代理 URL,例如:`https://www.proxy.com/path`。有关详细信息,请参阅完整的代理设置指南。 |
130+
| proxy | String || 可选代理 URL,例如:`https://www.proxy.com/path` |
131131
| allowedTracingUrls | Array || 用于注入跟踪 Headers 的请求 URL 列表。 |
132132
| traceSampleRate | Number || 要跟踪的请求百分比:100 为所有,0 为无。默认值:`100` |
133133
| excludedActivityUrls | Array || 计算页面活动时忽略的请求来源列表。 |

flashduty/zh/2. RUM/2. 应用管理/4. 分析看板.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Access-Control-Allow-Origin: *
107107

108108
### 如何采集用户信息
109109

110-
1. **登录态用户识别**:对于需要用户登录的应用(如 SaaS 产品、会员系统、电商平台等),您可以参考[用户标识采集][01]
110+
1. **登录态用户识别**:对于需要用户登录的应用(如 SaaS 产品、会员系统、电商平台等),您可以参考[用户标识采集](https://docs.flashcat.cloud/zh/flashduty/rum/advanced-configuration#用户会话)
111111
2. **设备指纹识别**:对于无登录态的应用(如企业官网、营销页面、公开内容平台等),推荐您基于浏览器特征、设备信息等多维数据生成稳定的指纹并上报用户标识
112112

113113
## 下一步

flashduty/zh/2. RUM/3. 性能监控/2. 指标上报.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ Flashduty RUM 支持收集和上报 Web Vitals 相关的性能指标,帮助您
1414
Flashduty RUM 支持以下[核心 Web Vitals 指标](https://web.dev/articles/vitals?hl=zh-cn)
1515

1616
- **最大内容绘制 (LCP)**: 衡量页面主要内容的加载性能
17-
- **首次输入延迟 (FID)**: 衡量页面交互性能
1817
- **交互到下一帧延迟 (INP)**: 衡量整体交互响应性能
1918
- **累计布局偏移 (CLS)**: 衡量视觉稳定性
19+
- **首次内容绘制 (FCP)**: 衡量首次内容渲染时间
2020

2121
除核心指标外,还支持其他辅助指标:
2222

23-
- **首次内容绘制 (FCP)**: 衡量首次内容渲染时间
23+
- **首次输入延迟 (FID)**: 衡量页面交互性能
2424
- **首次字节时间 (TTFB)**: 衡量服务器响应速度
2525

2626
这些指标会在用户访问页面时自动收集,并通过 SDK 上报到 Flashduty 平台,您可以在分析看板中查看详细的性能数据。
@@ -32,21 +32,27 @@ Flashduty RUM 支持以下[核心 Web Vitals 指标](https://web.dev/articles/vi
3232
- **计算**: 从页面开始加载(`navigationStart`)到最大可见内容元素(如图片、文本块)渲染完成的时间。
3333
- **用例**: 监控主页或关键页面内容加载速度,识别资源加载瓶颈。
3434

35-
### 2. 首次输入延迟(FID)
35+
### 2. 首次内容绘制 (FCP)
3636

37-
- **计算**: 从用户交互开始到浏览器处理事件的时间差
38-
- **用例**: 优化交互密集型页面(如表单、导航菜单)的响应速度
37+
- **计算**: 测量从用户第一次导航到页面到页面内容的任何部分在屏幕上呈现的时间
38+
- **用例**: 用于测量感知加载速度,有助于向用户保证某些事情正在发生
3939

4040
### 3. 交互到下一帧延迟(INP)
4141

42-
- **计算**: 测量所有用户交互(点击、轻触、键盘输入)到下一帧渲染的延迟时间。取所有交互延迟的第 75 百分位数。
42+
- **计算**: 测量所有用户交互(点击、轻触、键盘输入)到下一帧渲染的延迟时间。
4343
- **用例**: 评估页面整体交互响应性能,优化高延迟交互场景。
4444

4545
### 4. 累计布局偏移(CLS)
4646

4747
- **计算**: 统计所有意外布局偏移的分数(偏移距离 × 影响区域)。
4848
- **用例**: 识别动态内容或广告导致的页面跳动问题。
4949

50+
### 5. 首次输入延迟(FID)
51+
52+
- **计算**: 从用户第一次交互开始到浏览器处理事件的时间差。
53+
- **用例**: 优化交互密集型页面(如表单、导航菜单)的响应速度。
54+
55+
5056
## 自定义性能监控
5157

5258
### 1. 组件级性能测量

flashduty/zh/2. RUM/3. 性能监控/3. 性能分析.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ url: "https://docs.flashcat.cloud/zh/flashduty/rum/performance-analysis"
2525

2626
- 切换至树状视图,可以从某个指标视角下查看待优化的资源列表。
2727
- 可以切换不同的指标,查看其分布情况
28-
- 选择指标后,会看到 Warning、Poor、Good 分类下的资源分布与占比,可快速定位到问题资源
28+
- 选择指标后,会看到 `良好``较差``一般`分类下的资源分布与占比,可快速定位到问题资源
2929
- 点击区块所代表的页面后,可查看该页面下的指标详情,方便进一步做问题诊断。
3030

31-
![2025-05-15-20-03-08](https://docs-cdn.flashcat.cloud/imges/png/2b2719c9cf39a9e8f80edb5ecfcaa5b8.png)
31+
![2025-05-19-19-27-33](https://docs-cdn.flashcat.cloud/images/png/dd1d9fc4486be7406e6c4f1b9ed20228.png)
3232

3333
### 数据分析维度
3434

flashduty/zh/2. RUM/3. 性能监控/4. 诊断优化.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,6 @@ url: "https://docs.flashcat.cloud/zh/flashduty/rum/performance-diagnosis"
1313

1414
为了进行更深入的分析,优化页面提供了按用户人口统计(例如浏览器、地区和应用版本)的核心网络指标的详细拆分。您可以利用这些信息跟踪性能趋势,了解受影响最多的用户群体,精准优化。
1515

16-
## 前置准备
17-
18-
:::tip
19-
要优化您的应用程序,请确保您使用的是:
20-
RUM 浏览器 SDK 版本 5.4.0 或更新版本
21-
:::
22-
2316
## 诊断优化
2417

2518
您可导航至优化页面,该页面位于性能监控菜单下,选取待洞察的指标即可,您也可以通过在分析看板中查看对应的性能数据跳转至此功能。
@@ -32,14 +25,15 @@ RUM 浏览器 SDK 版本 5.4.0 或更新版本
3225

3326
2. 在"显示筛选细分"中选择一个组
3427

35-
3. 在不同的百分位数处评估指标,例如, pc75 评估表示第 75 个百分位数值。
28+
3. 在不同的百分位数处评估指标,例如, p75 评估表示第 75 个百分位数值。
3629

37-
![2025-05-15-20-14-14](https://docs-cdn.flashcat.cloud/imges/png/2dae288225e694a257d327d2cfd98644.png)
3830

3931
### 数据查看
4032

4133
您可通过调整数据聚合方式,或者修改筛选条件,查看该指标在不同条件下的数据表现情况,从而推进诊断优化工作。
4234

35+
![2025-05-19-19-29-55](https://docs-cdn.flashcat.cloud/images/png/65dd3ca92d67ae9175955502d91552dc.png)
36+
4337
### 问题诊断
4438

4539
首先需故障排除资源和错误。在问题诊断部分,您可以看到用户在页面上遇到的可能影响指标性能的资源和错误。例如,对于最大内容绘制(LCP),您可以查看在触发 LCP 之前加载的资源。由于 LCP 是最大元素在页面上加载所需时间的指标,您可以从资源加载和解决错误两个方面进行问题诊断。
@@ -67,7 +61,6 @@ RUM 浏览器 SDK 版本 5.4.0 或更新版本
6761

6862
## 下一步
6963

70-
-[性能监控概览] (https://docs.flashcat.cloud/zh/flashduty/rum/performance-monitoring-concepts)
71-
64+
- [性能监控概览](https://docs.flashcat.cloud/zh/flashduty/rum/performance-monitoring-concepts)
7265
- [指标上报](https://docs.flashcat.cloud/zh/flashduty/rum/performance-metrics)
7366
- [性能分析](https://docs.flashcat.cloud/zh/flashduty/rum/performance-analysis)

flashduty/zh/2. RUM/4. 异常追踪/2. 异常上报.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ try {
105105

106106
### React 错误边界集成
107107

108-
Flashduty RUM 支持通过 React 错误边界捕获组件渲染错误,并将错误信息上报。您可以在 `componentDidCatch` 中调用 `addError` API,附加组件堆栈信息以便调试。
108+
Flashduty RUM 支持通过 React [错误边界](https://legacy.reactjs.org/docs/error-boundaries.html)捕获组件渲染错误,并将错误信息上报。您可以在 `componentDidCatch` 中调用 `addError` API,附加组件堆栈信息以便调试。
109109

110110
#### 示例:React 错误边界
111111

0 commit comments

Comments
 (0)