1.0.0 • Published 1 year ago

bonree-log-jsagent v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

bonree-log-jsagent

bonreelog用于采集browser中的日志数据,bonreelog可自动采集上报网络错误、js错误、控制台console输出的日志数据及自定义的日志数据。

如何使用

  • 安装

    npm install bonree-log-jsagent --save
  • 导出

    import {BRLogStart} from 'bonree-log-agent'
  • 初始配置

    BrLogStart({
        token:'b5a8ce5e-a3a8-11ed-b908-0e832fe4bb04',
        uploadAddrHttp:'http://one-log-controller.bonree.com/logs/v1/upload',
        uploadAddrHttps:'https://one-log-controller.bonree.com/logs/v1/upload'
    })
  • 代码中使用

    window.BRLog&&window.BRLog.logger.info('this is a log from web')

配置

属性默认值必填描述
tokenstring账号标识
uploadAddrHttpstring数据上传地址,与uploadAddrHttps需配置其一。http页面需配置uploadAddrHttp
uploadAddrHttpsstring数据上传地址,与uploadAddrHttp需配置其一。https页面需配置uploadAddrHttps
uploadPeriodstring15上报频率 单位:秒
enablebooleantrue控制探针开启,默认开启
debugbooleanfalse是否开启logger输出,开启debug模式,默认关闭
consoleCollector'log','info','debug','warn','error'[]配置是否采集console.log| info | debug | warn |error的日志数据,默认关闭
netCollectorbooleanfalse配置是否采集网络错误数据,默认关闭
errorCollectorbooleanfalse配置是否采集JS错误数据,默认关闭

日志级别

levelstatus
debug0
info1
warn2
error3

用法

自定义日志

bonreeLog初始化成功后,使用API直接向平台发送自定义日志,支持传入message自定义日志数据,支持传入Error对象

logger.debug | info | warn | error (message: string,error?: Error)
用例
try {
  ...
  throw new Error('Wrong behavior')
  ...
} catch (error) {
  window.BRLog&&window.BRLog.logger.error('Error occurred', error)
}
完全自定义日志

bonreeLog初始化成功后,使用API直接向平台发送自定义日志,支持自定义日志级别(debug、info、warn、error),支持传入message自定义日志数据,支持传入Error对象,支持自定义属性attribute,attribute仅支持传入{key:value,...}格式对象

logger.log (level:'debug'|'info'|'warn'|'error', message: string ,error?: Error ,attribute?:object)
用例
try {
  ...
  throw new Error('Minor misbehavior')
  ...
} catch (error) {
  window.BRLog&&window.BRLog.logger.log('info', 'Minor misbehavior occurs',error,{JSON:'JSON parsing failed'})
}

高级用法

过滤日志

bonreeLog初始化成功后,使用 API 设置记录的最低日志级别,低于该日志级别的日志数据将被过滤

setLevel (level: 'debug' | 'info' | 'warn' | 'error')
用例
 window.BRLog&&window.BRLog.setLevel('info')
添加属性

bonreeLog初始化成功后,使用 API 记录添加全局日志属性

addAttribute(key:string,value:string)
用例
 window.BRLog&&window.BRLog.addAttribute('original','logger')
移除属性

bonreeLog初始化成功后,使用 API 记录移除全局日志属性

removeAttribute(key:string)
用例
window.BRLog&&window.BRLog.addAttribute('original')