4.1.1 • Published 4 days ago

ccic-h5-apm v4.1.1

Weekly downloads
-
License
ISC
Repository
-
Last release
4 days ago

CCICWebErrorMonitor

引入方法

  1. npm install --save ccic-h5-apm
import CCICWebErrorMonitor from 'ccic-h5-apm'
  1. cdn 链接

Usage

初始化

var errorMonitor = new CCICWebErrorMonitor({
    exclude: {
        'E1008': [],         //过滤所有E1001错误
        'E1004': ['<img']    //过滤E1004错误中包含<img的错误,多个指定字符用逗号分隔
    },
    autoSend: true, // 是否自动投递 默认 true
    sendOptions: {
        url: '', // 日志投递地址(当type=gio时无需传入)
        type: 'single', // 日志投递模式,默认single单个投递,可选mutiple批量投递和gio投递growingio
        environment: 'dev', // 埋点投递环境可选dev,pro(type = gio 必填),默认测试环境
        network: 'external', // 网络类型可选intranet,external(type = gio 必填) 默认外网
        logSendDur: 30 // 异常日志队列扫描间隔,默认30s
    }
    frame: {
        name: 'vue', //框架名称
        obj: Vue //框架对象
    }
    logMergeTime: 3000,  //合并重复异常的间隔时间,默认3000ms
    errorTemp: ...  //本地存储的日志,默认通过localStorage存取
});

投递接口options:
{
    body: JSON.stringify({
        apm: {
            code: ...,
            info: ...
        }
    }),
    headers: {
        'Content-Type': 'application/json'
    },
    method: 'POST'
}
  • 配置项
options是否必填说明
excludeN需要过滤的错误类型和指定错误;需要过滤的错误类型作为 key,值为该错误类型中需要过滤的包含指定字符的错误
autoSendN是否通过 sdk 集成的方法自动发送异常日志,默认为 true,需要配置 sendUrl。通过其他方式自定义发送异常日志,设为 false
urlN自动发送异常日志的接口地址
nameN开启框架自身的异常监控,框架名称'vue'
objN开启框架自身的异常监控,目前支持 Vue [传入全局 Vue 对象typeY投递类型 single单个投递、mutiple、批量头题gio 投递growingIO
logMergeTimeN合并重复异常的间隔时间,默认 3000ms
logSendDurN异常日志队列扫描间隔时间,默认 30s
errorTempN本地存储的日志,默认通过 localStorage 存取

注册设备信息

errorMonitor.registerDevice(params);

params 为需要记录到日志中的设备信息,可自行传入需要的信息,默认参数 deviceId,os,ua

{
    deviceId: '',       //设备id
    os: navi.platform,  //操作系统,默认通过navigator取
    ua: navi.userAgent  //ua,默认通过navigator取
}

注册应用信息

errorMonitor.registerIdentity(params);

params 为需要记录到日志中的设备信息,可自行传入需要的信息,默认参数 system,userInfo,accountId,dataSourceId,version

{
    system: '',     //业务系统信息
    userInfo: ''    //用户信息
    accountId: '', // gio accountId
    dataSourceId: '', // gio dataSourceId
    version: '', // 版本号
}

存储异常日志

errorMonitor.saveLog = (res) => {
    //do something
    默认存入localStorage,res是异常信息json对象
};

启动监测

errorMonitor.start();

关闭异常投递

errorMonitor.stop();

错误代码

异常 code说明
E1001系统未知错误
E1002vue 逻辑错误
E1003JavaScript 错误
E1004静态资源加载错误
E1005请求错误
E1006Promise 错误
E1007网络离线
E1008网络状态变化

日志分级

'track', 'TRACK', 等级最低 'debug', 'DEBUG', 'info', 'INFO', 'warn', 'WARN', 'error', 'ERROR', 'fatal', 'FATAL' 等级最高

4.1.1

4 days ago

4.1.0

10 days ago

4.0.0

10 days ago

3.0.0

25 days ago

1.1.1

6 months ago

1.1.0

6 months ago

1.1.1-2

6 months ago

1.1.1-1

6 months ago

1.1.1-0

6 months ago

2.0.0

6 months ago

1.0.6

11 months ago

1.0.5

11 months ago

1.0.4

11 months ago

1.0.3

12 months ago

1.0.2

12 months ago

1.0.1

12 months ago

1.0.0

12 months ago