用户体验监控iOS SDK配置参数说明_应用实时监控服务(ARMS)-阿里云帮助中心

本文介绍iOS应用常用的SDK配置。

启动配置接口

启动接口

参数	类型	说明	接口
appID	NSString	RUM应用唯一ID	`// 启动SDK + (void)startWithAppID:(NSString *)appID;`

示例：

Objective-C

[OpenRUM startWithAppID:@"xxxxxlhguqs@xxxxxxcc4440b74"];

Swift

OpenRUM.startWithAppID("xxxxxlhguqs@xxxxxxcc4440b74")

设置上报地址

上报地址可在应用设置页面查看。

重要

该接口需要在调用+ startWithAppID:前设置。

参数	类型	说明	接口
configAddress	NSString	RUM上报地址	`// 设置Config地址（请在SDK启动之前设置） + (void)setConfigAddress:(NSString *)configAddress;`

示例：

Objective-C

[OpenRUM setConfigAddress:@"https://xxxxxlhguqs-default-cn.rum.aliyuncs.com/RUM/config"];

Swift

OpenRUM.setConfigAddress("https://xxxxxlhguqs-default-cn.rum.aliyuncs.com/RUM/config")

设置APP版本

App版本默认在配置文件中获取真实版本号。如有主动配置需求，需要在调用+ startWithAppID:前调用以下接口设置版本信息。

参数	类型	说明	接口
appVersion	NSString	需要设置的版本信息。长度范围：(0,64]。	`/// 设置app版本（请在SDK启动之前设置）默认获取应用CFBundleShortVersionString + (void)setAppVersion:(NSString *)appVersion;`

示例：

Objective-C

[OpenRUM setAppVersion:@"3.2.1"];

Swift

OpenRUM.setAppVersion("3.2.1")

设置下载渠道名称

渠道名称默认为apple。如有主动配置需求，需要在调用+ startWithAppID:前调用以下接口设置渠道名称。

参数	类型	说明	接口
channelID	NSString	需要设置的渠道名称。长度范围：(0,256]。	`// 设置渠道标识（请在SDK启动之前设置） + (void)setChannelID:(NSString *)channelID;`

示例：

Objective-C

[OpenRUM setChannelID:@"AppStore"];

Swift

OpenRUM.setChannelID("AppStore")

设置自定义的设备ID

设备ID（deviceID）默认由SDK生成并在Keychain中保存。如有主动配置需求，需要在调用+ startWithAppID:前调用以下接口设置设备ID。

参数	类型	说明	接口
deviceID	NSString	需要设置的设备ID。长度范围：(0,256]，仅支持字母、数字、下划线（_）和短划线（-）。	`// 配置自定义的设备deviceID（请在SDK启动之前设置） + (void)setDeviceID:(NSString *)deviceID;`

示例：

Objective-C

[OpenRUM setDeviceID:@"0123456789"];

Swift

OpenRUM.setDeviceID("0123456789")

设置持续丢帧时间

设置判定卡顿的持续丢帧时间。需要在调用+ startWithAppID:前调用以下接口设置。

参数	类型	说明	接口
time	NSInteger	持续丢帧时间（秒），dropFrameTime取值范围：(0,30]，默认值为5秒。	`/// 设置持续丢帧监测时间（请在BonreeSDK启动之前设置） + (void)setDropFrameTime:(NSInteger)time;`

示例：

Objective-C

[OpenRUM setDropFrameTime:5];

Swift

OpenRUM.setDropFrameTime(5)

自定义冷启动结束时间

如需自定义冷启动的结束时机，可以调用以下两个接口完成自定义功能。具体使用方式为：

调用自定义冷启动开关接口，开启自定冷启动功能。
重要
该接口需在SDK启动前设置。
在需要的时机调用冷启动结束接口，记录冷启动结束。

参数

类型

说明

接口

used

BOOL

是否使用自定义冷启动结束时间。

标识使用自定义冷启动结束时间（需在SDK启动之前设置）。

+ (void)useCustomLaunch:(BOOL)used;

记录冷启动结束。

+ (void)recordCustomLaunchEnd;

示例：

重要

开启自定义冷启动功能后，若30秒内未调用记录冷启动结束接口，冷启动监控过程会强制结束。

Objective-C

// 需在SDK启动之前设置
[OpenRUM useCustomLaunch:YES];

// ...

// 在需求时机位置调用
[OpenRUM recordCustomLaunchEnd];

Swift

// 需在SDK启动之前设置
  OpenRUM.useCustomLaunch(true)

  // ...

  // 在需求时机位置调用
  OpenRUM.recordCustomLaunchEnd()

自定义功能接口

自定义用户信息

RUM SDK支持设置与用户相关的信息，从而完成性能数据与实际用户相关联的需求场景。

设置用户ID，以字符串形式给用户做标识。接口如下：

参数

类型

说明

接口

userID

NSString

用户ID。字符串可为空或空串。字符串长度范围：≤256，仅支持字母、数字、下划线（_）和短划线（-）。

// 设置用户ID
+ (void)setUserID:(nullable NSString *)userID;

示例：

Objective-C

[OpenRUM setUserID:@"user-id"];

Swift

OpenRUM.setUserID("user-id")

自定义异常

调用接口并传入相应参数，可完成自定义异常数据的统计功能。

参数	说明	类型	接口
exceptionType	NSString	异常类型。必传参数，空或空串接口调用无效。长度范围：(0,256]。	`// 自定义异常收集 + (void)setCustomExceptionWithType:(NSString )exceptionType causeBy:(NSString _Nullable)causedBy errorDump:(NSString * _Nullable)errorDump;`
causedBy	NSString	异常原因。字符串可为空或空串。字符串≤512，超长截取。
errorDump	NSString	异常堆栈，超出10000字符时会被切割。

示例：

Objective-C

[OpenRUM setCustomExceptionWithType:@"Custom exception type"
 causeBy:@"Caused by customer."
 errorDump:@"Custom error dump 0\nCustom error dump 1"];

Swift

OpenRUM.setCustomExceptionWithExceptionType("Custom exception type",
                                             causeBy: "Caused by customer.",
                                             errorDump: "Custom error dump 0\nCustom error dump 1")