您可以根据业务需要，按照以下各模块说明，检查对应模块是否接入成功。

前提条件

完成SDK上报配置

配置设备白名单

SDK上报配置页面默认配置的采样率较低，在SDK接入测试阶段请配置DID白名单，确保当前设备所有性能数据都采样命中，才能上报到平台查看这些数据。具体请参见获取设备数与用户数和配置白名单。

配置各模块采样率

崩溃是100%上报的，不受采样率控制。除了崩溃，其他监控数据需要在SDK上报配置页面配置采样上报，默认情况下采样命中后才会上报。

例如，验证卡顿数据前，请在SDK上报配置页面打开总开关，并将卡顿采样率配置为100%。验证完成后，再修改为适合的采样率。具体请参见模块采样配置。

开启Debug日志

开启Debug日志输出功能，SDK就会在初始化成功、上报成功等关键时刻，向Xcode控制台输出日志，帮助您对SDK的接入和上报进行验证。

示例代码：

日志输入说明：

日志内容	说明
AppLog registered successfully! UserInfo:	AppLog注册完成，同时输出注册的信息。如果没有使用RangersAppLog的设备注册，则不用关注。
Setup APMPlus - version :	SDK 初始化开始，准备启动各功能模块，同时输出当前版本

崩溃分析

完整的崩溃分析功能需要引入子库，包括Crash、WatchDog、OOM，支持单独引入各个子库。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

添加以下代码到App代码中，触发NSException类型的Crash。

dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
NSArray *array = [NSArray array];
[array objectAtIndex:10];
});

在Xcode中，修改Build Configuration为Release，然后通过Run把App安装到模拟器或者真机。

在模拟器或者真机中打开App，然后等待崩溃代码执行，App闪退。

在Xcode中，通过Run重新启动App，SDK会立即上报上一次启动期间发生的崩溃，然后在控制台看到上报成功的日志。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
Crash-Monitor start successfully!	崩溃监控模块启动成功
WatchDog-Monitor start successfully!	卡死监控模块启动成功
OOMCrash-Monitor start successfully!	OOM监控模块启动成功
Crash log is uploading...	开始上传崩溃日志
Crash log is uploaded successfully!	崩溃日志上报成功
Watchdog log is uploading...	开始上传卡死日志
OOM log is uploading...	开始上传OOM日志

错误分析

错误分析模块分为自定义错误和网络错误。

自定义错误模块：需要引入子库UserException。

自定义错误是自埋点功能，需要手动调用接口来记录App发生的错误，并上报到应用性能监控平台，统一查看。

网络错误模块：需要引入子库Network。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

以下示例代码会记录1条自定义错误日志，SDK每记录5条日志会触发一次上报。网络错误日志可以通过发送一次会发生错误的网络请求来自动记录。

如果安装SDK时，无法找到以上头文件及接口，请检查SDK的版本，将其升级至1.1.0以上，或者参考以下代码记录自定义错误。

上报策略

网络错误日志记录后不会立即上报，在以下时间会自动上报：

App启动15s之后，触发一次上报。

每经过60s，触发一次上报。

当App状态切换到background时，触发一次上报。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
UserException-Monitor start successfully!	自定义错误监控模块启动成功
Network-Monitor start successfully!	网络监控模块启动成功

卡顿分析

卡顿分析模块需要引入子库LAG。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

通过阻塞主线程来模拟一个卡顿事件。阻塞时间需要大于您在SDK上报配置中配置的卡顿阈值，才能被SDK捕获上报。如果未修改卡顿阈值，默认阈值为2.5s。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
Lag-Monitor start successfully!	卡顿监控模块启动成功
Lag log is uploading...	开始上传卡顿日志

事件分析

事件分析模块是自埋点功能，需要您手动调用接口来进行事件的记录，使用该功能需要引入EventMonitor模块。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

以下示例代码可以记录一个事件，相关参数可以查看头文件介绍。

上报策略

事件记录后不会立即上报，客户端上报规则如下：

App启动之后，触发一次上报。

每经过60s，触发一次上报。

当App状态切换到background时，触发一次上报。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
Record an event-log successfully, name:	成功记录一条事件日志，并输出事件名称。

用户体验

用户体验模块分为启动分析、页面响应分析、流畅性分析。

启动分析模块：需要引入子库Monitors。

流畅性分析模块：需要引入子库Monitors。

页面响应分析模块：需要引入子库UITrackers。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

用户体验模块日志会在App的状态或者场景发生变化时进行记录，触发方式如下：

启动分析

App启动时会记录冷启动日志，该日志不可手动触发，且对于App的每次启动只会记录一条冷启动日志。

App从后台切换到前台会记录热启动日志，可以通过前后台切换来进行触发。

页面响应日志

当App发生场景切换时会记录页面响应日志，日志包含如下阶段的耗时：loadView、viewDidLoad、viewWillAppear、viewDidAppear，可以通过切换viewController来触发。

上报策略

用户体验日志记录后不会立即上报，在以下时间会自动上报：

App启动15s之后，触发一次上报。

每经过60s，触发一次上报。

当App状态切换到background时，触发一次上报。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
Start-Monitor start successfully!	启动监控模块启动成功
FPS-Monitor start successfully!	流畅性监控模块启动成功
FrameDrop-Monitor start successfully!	掉帧分析模块启动成功
PageLoad-Monitor start successfully!	页面响应分析模块启动成功

页面监控

页面监控模块会捕获App的WebView发生的加载、请求和错误事件，开启功能需要引入子库Hybrid。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

您可以使用Web Demo在您的App中新建WebView进行测试，也可以参考Demo在您的App原本的WebView页面中编写测试用例。

上报策略

页面监控日志记录后不会立即上报，在以下时间会自动上报：

App启动15s之后，触发一次上报。

每经过60s，触发一次上报。

当App状态切换到background时，触发一次上报。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
Hybrid-Monitor start successfully!	Hybrid监控模块启动成功

内存优化

内存优化模块会在App使用内存过高（超过1GB）时，采集当前状态下的所有内存节点和引用关系，生成内存快照文件并上传。对应的，在平台上可以看到内存过高时App的内存分配情况、通过现场信息排查内存泄漏或者大内存分配等问题。开启内存优化功能需要引入子库MemoryGraph。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

添加以下代码，调用OOMTrigger函数触发内存泄漏。

上报策略

App内存状态采集后，会在下一次App启动时进行上报。

上报内存文件前，会先向Server请求是否允许上传。如果Server不允许上传，则会在下一次App启动时重新请求。未通过请求的内存文件会缓存在App的沙盒中，当Server允许上传时一起上传。更多信息，请参见如何判断Server是否允许上传内存文件？。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
OOMCrash-Monitor start successfully!	OOM崩溃监控模块启动成功
MemoryGraph start successfully!	MemoryGraph模块启动成功
MemoryGraph start failed. Reason: ...	MemoryGraph模块启动失败，原因：...
Memory-Monitor start successfully!	内存指标监控模块启动成功
MemoryGraph generate start.	App内存达到阈值，启动内存采集
MemoryGraph generate failed, reason :	内存采集失败，并输出错误原因
MemoryGraph generate successfully!	内存采集成功
Upload MemoryGraph -- server check failed.	Server当前不允许上传MemoryGraph file
MemoryGraph file is uploading...	正在上传MemoryGraph file
Upload MemoryGraph file successfully!	上传MemoryGraph file成功
Upload MemoryGraph file failed.	上传MemoryGraph失败

网络分析

网络分析模块需要引入子库Network。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

您可以发送一些网络请求触发SDK网络数据记录。

上报策略

网络分析日志记录后不会立即上报，在以下时间会自动上报：

App启动15s之后，触发一次上报。

每经过60s，触发一次上报。

当App状态切换到background时，触发一次上报。

如果您不想或者只想监控某些URL的网络请求，可以在网络请求配置中进行配置。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
Network-Monitor start successfully!	网络监控模块启动成功

日志回捞

日志回捞模块需要引入子库APMLog。通过使用SDK提供的接口进行打点，可以记录一些App运行期间产生的日志。此模块是一种基于mmap的高效率的日志打点框架，日志压缩率高达25倍，结合云控可以实现线上用户日志的实时定向回捞，帮助您高效精准的定位和解决问题。

日志不会全部上报，获取这些日志的方式如下：

崩溃发生后，自动上报崩溃发生前一段时间产生的日志。

上报的日志在崩溃详情页的自定义日志里查看。

下发云控命令，获取指定设备或用户、指定时间内产生的日志。更多信息请参见回捞。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

对于C/C++、Objective-C和Swift，APMPlus提供了三类日志打点的接口，每一类有四个接口：Debug、Info、Warn、Error，代表日志严重程度的四个等级，可以在平台查看日志时进行筛选。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
ALog is uploaded successfully!	（回捞）自定义日志上报成功
Upload ALog failed, reason :	（回捞）自定义日志上报失败，并输出原因
ALog is uploaded manually!	手动上报自定义日志成功
Manually upload ALog failed	手动上报自定义日志失败
CloudCommand start successfully!	回捞功能启动成功
CloudCommand is being executed ...	回捞指令正在执行
ALog start successfully!	自定义日志功能启动成功

CPU监控

CPU监控模块包含两个子模块：CPU指标和CPU异常。

CPU指标模块：需要引入Monitors子库。

监控App运行过程中的CPU使用情况，同时SDK版本需要高于2.7.3。

CPU异常模块：需要引入子库CPUException。

监控App运行过程中CPU使用率过高的场景，并记录当时的调用堆栈。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

CPU指标会在App运行时自动上报。以下示例代码模拟CPU使用率过高场景，触发CPU异常的上报。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
CPUException log is uploading...	CPU异常日志正在上报
CPUException-Monitor start successfully!	CPU异常监控功能启动成功
Record CPUException log successfully!	成功记录CPU异常日志
CPUMetric-Monitor start successfully!	CPU指标监控功能启动成功

MetricKit

MetricKit模块会监控MetricKit.framework生成的系统日志，并上报给平台。如需接入，请引入MetricKit子库，同时APMPlus SDK版本需要高于2.12.1。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

系统会每天生成一份MetricKit日志，提供给业务方。如果想测试是否接入成功，请在真机调试状态下，执行如下操作：

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
MetricKit start successfully!	MetricKit模块启动成功
MetricKit log is uploading...	MetricKit日志正在上报

Disk

Disk模块会监控沙盒的使用情况。同时，将生成指标和异常信息上报给平台。如需接入，请引入Disk子库，同时APMPlus SDK版本需要高于3.0.0。

测试用例

测试用例是通过在项目中添加样例代码并在合适的时机触发，来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明，或者参见Demo工程。

为了防止检索沙盒文件，影响用户体验。磁盘监控启动时，Disk模块会在程序后台检索沙盒文件并上报。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
Disk start successfully!	Disk模块启动成功

自定义回捞

自定义回捞可以按照配置拉取沙盒或内存中指定的信息到APMPlus平台，进行问题排查或数据分析。如需接入，请引入CloudCommand子库，同时APMPlus SDK版本需要高于3.5.3。

测试用例

创建响应回捞命令的类。

#import <Foundation/Foundation.h>
#import "RangersAPM+CloudCommand.h"

NS_ASSUME_NONNULL_BEGIN
// 继承自自定义回捞基类
@interface APMPlusCustomCloudHandler : RangersAPMCustomCommandBase
@end
NS_ASSUME_NONNULL_END

#import "APMPlusCustomCloudHandler.h"

@implementation APMPlusCustomCloudHandler
// 响应回捞参数中的 command 值
+ (NSString *)cloudCommandIdentifier {
return @"pull_file";
}
/// 创建用于执行指令的实例变量
+ (instancetype)createInstance {
static APMPlusCustomCloudHandler *handler = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
handler = [[APMPlusCustomCloudHandler alloc] init];
});
return handler;
}

/// 执行自定义命令
- (void)executeCustomCommandWithParams:(NSDictionary *)params completion:(RangersAPMCustomCommandCompletion)completion {

RangersAPMCustomCommandResult *result = [[RangersAPMCustomCommandResult alloc] init];
// 待上报的字典信息
result.specificParams = @{@"aKey": @"aValue", @"bKey": @"bValue"};
// 待上报文件的二进制信息
...
result.data = [NSData dataWithContentsOfFile:toBeUplodFilePath];
// 待上报文件的名称
result.fileName = @"custom_file_name";
if (completion) {
completion(result);
}
}
/// 上传结果到服务器成功
- (void)uploadCustomCommandResultSucceededWithParams:(NSDictionary *)params {
NSLog(@"------ %s", __func__);
}
/// 上传结果到服务器失败
- (void)uploadCustomCommandResultFailedWithParams:(NSDictionary *)params error:(NSError *)error {
NSLog(@"------ %s", __func__);
}
@end

注册响应回捞命令的类。

在RangersAPM启动后，调用如下代码，注入自定义回捞响应类。

// 注册自定义回捞类
[RangersAPM addCustomCommandHandlerCls:[APMPlusCustomCloudHandler class]];

新建自定义回捞任务。详情请参见新建日志回捞任务。

在回捞参数中，添加以下内容。

{
"business_Akey":"business_Avalue",
"business_Bkey":"business_Bvalue",
"command":"pull_file"
}

command：在iOS工程中，会通过该字段的值将命令分发给不同的handler来执行。

其他字段请按照业务需求，请自行配置。

日志说明

完成开启Debug日志后，根据输出日志验证模块是否接入成功。

日志内容	说明
CloudCommand start successfully!	回捞功能启动成功
CloudCommand is being executed ...	回捞指令正在执行

应用性能监控全链路版