bonreeAgent
博睿性能采集SDK
安装指南
Cocoapods方式
-
在工程的 Podfile 文件中添加
pod 'bonreeAgent'
安装包方式
- 解压bonreeAgent.framework.tar.gz，将bonreeAgent.framework加入到项目中，如图所示
- 在BuildPhass -> Link Binary With Libraries中添加bonreeAgent.framework，如图所示：
- 添加以下依赖库
- libresolv.tbd（必须引入）
- libc++.tbd（必须引入）
- webKit.framework（如果项目支持iOS8之前版本需要添加）
- 在Build Setting中搜索Other Linker Flags, 添加编译标志**-ObjC**。如图所示
使用
Objective-C
-
引入头文件: 在AppDelegate.m中导入头文件。
-
在application:didFinishLaunchingWithOptions中设置config地址与AppId，如图所示
[BRSAgent setConfigAddress:@"https://sdkupload.bonree.com/config"];
[BRSAgent startWithAppID:@"40766f87-13a8-48d3-9c96-1ce7c3cde50f"];
Swift
- 在对应的桥接文件bridging-header.h中引入头文件，如图所示
- AppDelegate.swift文件中设置config地址和AppId，如图所示
运行后有日志 bonreeAgent config succeeded ,即表示嵌码成功,如下
2019-06-21 13:55:40 +0000 [bonreeAgent] bonreeAgent config succeededJS行为数据监测
-
会员id设置
-
字段说明
- id：客户app会员用户的id，主要用于区分不同会员用户的行为。
-
示例
在需要设置会员用户id时，添加如下代码
<script> function myclick() { document.getElementById("demo").innerHTML=Date(); bonreeJsBridge.onMemberId('1'); } </script>
-
-
自定义视图的统计
bonreeJsBridge.onPageStart(String pageId, String pageName); bonreeJsBridge.onPageEnd(String pageId, String pageName);
-
字段说明
- pageId：自定义视图的ID（建议使用字母）
- pageName：自定义视图的名称（建议使用字母）
-
示例
监测关于html界面，其对应html名称为About.html
<script> function myclick() { document.getElementById("demo").innerHTML=Date(); bonreeJsBridge.onPageStart("1","About"); bonreeJsBridge.onPageEnd("1","About"); } </script>
-
注意点： onPageStart和onPageEnd须成对调用
-
-
自定义事件的统计
bonreeJsBridge.onEvent(String eventId, String eventName);
-
字段说明
- eventId：自定义事件的ID
- eventName：自定义事件的名称
-
示例
某html页面将监测某button的使用情况
<script> function myclick() { document.getElementById("demo").innerHTML=Date(); bonreeJsBridge.onEvent("1",'just a test'); } </script>
-
-
用户自定义信息的统计
bonreeJsBridge.setUserInfo(String kv);
-
字段说明
- kv：自定义信息，NSDictionary或者json 字符串
-
示例
某html页面在进入某一个页面时设置自定义信息
<script> function myclick() { document.getElementById("demo").innerHTML=Date(); var json = '{ "js1": "jsvalue1", "js2": "jsvalue1", "js3":"jsvalue3" }'; bonreeJsBridge.setUserInfo(json); } </script>
-
注意点
- bonreeAgent启动要在didFinishLaunchingWithOptions方法的最前面
- Config地址接口调用须在SDK初始化接口startWithAppID之前调用，否则私有云地址设置将无法生效;
- 私有云需要调用setConfigAddress,设置config地址,具体地址由技术支持提供
- 私有云使用6.1.0版本SDK，平台最低为5.9.2版本
- SDK仅支持iOS8.0及以上版本,网络和WEB模块的网络数据采集仅支持iOS10及以上版本
- WKWebView采集仅支持iOS11及以上版本
常见问题
-
为什么 bonreeAgent 启动要在 didFinishLaunchingWithOptions 方法的最前面？
答：最前面启动可以保证数据的继承链完整被hook，从而数据采集更加全面！
-
bonreeAgent 崩溃与友盟崩溃可以同时使用吗？
答：可以。但由于友盟没有做崩溃事件的传递，因此启动位置需要在友盟之后，才能正常抓取崩溃。
-
bonreeAgent 崩溃与极光崩溃日志功能可以同时使用吗？
答：极光开启崩溃日志功能，会导致 bonreeAgent OC 崩溃捕获异常，建议不要同时使用。极光崩溃日志功能 API 如下
-
bonreeAgent 崩溃与 bugly 可以同时使用吗？
答：可以。但启动需要在 bugly 启动之前，否则可能会引发 bugly 崩溃卡死问题。
-
项目做了自定义崩溃处理，使用 bonreeAgent 崩溃功能有启动顺序要求吗？
答：建议在该方法调用之后启动。
-
为什么 bonreeAgent 启动要放在 AFNetworking 初始化之前？
答：AFNetworking 优先初始化，可能会导致 AF 的网络请求无法被采集。
API 介绍
/**启动bonreeAgent*/
+ (void)startWithAppID:(NSString*)appid;
/**设置config地址,默认公有云不用设置*/
+ (void)setConfigAddress:(NSString*)configAddress;
/**设置app版本(请在bonreeAgent启动之前设置)*/
+ (void)setAppVersion:(NSString *)appVersion;
/**设置下载渠道名称*/
+ (void)setChannelName:(NSString*)channelName;
/**设置会员id*/
+ (void)setMemberId:(NSString *)memberId;
/**设置用户信息(客户可通过kv<key,value>参数增加用户信息，key为NSString类型，value为NSString或NSNumber类型)*/
+ (void)setUserInfo:(NSDictionary *)kv;
/*
打开日志标志,默认只打开BRS_LOG_PUBLIC日志.
此接口调试时调用,不建议在生产环境调用.
例:打开BRS_LOG_PBDATA日志
[BRSAgent setLogFlag:@(BRS_LOG_PUBLIC|BRS_LOG_PBDATA)];
如果将日志写到文件中,
需要在应用程序的Info.plist文件中添加Application supports iTunes file sharing键，
并将键值设置为YES.
例:打开BRS_LOG_PBDATA日志且写到文件中
[BRSAgent setLogFlag:@(BRS_LOG_PUBLIC|BRS_LOG_PBDATA|BRS_LOG_TO_FILE)];
关闭日志开关:
[BRSAgent setLogFlag:@0];
*/
+ (void)setLogFlag:(NSNumber*)flag;
/**获取设备的deviceId*/
+ (NSString *)deviceId;
/**
配置自定义的设备deviceId
注意:该方法必须在 - startWithAppID: 方法前调用,并且只能设置一次.
*/
+ (void)setDeviceID:(NSString *)deviceID;
/**获取SDK的版本号*/
+ (NSString *)SDKVersion;
/**即时upload接口，客户调用该接口，将sdk目前保存的数据及当前视图的信息直接上传。(同步上传，建议客户启用新的线程调用)*/
+ (void)upload:(void(^)(NSError *error))result;
+ (void)stopSDK;
/**
配置博睿的异常接口监听
@param callback 错误回调
*/
+ (void)setExceptionCallback:(void(^ _Nullable)(NSString * _Nullable errorMessege))callback;
#pragma mark - 自定义
/**
自定义异常收集
q @param exceptionType 异常类型
@param causedBy 异常原因
@param errorDump 异常堆栈
*/
+ (void)setCustomExceptionWithExceptionType:(NSString *)exceptionType
causeBy:(NSString * _Nullable)causedBy
errorDump:(NSString * _Nullable)errorDump;
/**
自定义事件
@param eventId 事件ID
@param eventName 事件名
@param eventInfo 事件信息，对事件的描述
*/
+ (void)setCustomEventWithEventId:(NSString *)eventId
eventName:(NSString * _Nullable)eventName
eventInfo:(NSDictionary * _Nullable)eventInfo;
/**
自定义视图之标记页面开始（和页面结束方法成对调用）
@param pageId 页面ID
@param pageName 页面名
一般调用位置：viewWillAppear或者viewDidAppear
*/
+ (void)setCustomViewOfBeginWithPageId:(NSString *)pageId
pageName:(NSString * _Nullable)pageName;
/**
自定义视图之标记页面结束（和页面开始方法成对调用）
@param pageId 页面ID
@param pageName 页面名
一般调用位置：viewWillDisappear或者viewDidDisappear
*/
+ (void)setCustomViewOfEndWithPageId:(NSString *)pageId
pageName:(NSString * _Nullable)pageName;
/**
用户测速接口
@param parsingType 解析类型 ,客户标识
@param content 需要解析的内容（一般为json格式的数据字典或者数组转换的结果）
@param isOnce 是否只上传一次，true上传后清空content，false上传完成后不清空content，到下次上传的时候继续上传该content
*/
+ (void)setCustomSpeedWithParsingType:(NSString *)parsingType
content:(NSString * _Nullable)content
isOnce:(BOOL)isOnce;
/// 记录应用启动时间 (在main函数中调用) 返回值为记录的启动时间戳
+ (uint64_t)recordLaunchTime;
/// 客户自定义请求头业务
/// @param headerArr 要获取的请求头中键名数组
+ (void)setCustomBusinessHeaders:(NSArray *)headerArr;
/// 是否使用mPaaS框架
/// @param used 是否使用mPaaS
+ (void)useMpaas:(BOOL)used;