快速开始¶
本文提供 HarmonyOS RUM SDK 的最短接入路径，帮助您快速完成一次可验证的数据上报。
前置准备¶
- 在用户访问监测中创建 HarmonyOS 应用，并获取
RUM App ID - 确认上报方式：
- 本地环境部署：准备
datakitUrl - 公网 DataWay：准备
datawayUrl和clientToken - 选择安装方式：
- 已配置第三方仓库：直接通过
ohpm安装@guancecloud/ft_sdk - 使用本地 HAR：下载
ft_sdk.har，并在oh-package.json5中使用@guancecloud/ft_sdk作为依赖名 - 如需使用基于
@kit.NetworkKit的 HTTP 拦截器链能力，再额外安装@guancecloud/ft_sdk_ext或下载ft_sdk_ext.har - 如需采集 Native Crash，再额外安装
@guancecloud/ft_native或下载ft_native.har
接入步骤¶
- 使用第三方仓库时，执行
ohpm install @guancecloud/ft_sdk - 使用本地 HAR 时，将 HAR 文件放到项目
libs目录，并在oh-package.json5中声明 scoped 依赖；如果同时用了ft_sdk_ext.har，还需要在工程根目录的oh-package.json5里通过overrides把@guancecloud/ft_sdk改写到本地 HAR 后再执行ohpm install - 在应用启动时初始化
FTSDKConfig - 初始化
FTRUMConfig，开启 View、Action、Resource、ANR 和 Crash 采集 - 开启调试日志，运行应用并触发一次页面打开或网络请求
- 返回控制台确认 RUM 数据已成功上报
最小依赖方式¶
- 通过 ohpm 安装核心 SDK：
- 使用本地 HAR 时，在
oh-package.json5中添加最小依赖：
推荐优先按最小依赖接入，跑通基础数据上报后，再按需增加扩展包。
最小初始化示例¶
import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';
import { FTSDK } from '@guancecloud/ft_sdk/src/main/ets/components/FTSDK';
import { FTSDKConfig, FTRUMConfig } from '@guancecloud/ft_sdk/src/main/ets/components/Configs';
import { EnvType } from '@guancecloud/ft_sdk/src/main/ets/components/enum/Enums';
export default class EntryAbility extends UIAbility {
async onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): Promise<void> {
// 本地环境部署可改为 FTSDKConfig.builder(datakitUrl)
const sdkConfig = FTSDKConfig.builder(datawayUrl, clientToken)
.setDebug(true)
.setServiceName('Your-App-Name')
.setEnv(EnvType.PROD);
await FTSDK.install(sdkConfig, this.context);
const rumConfig = new FTRUMConfig()
.setRumAppId('your-app-id')
.setSamplingRate(1.0)
.setEnableTraceUserAction(true)
.setEnableTraceUserView(true)
.setEnableTraceUserResource(true)
.setEnableTrackAppANR(true)
.setEnableTrackAppCrash(true);
await FTSDK.installRUMConfig(rumConfig);
}
}
验证接入是否成功¶
- 保持
setDebug(true)开启 - 打开一个页面，或发起一次网络请求
- 检查应用日志，确认 SDK 初始化和数据上报流程正常
- 回到观测云控制台，确认出现对应的 RUM 数据