@flashcatcloud/miniprogram-rum 提供 flashcatRum 实例。初始化后,SDK 会自动采集页面生命周期、用户操作、网络请求、应用错误和性能指标,并上报到 Flashduty RUM。
前提条件
在接入 SDK 前,请先完成以下准备:- 在 Flashduty 控制台创建或选择一个 RUM 应用,并获取 Application ID 和 Client Token
- 确认小程序可以访问 RUM 数据上报地址。默认地址为
https://browser.flashcat.cloud/api/v2/rum;如果您的网络策略需要转发,请配置proxy - 在微信公众平台配置 request 合法域名:进入 开发 → 开发管理 → 开发设置 → 服务器域名,将
https://browser.flashcat.cloud(或您的代理域名)添加到 request 合法域名。未配置时,真机上的所有上报请求会被微信拦截;开发调试阶段可临时勾选微信开发者工具的「不校验合法域名」选项 - 如果使用微信开发者工具,请在工具中构建 npm,使
miniprogram_npm可以引用 SDK 包
安装 SDK
在小程序项目根目录安装 RUM SDK:初始化 SDK
在小程序入口文件中尽早初始化 SDK。SDK 会在初始化时包装小程序的页面生命周期、请求方法和应用错误监听,所以建议在app.js 中完成初始化。
app.js
初始化参数
必填参数
基础可选参数
自定义上报代理。字符串形式会生成
{proxy}?ddforward={encodedPath};函数形式会接收 { path, parameters } 并返回完整上报 URL。是否读取控制台发布的远程配置,需要
@flashcatcloud/miniprogram-rum 0.2.0 及以上。采集开关
以下开关用于控制自动采集能力,默认都处于开启状态:使用用户信息和全局上下文
登录后,您可以使用setUser() 关联当前用户。SDK 会把这些字段写入后续 RUM 事件的 usr 对象。
app.js
setGlobalContext() 添加业务上下文。全局上下文会写入后续事件的 context 字段。
app.js
手动上报事件
除了自动采集,您还可以主动补充业务事件、错误、操作和自定义耗时。pages/order/detail.js
下一步
高级配置
配置代理、分布式追踪、会话和手动埋点。
兼容性
了解小程序基础库版本、开发工具和平台 API 要求。
数据收集
了解 SDK 自动采集的事件类型、字段和平台 API。