RN 应用仅支持 NPM 方式安装,并需将 SDK 内置的原生模块随 App 原生工程一起构建。
前提条件
版本要求:React Native >= 0.60,iOS >= 11。
可选依赖:
@react-native-async-storage/async-storage(>= 1.0.0),用于持久化 aid(设备唯一标识,用于区分设备、计算 uv);未安装时 SDK 自动降级为会话内不持久化的 aid。步骤1:安装 SDK
1. 执行下列命令,在 npm 仓库安装
aegis-rn-sdk,依赖将写入项目根目录的 package.json:npm install --save aegis-rn-sdk
2. SDK 内含原生模块(冷/热启动时间采集、首帧 onDraw 采集、帧率统计等能力),需随 App 原生工程一起构建:
Android:自动链接(
react-native.config.js 已配置 AegisPerfPackage),依赖位置为 android/ 原生工程,无需手动添加到 android/app/build.gradle。iOS:依赖位置为
ios/ 目录,执行 pod install 后通过 aegis-rn-sdk.podspec 自动集成,无需手动添加到 Podfile。步骤2:初始化 SDK
参考下列步骤新建一个 Aegis 实例,传入相应的配置,初始化 SDK:
import Aegis from 'aegis-rn-sdk';const aegis = new Aegis({id: 'pGUVFTCZyewhxxxxxx', // 应用ID,即上报IDuin: 'xxx', // 用户唯一 ID(可选)reportApiSpeed: true, // 接口测速hostUrl: 'https://rumt-zh.com', // 上报域名,中国大陆 rumt-zh.com})
说明:
为了不遗漏数据,须尽早进行初始化,建议将初始化放在应用入口文件(如
index.js / App.tsx)中,在路由容器与首屏 UI 渲染之前完成。冷启动监控依赖原生侧记录的 processStartTime,初始化越早,启动耗时数据越完整。当您完成安装并初始化 SDK 之后,可以开始使用前端性能监控提供的以下功能:
错误监控:JS 执行错误、Promise 错误、接口请求异常、返回码异常、白名单检测等;
测速功能:冷/热启动监控、页面测速(TTID/TTFD)、路由切换耗时、接口测速;
页面流转监控(PV):开启
spa 并接入路由后自动上报页面 PV;数据统计和分析:可在 前端性能监控 数据总览上进行各个维度的数据分析。
aegis-rn-sdk 默认使用
https://rumt-zh.com 作为上报域名,您可以通过 hostUrl 参数来控制上报域名。中国大陆可以选择使用
https://rumt-zh.com 作为上报域名。新加坡地区可以选择使用
https://rumt-sg.com 作为上报域名。硅谷地区可以选择使用
https://rumt-us.com 作为上报域名。