API功能

一、启动配置接口

自定义冷启动结束时间

recordCustomLaunchEnd()

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

1.在原生工程中调用自定义冷启动开关接口,开启自定冷启动功能。(该接口需在BonreeSDK启动前设置)

Android

Bonree.withAppID("c1f18f3a-ba47-408a-9f80-ea87b6c083dk")
              .withUseCustomLaunch(true) 
              .start(this);

iOS

// 需在BonreeSDK启动之前设置
[BRSAgent useCustomLaunch:YES];
// 需在BonreeSDK启动之前设置
BRSAgent.useCustomLaunch(true)

2.在需要的时机调用冷启动结束接口,记录冷启动结束。

Bonree.recordCustomLaunchEnd()

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

二、自定义功能接口

自定义用户信息

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

设置用户信息有两种方式:

1. 设置用户ID,以字符串形式给用户做标识。接口如下:
setUserID(userId)
  • 接口说明
参数名 类型 注释
userId String 用户ID
  • 示例

      Bonree.setUserID('user id');
    
2. 以 Key-Value 形式设置用户附加信息。接口如下:
setExtraInfo(userInfo)
  • 接口说明
参数名 类型 注释
extraInfo Object 用户附加信息。Value限制字符串或数字类型。
  • 示例

      Bonree.setExtraInfo({ id: '123456', name: 'Tom' });
    

自定义异常

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

setCustomException(exceptionType,causedBy,errorDump)
  • 接口说明
参数名 类型 注释
exceptionType String 异常类型。必传参数,空或空串接口调用无效。
causedBy String 异常原因
errorDump String 异常堆栈
  • 示例

      Bonree.setCustomException('Custom exception type',
                                'Caused by customer.',
                                'Custom error dump 0\nCustom error dump 1');
    

自定义视图

调用接口并传入相应参数,可完成自定义视图数据统计功能。

setCustomPageStart(pageName,pageAlias)
setCustomPageEnd(pageName,pageAlias)
  • 接口说明
参数名 类型 注释
pageName String 页面名称。必传参数,空或空串接口调用无效。
pageAlias String 页面别名
  • 示例

      Bonree.setCustomPageStart('page01', '首页');
    
      Bonree.setCustomPageEnd('page01', '首页');
    

注意:自定义视图的开始与结束记录接口必须成对调用,并且同一视图的pageName必须一致,才能正确统计一个完整自定义视图数据并上报。

自定义事件

调用接口并传入相应参数,可完成自定义事件数据统计功能。

/// 自定义事件
setCustomEvent(eventId,eventName,param)
  • 接口说明
参数名 类型 注释
eventID String 事件ID。必传参数,空或空串接口调用无效。
eventName String 事件名称
param String 附加信息(预留字段,暂无使用场景)
  • 示例

      Bonree.setCustomEvent('001', 'Login', '');
    

自定义日志

调用接口并传入相应参数,可完成自定义日志数据统计功能。

setCustomLog(logInfo,param)
  • 接口说明
参数名 类型 注释
logInfo String 日志信息。必传参数,空或空串接口调用无效。
param String 附加信息(预留字段,暂无使用场景)
  • 示例

      Bonree.setCustomLog('2020-01-01 08:30:00 Print log info.', '');
    

自定义指标

调用接口并传入相应参数,可完成自定义指标数据统计功能。

setCustomMetric(metricName,metricValue,param)
  • 接口说明
参数名 类型 注释
metricName String 指标名称。必传参数,空或空串接口调用无效。
metricValue Int 指标值。必传参数,指标为空接口调用无效。
param String 附加信息(预留字段,暂无使用场景)
  • 示例

      Bonree.setCustomMetric('测试指标01', 1, '');
    

results matching ""

    No results matching ""