docs: add document for console recording and playback (#435)

* docs: add document for console recording and playback

* docs: adjust some sentences
This commit is contained in:
Luck Feng
2026-04-01 12:00:00 +08:00
committed by GitHub
parent 9d2db86d5a
commit dba421d2c5
6 changed files with 151 additions and 0 deletions

View File

@@ -146,6 +146,7 @@ setInterval(save, 10 * 1000);
| sampling | - | 数据抽样策略,详见[优化存储策略](./docs/recipes/optimize-storage.zh_CN.md) |
| recordCanvas | false | 是否记录 canvas 内容 |
| collectFonts | false | 是否记录页面中的字体文件 |
| recordLog | false | 是否记录console 输出,详见[console录制和播放](./docs/recipes/console.zh_CN.md) |
#### 隐私
@@ -287,6 +288,7 @@ replayer.pause(5000);
| UNSAFE_replayCanvas | false | 回放时是否回放 canvas 内容,**开启后将会关闭沙盒策略,导致一定风险** |
| mouseTail | true | 是否在回放时增加鼠标轨迹。传入 false 可关闭,传入对象可以定制轨迹持续时间、样式等,配置详见[类型](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L407) |
| unpackFn | - | 数据解压缩函数,详见[优化存储策略](./docs/recipes/optimize-storage.zh_CN.md) |
| logConfig | - | console logger数据播放设置详见[console录制和播放](./docs/recipes/console.zh_CN.md) |
#### 使用 rrweb-player