更新日志¶
0.1.0¶
首个正式版本,支持 Cocos Creator 构建的 Android 和 iOS 原生应用。
新增功能¶
- RUM 采集:支持自动采集场景切换、触摸交互、JavaScript 错误及运行时支持的未处理 Promise 拒绝,支持手动记录 View、Action、Error、Long Task 和 Resource。可配置原生崩溃、Android ANR、UI 卡顿及设备性能监测。
- 日志采集:支持自定义日志及 Console 输出采集,可配置日志级别过滤、采样和缓存策略,并关联 RUM 会话。
- 网络监测与链路关联:自动采集运行时提供的
fetch和XMLHttpRequest的请求、响应信息及总耗时,并注入 Trace Header。支持手动 Resource 埋点及 Trace Header 生成;DNS、TCP 和 SSL 分阶段耗时需要手动埋点。 - 可选 Session Replay:通过独立的
@cloudcare/cocos-session-replay包提供 Creator 2 和 Creator 3 入口,使用withSessionReplay(baseSdk)与基础 SDK 组合,采集 Cocos 画面并关联 RUM 会话。支持配置采样、错误会话补采样、截帧频率和图像尺寸。 - Replay 隐私与图像控制:通过
ReplayPrivacy组件或代码遮罩、隐藏节点,默认遮罩输入框并隐藏触摸位置。支持画质预设,通过imagePolicy.maxFrameBytes启用单帧大小限制,覆盖新 View 和方向变化的首帧;单帧限制不等于滚动流量配额。 - 原生宿主 Hybrid 接入:通过
guanceSdk.attach()复用原生宿主已初始化的 SDK,使用guanceSdk.enterCocos()和guanceSdk.leaveCocos()切换 Cocos 页面采集与 Replay 画面捕获。启用 Cocos 网络自动采集后,网络采集从接入时开始并跨页面切换持续运行,不关闭宿主 SDK。 - 百分比采样:通过
sessionSamplingRate、sessionOnErrorSamplingRate、logSamplingRate、traceSamplingRate、sessionReplaySamplingRate和sessionReplayOnErrorSamplingRate配置 RUM、错误会话、日志、链路及 Replay 采样,取值为0~100,支持小数。旧比例字段保留0~1的单位和行为;新字段优先,包括显式的0。 - 用户上下文与安装工具:支持绑定用户、添加全局及事件级自定义属性,通过 DataKit 或 DataWay 上报。提供 Creator 2 和 Creator 3 安装命令及原生构建扩展,iOS 支持 CocoaPods 或 Swift Package Manager 接入。
优化¶
- Replay 截帧性能:Android 和 iOS 的原生图像编码及重放文件读写在游戏线程之外执行,采集周期包含图像处理耗时。
接入要求¶
- 支持 Cocos Creator 2.4.5–2.4.15 和 3.6.3–3.8.x;3.0–3.6.2 为尽力支持。要求 Android API 21+ 或 iOS 15.0+,不支持 Web、小游戏和桌面端目标。
- 使用 Android Agent
1.7.6、Android Session Replay0.1.9和 iOS Agent / Session Replay1.6.8;SPM 要求 Swift tools 5.5+。 - 独立应用通过
guanceSdk.start()初始化;Hybrid 应用先初始化原生宿主 SDK,再调用guanceSdk.attach()。两种模式互斥,Hybrid 采样由原生宿主配置。 - 使用 Replay 时,
@cloudcare/cocos-sdk与@cloudcare/cocos-session-replay的版本必须完全一致,并在start()/attach()前完成组合。执行npx guance-cocos install --replay;仅使用基础包时执行npx guance-cocos install --no-replay。随后重新生成原生工程、更新依赖并编译。
Alpha 版本更新记录请查看 GitHub: