快速开始¶
本文用于提供 Android RUM SDK 的最短接入路径,帮助您以最少步骤完成一次可验证的数据上报。
前置准备¶
开始前,请先完成以下准备:
- 在用户访问监测中创建 Android 应用,并获取
RUM App ID。 - 确认上报地址与认证方式:
- 本地环境部署:准备
datakitUrl。 - 公网 DataWay:准备
datawayUrl和clientToken。 - 确认应用已具备
Application,或准备新建一个并在AndroidManifest.xml中声明。
接入步骤¶
- 配置 Maven 仓库并引入
ft-sdk。 - 按需引入
ft-plugin、ft-native、okhttp。 - 在
Application.onCreate()中安装 SDK 并初始化RUM,同时开启崩溃和卡顿检测。 - 如果需要日志采集或链路追踪,再初始化
Log、Trace。 - 开启调试日志并触发一次页面打开或网络请求,确认数据上报成功。
Maven 仓库¶
如果同时接入 ft-plugin 和 ft-sdk,需要分别为插件和 AAR 依赖配置 Maven 仓库。具体 Gradle 配置方式请直接参考应用接入。
最小依赖¶
// build.gradle
plugins {
id 'com.cloudcare.ft.mobile.sdk.tracker.plugin' version '[latest_version]'
}
// app/build.gradle
dependencies {
implementation 'com.cloudcare.ft.mobile.sdk.tracker.agent:ft-sdk:[latest_version]'
// json 序列化
implementation 'com.google.code.gson:gson:2.8.+'
//可选,如果需要自动采集网络请求和自动开启链路必须添加,最低兼容 3.12.+ 以上版本
implementation 'com.squareup.okhttp3:okhttp:4.+'
}
如需以下能力,请继续添加对应依赖:
ft-native:采集 Native Crash。okhttp:自动采集网络请求或自动注入 Trace Header 时需要。
ft-plugin用于自动采集页面、点击、OkHttp 请求、WebView 等数据;如果当前项目使用旧版 AGP,请改用ft-plugin-legacy,完整写法可参考应用接入。
Application 声明¶
如果项目中还没有自定义 Application,请先创建并在 AndroidManifest.xml 中声明:
最小初始化示例¶
public class DemoApplication extends Application {
@Override
public void onCreate() {
super.onCreate();
// 本地环境部署使用 FTSDKConfig.builder(datakitUrl)
FTSDKConfig config = FTSDKConfig.builder(datawayUrl, clientToken);
config.setDebug(true);
FTSdk.install(config);
FTSdk.initRUMWithConfig(
new FTRUMConfig()
.setRumAppId(RUM_APP_ID)
.setEnableTraceUserView(true)
.setEnableTraceUserAction(true)
.setEnableTraceUserResource(true)
.setEnableTrackAppUIBlock(true)
.setEnableTrackAppCrash(true)
.setEnableTrackAppANR(true)
);
}
}
class DemoApplication : Application() {
override fun onCreate() {
super.onCreate()
// 本地环境部署使用 FTSDKConfig.builder(datakitUrl)
val config = FTSDKConfig.builder(datawayUrl, clientToken)
config.setDebug(true)
FTSdk.install(config)
FTSdk.initRUMWithConfig(
FTRUMConfig()
.setRumAppId(RUM_APP_ID)
.setEnableTraceUserView(true)
.setEnableTraceUserAction(true)
.setEnableTraceUserResource(true)
.setEnableTrackAppUIBlock(true)
.setEnableTrackAppCrash(true)
.setEnableTrackAppANR(true)
)
}
}
以上示例已满足最小 RUM 接入,并默认开启崩溃与卡顿检测;若使用本地环境部署,请将
FTSDKConfig.builder(datawayUrl, clientToken)替换为FTSDKConfig.builder(datakitUrl)。
可选:初始化 Log 和 Trace¶
如果您还需要日志采集或链路追踪,可继续追加以下初始化:
FTSdk.initLogWithConfig(
FTLoggerConfig()
.setEnableCustomLog(true)
.setEnableLinkRUMData(true)
)
FTSdk.initTraceWithConfig(
FTTraceConfig()
.setEnableAutoTrace(true)
.setEnableLinkRUMData(true)
)
验证接入是否成功¶
- 保持
config.setDebug(true)开启,运行应用。 - 打开一个页面,或在已接入
okhttp的场景下发起一次网络请求。 - 在
Logcat中搜索[FT-SDK],确认出现类似initRUMWithConfig complete或Sync Success的日志。 - 返回观测云控制台,确认应用中已出现对应的 RUM 数据。
下一步¶
- 完整安装和初始化说明,请继续阅读应用接入。
- 所有初始化参数说明,请阅读 SDK 初始化。
- RUM、Log、Trace 的详细配置,请阅读 RUM 配置、Log 配置、Trace 配置。
- 如果需要接入 WebView 监测,请阅读 WebView 监测。
- 如果需要接入 Session Replay,请阅读 Android Session Replay。