您可以根据业务需要,按照以下各模块说明,检查对应模块是否接入成功。
- SDK上报配置页面默认配置的采样率较低,在SDK接入测试阶段请配置DID白名单,确保当前设备所有性能数据都采样命中,才能上报到平台查看这些数据。具体请参见获取设备数与用户数和配置白名单。
- 崩溃是100%上报的,不受采样率控制。除了崩溃,其他监控数据需要在SDK上报配置页面配置采样上报,默认情况下采样命中后才会上报。
- 例如,验证卡顿数据前,请在SDK上报配置页面打开总开关,并将卡顿采样率配置为100%。验证完成后,再修改为适合的采样率。具体请参见模块采样配置。
开启Debug日志输出功能,SDK就会在初始化成功、上报成功等关键时刻,向Xcode控制台输出日志,帮助您对SDK的接入和上报进行验证。
示例代码:
#import <RangersAPM+DebugLog.h>
//通过修改block,您可以定制自己的日志输出格式,下述代码示例是SDK内部默认的输出格式,如果您传入nil,则SDK会使用默认的格式输出日志。
[RangersAPM allowDebugLogUsingLogger:^(NSString * _Nonnull log) {
NSLog(@"APMPlus : %@", log);
//请先于此代码开启debug日志,否则对于一些同步事件可能无法输出日志
[RangersAPM startWithConfig:config];
日志输入说明:
完整的崩溃分析功能需要引入子库,包括Crash、WatchDog、OOM,支持单独引入各个子库。
注意
如果只需要OOM功能,请同时引入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,这样触发的崩溃无法捕获。
- 在Xcode中,通过Run重新启动App,SDK会立即上报上一次启动期间发生的崩溃,然后在控制台看到上报成功的日志。
错误分析模块分为自定义错误和网络错误。
- 自定义错误模块:需要引入子库UserException。
- 自定义错误是自埋点功能,需要手动调用接口来记录App发生的错误,并上报到应用性能监控全链路版平台,统一查看。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
以下示例代码会记录1条自定义错误日志,SDK每记录5条日志会触发一次上报。网络错误日志可以通过发送一次会发生错误的网络请求来自动记录。
#import <RangersAPM+UserException.h>
[RangersAPM trackAllThreadsLogExceptionType:@"testUserException"
customParams:@{@"testCustomKey":@"testCustomValue"}
filters:@{@"testFilterKey":@"testFilterValue"}
callback:^(NSError * _Nullable error){
如果安装SDK时,无法找到以上头文件及接口,请检查SDK的版本,将其升级至1.1.0以上,或者参考以下代码记录自定义错误。
#import <RangersAPMUserExceptionManager.h>
[RangersAPMUserExceptionManager trackAllThreadsLogExceptionType:@"testUserException"
customParams:@{@"testCustomKey":@"testCustomValue"}
filters:@{@"testFilterKey":@"testFilterValue"}
callback:^(NSError * _Nullable error) {
说明
当使用此功能产生 error 时,通过 error.code 获取错误码,错误码映射表在当前 SDK 的 RangersAPMUserExceptionErrorType.h 文件中,同时附带了相关说明。同样,您也可以通过 error.userInfo 字典中的 reason 字段获取详细的错误说明。
网络错误日志记录后不会立即上报,在以下时间会自动上报:
- 当App状态切换到background时,触发一次上报。
卡顿分析模块需要引入子库LAG。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
通过阻塞主线程来模拟一个卡顿事件。阻塞时间需要大于您在SDK上报配置中配置的卡顿阈值,才能被SDK捕获上报。如果未修改卡顿阈值,默认阈值为2.5s。
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(5 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
说明
- 如果您需要在卡顿场景发生时做一些自主处理,请参见通知。
事件分析模块是自埋点功能,需要您手动调用接口来进行事件的记录,使用该功能需要引入EventMonitor模块。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
以下示例代码可以记录一个事件,相关参数可以查看头文件介绍。
#import "RangersAPM+EventMonitor.h"
[RangersAPM trackEvent:@"event_name1"
metrics:@{@"metric1":@(0)}
dimension:@{@"dimension1":@"test"}//Metrics参数只支持Key为NSString类型,Value为NSNumber类型的NSDictionary对象。Metrics参数不支持嵌套结构。
extraValue:@{@"extra1":@"extravalue"}];//dimension参数只支持Key和Value都为NSString类型的NSDictionary对象。dimension参数不支持嵌套结构。
注意
- 只有在控制台上已创建,事件状态为开启或验证中,且客户端命中事件采样规则,才会记录并上报该事件。
- 同一个事件中 metrics/dimension 的个数不能超过 100 个,否则会被丢弃。
- Metrics 参数只支持 Key 为 NSString 类型,Value 为 NSNumber 类型的 NSDictionary 对象。Metrics 参数不支持嵌套结构。
- dimension 参数只支持 Key 和 Value 都为 NSString 类型的 NSDictionary 对象。dimension 参数不支持嵌套结构。
事件记录后不会立即上报,客户端上报规则如下:
- 当App状态切换到background时,触发一次上报。
用户体验模块分为启动分析、页面响应分析、流畅性分析。
- 页面响应分析模块:需要引入子库UITrackers。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
用户体验模块日志会在App的状态或者场景发生变化时进行记录,触发方式如下:
- App启动时会记录冷启动日志,该日志不可手动触发,且对于App的每次启动只会记录一条冷启动日志。
- App从后台切换到前台会记录热启动日志,可以通过前后台切换来进行触发。
- 当App发生场景切换时会记录页面响应日志,日志包含如下阶段的耗时:loadView、viewDidLoad、viewWillAppear、viewDidAppear,可以通过切换viewController来触发。
用户体验日志记录后不会立即上报,在以下时间会自动上报:
- 当App状态切换到background时,触发一次上报。
页面监控模块会捕获App的WebView发生的加载、请求和错误事件,开启功能需要引入子库Hybrid。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
您可以使用Web Demo在您的App中新建WebView进行测试,也可以参考Demo在您的App原本的WebView页面中编写测试用例。 页面监控日志记录后不会立即上报,在以下时间会自动上报:
- 当App状态切换到background时,触发一次上报。
内存优化模块会在App使用内存过高(超过1GB)时,采集当前状态下的所有内存节点和引用关系,生成内存快照文件并上传。对应的,在平台上可以看到内存过高时App的内存分配情况、通过现场信息排查内存泄漏或者大内存分配等问题。开启内存优化功能需要引入子库MemoryGraph。
说明
- 内存采集有一定的性能损耗,由于采集内存需要保证堆安全,当触发内存采集时会挂起线程,期间用户操作会被阻塞,造成一种“卡顿”现象。不过,内存采集仅当内存占用超出异常阈值时才会触发,对正常使用的用户没有影响。
- 内存分析功能只能在64位真机设备触发,只支持iPhone 6s及更高机型,要求操作系统iOS 10+。
- 以iPhone 8 Plus机型为例,当App内存占用超过1G时:
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
添加以下代码,调用OOMTrigger函数触发内存泄漏。
//设置的内存采集启动阈值,当App内存超过此值时将启动内存优化模块,采集App内存状态
static float dangerousMemoryThreshold = 1024.0;
//计算App当前的内存占用,当内存占用超过内存采集启动阈值时,返回true,否则返回false
bool overMemoryThreshold(void)
task_vm_info_data_t task_vm;
mach_msg_type_number_t task_vm_count = TASK_VM_INFO_COUNT;
kr = task_info(mach_task_self(), TASK_VM_INFO, (task_info_t) &task_vm, &task_vm_count);
if (kr == KERN_SUCCESS) {
printf("Current App Memory is :%f\n\n", task_vm.phys_footprint / (1024.0 * 1024.0));
if (task_vm.phys_footprint / (1024.0 * 1024.0) > dangerousMemoryThreshold) {
//触发内存泄漏,当App当前内存占用小于内存采集启动阈值时,会不断触发内存泄漏
dispatch_async(dispatch_get_global_queue(0, 0), ^{
if (!overMemoryThreshold()) {
CGSize size = CGSizeMake(1024 * 8, 1024 * 8 * 9.0f/16.0);
const size_t bitsPerComponent = 8;
const size_t bytesPerRow = size.width * 4;
CGContextRef ctx = CGBitmapContextCreate(calloc(sizeof(unsigned char), bytesPerRow * size.height), size.width, size.height, bitsPerComponent, bytesPerRow, CGColorSpaceCreateDeviceRGB(), kCGImageAlphaPremultipliedLast);
CGContextSetRGBFillColor(ctx, 1.0, 1.0, 1.0, 1.0);
CGContextFillRect(ctx, CGRectMake(0, 0, size.width, size.height));
说明
变量dangerousMemoryThreshold的值须修改为您在SDK上报配置中配置的内存采集启动阈值。如果您未配置或修改过此值,则无需修改。
App内存状态采集后,会在下一次App启动时进行上报。
上报内存文件前,会先向Server请求是否允许上传。如果Server不允许上传,则会在下一次App启动时重新请求。未通过请求的内存文件会缓存在App的沙盒中,当Server允许上传时一起上传。更多信息,请参见如何判断Server是否允许上传内存文件?。 网络分析模块需要引入子库Network。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
您可以发送一些网络请求触发SDK网络数据记录。
网络分析日志记录后不会立即上报,在以下时间会自动上报:
- 当App状态切换到background时,触发一次上报。
如果您不想或者只想监控某些URL的网络请求,可以在网络请求配置中进行配置。
日志回捞模块需要引入子库APMLog。通过使用SDK提供的接口进行打点,可以记录一些App运行期间产生的日志。此模块是一种基于mmap的高效率的日志打点框架,日志压缩率高达25倍,结合云控可以实现线上用户日志的实时定向回捞,帮助您高效精准的定位和解决问题。
日志不会全部上报,获取这些日志的方式如下:
- 崩溃发生后,自动上报崩溃发生前一段时间产生的日志。
- 下发云控命令,获取指定设备或用户、指定时间内产生的日志。更多信息请参见回捞。
注意
自定义日志的字符串限制为4*1024个字符。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
对于C/C++、Objective-C和Swift,APMPlus提供了三类日志打点的接口,每一类有四个接口:Debug、Info、Warn、Error,代表日志严重程度的四个等级,可以在平台查看日志时进行筛选。
警告
如果日志参数处理不当,可能导致崩溃。
RANGERSAPM_ALOG_INFO(tag, format, ...) 接口的第二个参数预期是一个 format,紧跟着可变参数,类似
[NSString stringWithFormat:format, ...],当 format 字符串中不包含 format specifiers 时,可以缺省可变参数。
在某些使用场景中,可能会直接把代码中的一个变量作为 format 参数传递,如果这个变量中非预期地包含了 format specifiers(特别是当变量是一个 URL 时)就会因为 format specifiers 和可变参数不匹配而产生崩溃。
为了更安全地使用接口,如果您希望把变量 urlString 作为 format 参数传递,建议参考以下示例代码:
RANGERSAPM_ALOG_INFO("TAG", @"%@", urlString);
//无论使用哪类接口,首先都需要先调用如下接口开启Alog功能
#import "RangersAPM+ALog.h"
// 自定义日志相关配置,需要设置启动SDK时传入的 RangersAPMConfig 参数的 alogParams 属性,配置说明详见头文件注释
RangersAPMALogParams *alogParams = [[RangersAPMALogParams alloc] init];
alogParams.maxDiskUsage = 50 * 1024 * 1024;
alogParams.validityPeriod = 7 * 24 * 60 * 60;
RangersAPMConfig *apmConfig = ...
apmConfig.alogParams = alogParams;
[RangersAPM startWithConfig:apmConfig];
[RangersAPM setALogEnabled]; //启用ALog
[RangersAPM enableConsoleLog]; //同时在控制台输出日志
BOOL isALogEnabled = [RangersAPM isALogEnabled]; //Alog 启用状态
//Objective-C 可以使用如下接口进行日志打点
#import "RangersAPM+ALog.h"
//第二个参数为日志具体信息,可以使用format类型,如果使用format,需要继续传入对应的参数
RANGERSAPM_ALOG_DEBUG(@"Business", @"version : %@", [self version]); //Debug类日志
RANGERSAPM_ALOG_INFO(@"Business", @"version : %@", [self version]); // Info类日志
RANGERSAPM_ALOG_WARN(@"Business", @"version : %@", [self version]); //Warn类日志
RANGERSAPM_ALOG_ERROR(@"Business", @"version : %@", [self version]); //Error类日志
#import "RangersAPM_ALog.h"
//第二个参数为日志具体信息,可以使用format类型,如果使用format,需要继续传入对应的参数
RANGERSAPM_ALOG_DEBUG_C("Business", "version : %s", version());
RANGERSAPM_ALOG_INFO_C("Business", "version : %s", version());
RANGERSAPM_ALOG_WARN_C("Business", "version : %s", version());
RANGERSAPM_ALOG_ERROR_C("Business", "version : %s", version());
#import "RangersAPM+ALog.h"
//fileName 为当前所在文件名,可以参考示例传入 #file
//funcName 为当前所在方法名,可以参考示例传入 #function
//line 为当前所在文件的行号,可以参考示例传入 #line
RangersAPM.debugALog("alogtest", tag: "Business", fileName: #file, funcName: #function, line: #line)
RangersAPM.infoALog("alogtest", tag: "Business", fileName: #file, funcName: #function, line: #line)
RangersAPM.warnALog("alogtest", tag: "Business", fileName: #file, funcName: #function, line: #line)
RangersAPM.errorALog("alogtest", tag: "Business", fileName: #file, funcName: #function, line: #line)
CPU监控模块包含两个子模块:CPU指标和CPU异常。
- 监控App运行过程中的CPU使用情况,同时SDK版本需要高于2.7.3。
- CPU异常模块:需要引入子库CPUException。
- 监控App运行过程中CPU使用率过高的场景,并记录当时的调用堆栈。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
CPU指标会在App运行时自动上报。以下示例代码模拟CPU使用率过高场景,触发CPU异常的上报。
for (int i = 0; i < 10; i++) {
NSString *queueName = [NSString stringWithFormat:@"com.apmplus.testcpu%d",i];
dispatch_queue_t queue = dispatch_queue_create([queueName UTF8String], DISPATCH_QUEUE_SERIAL);
dispatch_async(queue, ^{
MetricKit模块会监控MetricKit.framework生成的系统日志,并上报给平台。如需接入,请引入MetricKit子库,同时APMPlus SDK版本需要高于2.12.1。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
系统会每天生成一份MetricKit日志,提供给业务方。如果想测试是否接入成功,请在真机调试状态下,执行如下操作:
Disk模块会监控沙盒的使用情况。同时,将生成指标和异常信息上报给平台。如需接入,请引入Disk子库,同时APMPlus SDK版本需要高于3.0.0。
测试用例是通过在项目中添加样例代码并在合适的时机触发,来验证SDK能否捕获对应事件的日志。您可以参见各模块给出的样例代码和说明,或者参见Demo工程。
为了防止检索沙盒文件,影响用户体验。磁盘监控启动时,Disk模块会在程序后台检索沙盒文件并上报。
自定义回捞可以按照配置拉取沙盒或内存中指定的信息到APMPlus平台,进行问题排查或数据分析。如需接入,请引入CloudCommand子库,同时APMPlus SDK版本需要高于3.5.3。
#import <Foundation/Foundation.h>
#import "RangersAPM+CloudCommand.h"
@interface APMPlusCustomCloudHandler : RangersAPMCustomCommandBase
#import "APMPlusCustomCloudHandler.h"
@implementation APMPlusCustomCloudHandler
+ (NSString *)cloudCommandIdentifier {
+ (instancetype)createInstance {
static APMPlusCustomCloudHandler *handler = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
handler = [[APMPlusCustomCloudHandler alloc] init];
- (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";
- (void)uploadCustomCommandResultSucceededWithParams:(NSDictionary *)params {
NSLog(@"------ %s", __func__);
- (void)uploadCustomCommandResultFailedWithParams:(NSDictionary *)params error:(NSError *)error {
NSLog(@"------ %s", __func__);
- 在RangersAPM启动后,调用如下代码,注入自定义回捞响应类。
[RangersAPM addCustomCommandHandlerCls:[APMPlusCustomCloudHandler class]];
"business_Akey":"business_Avalue",
"business_Bkey":"business_Bvalue",
- command:在iOS工程中,会通过该字段的值将命令分发给不同的handler来执行。