快速开始¶
本文用于提供 iOS RUM SDK 的最短接入路径,帮助您以最少步骤完成一次可验证的数据上报。
前置准备¶
开始前,请先完成以下准备:
- 在用户访问监测中创建 iOS 应用,并获取
RUM App ID - 确认上报地址与认证方式:
- 本地环境部署:准备
datakitUrl - 公网 DataWay:准备
datawayUrl和clientToken - 确认项目已经完成 SDK 安装,支持
CocoaPods、Carthage或Swift Package Manager
接入步骤¶
- 在项目中安装
FTMobileSDK - 在应用启动时初始化
FTMobileConfig - 初始化
FTRumConfig并开启 View、Action、Resource、崩溃和卡顿采集 - 开启调试日志,运行应用并触发一次页面打开或网络请求
- 在控制台与观测云平台确认数据已成功上报
安装 SDK¶
安装方式请直接参考 应用接入。
如果您只想快速验证,推荐优先使用 CocoaPods 或 Swift Package Manager。
最小初始化示例¶
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// 本地环境部署使用 [[FTMobileConfig alloc] initWithDatakitUrl:datakitUrl]
FTMobileConfig *config = [[FTMobileConfig alloc] initWithDatawayUrl:datawayUrl clientToken:clientToken];
config.enableSDKDebugLog = YES;
[FTMobileAgent startWithConfigOptions:config];
FTRumConfig *rumConfig = [[FTRumConfig alloc] initWithAppid:appid];
rumConfig.enableTraceUserView = YES;
rumConfig.enableTraceUserAction = YES;
rumConfig.enableTraceUserResource = YES;
rumConfig.enableTrackAppFreeze = YES;
rumConfig.enableTrackAppCrash = YES;
rumConfig.enableTrackAppANR = YES;
[[FTMobileAgent sharedInstance] startRumWithConfigOptions:rumConfig];
return YES;
}
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// 本地环境部署使用 FTMobileConfig(datakitUrl: datakitUrl)
let config = FTMobileConfig(datawayUrl: datawayUrl, clientToken: clientToken)
config.enableSDKDebugLog = true
FTMobileAgent.start(withConfigOptions: config)
let rumConfig = FTRumConfig(appid: appid)
rumConfig.enableTraceUserView = true
rumConfig.enableTraceUserAction = true
rumConfig.enableTraceUserResource = true
rumConfig.enableTrackAppFreeze = true
rumConfig.enableTrackAppCrash = true
rumConfig.enableTrackAppANR = true
FTMobileAgent.sharedInstance().startRum(withConfigOptions: rumConfig)
return true
}
以上示例已满足最小 RUM 接入,并默认开启崩溃与卡顿检测;若使用本地环境部署,请将
initWithDatawayUrl:clientToken:/FTMobileConfig(datawayUrl:clientToken:)替换为initWithDatakitUrl:/FTMobileConfig(datakitUrl:)。
可选:初始化 Log 和 Trace¶
如果您还需要日志采集或链路追踪,可继续追加以下初始化:
FTLoggerConfig *loggerConfig = [[FTLoggerConfig alloc] init];
loggerConfig.enableCustomLog = YES;
loggerConfig.enableLinkRumData = YES;
[[FTMobileAgent sharedInstance] startLoggerWithConfigOptions:loggerConfig];
FTTraceConfig *traceConfig = [[FTTraceConfig alloc] init];
traceConfig.enableAutoTrace = YES;
traceConfig.enableLinkRumData = YES;
[[FTMobileAgent sharedInstance] startTraceWithConfigOptions:traceConfig];
let loggerConfig = FTLoggerConfig()
loggerConfig.enableCustomLog = true
loggerConfig.enableLinkRumData = true
FTMobileAgent.sharedInstance().startLogger(withConfigOptions: loggerConfig)
let traceConfig = FTTraceConfig()
traceConfig.enableAutoTrace = true
traceConfig.enableLinkRumData = true
FTMobileAgent.sharedInstance().startTrace(withConfigOptions: traceConfig)
验证接入是否成功¶
- 保持
enableSDKDebugLog = YES/true开启,运行应用 - 打开一个页面,或发起一次
URLSession网络请求 - 在 Xcode 控制台中确认出现 SDK 初始化和数据同步相关日志
- 返回观测云控制台,确认应用中已出现对应的 RUM 数据
如果需要进一步排查,请查看 故障排查。
下一步¶
- 完整安装和初始化说明,请继续阅读 应用接入
- 所有初始化参数说明,请阅读 SDK 初始化
- RUM、Log、Trace 的详细配置,请阅读 RUM 配置、Log 配置、Trace 配置
- 如果需要接入 WebView 监测,请阅读 WebView 数据监测
- 如果需要接入 Session Replay,请阅读 iOS Session Replay