参数 | 用途 |
setConfig | 传入配置对象，包括用户 ID 和 UIN 等信息 |
info | 主要上报字段，用于上报白名单日志。下列两种情况日志才会报到后台： 1. 打开页面的用户在名单中。 2. 对应的页面发生了错误。 |
infoAll | 主要上报字段，用于上报白名单日志。该上报与 info 唯一的区别： info 指定用户上报。 |
error | 主要上报字段，用于上报错误信息。 |
report | 用来上报任意类型的日志信息。 |
reportEvent | 上报自定义事件。 |
reportTime | 上报自定义测速资源。 |
time | 上报自定义测速资源，与 timeEnd 共同使用。适用于两个时间点之间时长的计算并上报。 |
timeEnd | 上报自定义测速资源，与 time 共同使用。适用于两个时间点之间时长的计算并上报。 |
destroy | 销毁aegis实例。 |
const aegis = new Aegis({id: 'pGUVFTCZyewxxxxx',uin: '777'})
uin。若在获取 UIN 的这段时间不进行实例化，这期间发生的错误前端性能监控将无法监听。针对这种情况，我们可以先传入 ID 进行实例化，引用 setConfig 传入 UIN ，示例如下：const aegis = new Aegis({id: 'pGUVFTCZyewxxxxx'})// 拿到uin之后...aegis.setConfig({uin: '6666'})
// info 可以上报任意字符串，数字，数组，对象，但是只有打开页面的用户在名单中才会上报aegis.info('test');aegis.info('test', 123, ['a', 'b', 'c', 1], {a: '123'});// 也可以上报特定的对象，支持用户传ext参数和trace参数// 注意这种 case 一定要传 msg 字段aegis.info({msg: 'test',ext1: 'ext1',ext2: 'ext2',ext3: 'ext3',trace: 'trace',});// 不同于 info，infoAll 表示全量上报aegis.infoAll({msg: 'test',ext1: 'ext1',ext2: 'ext2',ext3: 'ext3',trace: 'trace',});// error 用来表示 JS 错误日志，也是全量上报，一般用于开发者主动获取JS异常，然后进行上报aegis.error({msg: 'test',ext1: 'ext1',ext2: 'ext2',ext3: 'ext3',trace: 'trace',});aegis.error(new Error('主动上报一个错误'));// report 默认是 aegis.report 的日志类型，但是现在您可以传入任何日志类型了aegis.report({msg: '这是一个ajax错误日志',level: Aegis.LogType.AJAX_ERROR,ext1: 'ext1',ext2: 'ext2',ext3: 'ext3',trace: 'trace',});
aegis.reportEvent('XXX请求成功');
aegis.reportEvent({name: 'XXX请求成功', // 必填ext1: '额外参数1',ext2: '额外参数2',ext3: '额外参数3',})
// 假如‘onload’的时间是1saegis.reportTime('onload', 1000);
aegis.reportTime({name: 'onload', // 自定义测速 nameduration: 1000, // 自定义测速耗时(0 - 60000)ext1: 'test1',ext2: 'test2',ext3: 'test3',});
onload 可以修改为其他的命名。aegis.time('complexOperation');/*** .* .* 做了很久的复杂操作之后。* .* .*/aegis.timeEnd('complexOperation'); /** 此时日志已经报上去了**/
complexOperation 可以修改为其他的命名。
自定义测速是用户上报任意值，服务端对其进行统计和计算。由于服务端不能做脏数据处理，建议用户在上报端进行统计值限制，防止脏数据对整体产生影响。
目前 Aegis 只支持 0 - 60000 的数值计算，如果大于该值，建议进行合理改造。 aegis.destroy();
文档反馈