安装

npm install dl-log

快速上手

1. 简单用法

import { LogClass , Enum } from 'dl-log';

// 创建日志采集器
const logs = new LogClass();

// 监听事件
logs.on(Enum.LogErrorIncident.GET_BROWSER_ERROR,(error)=>{
    console.log(error)
})

2. 标准用法

import { LogClass , Enum } from 'dl-log';

// 创建日志采集器，是否打印采集到的日志信息，printLog：是否抛出异常，noThrowError：如果为：false 的话系统不会因为异常而停止运行
const logs = new LogClass({printLog:true,noThrowError:true});

// 监听事件
logs.on(Enum.LogErrorIncident.GET_BROWSER_ERROR,(error)=>{
    console.log(error)
})

3. 配置参数

import { LogClass } from 'dl-log';

// 使用方法1  (构造传参)  推荐
new LogClass({printLog:true,noThrowError:true});

// 使用方法2 （调用配置方法传参） 灵活修改
const logs = new LogClass();
logs.injectCustomConfig({printLog:true,noThrowError:true});

API 文档

LogClass

日志采集器

| 方法 | 参数类型 | 说明 | | ------------------------------------------------------------ | --------------------------- | ---------------- | | injectCustomConfig( config :LogConfig ) | LogConfig | 注入自定义配置 | | destroyLogErrorEventListener() | 无 | 销毁所有日志监听 | | on(type: LogErrorIncident, fn:Function) | | 监听日志采集数据 |

LogConfig

日志配置对象

| 属性 | 类型 | 说明 | | :---------------------: | :-----: | :-------------------------------------------: | | noThrowError | Boolean | 不抛出异常，让程序继续执行下去。defalut:false | | startNodeThrowError | Boolean | 启动 node 异常拦截 defalut:false（node 环境） | | starBrowserThrowError | Boolean | 启动 浏览器 异常拦截 defalut:true（web 环境） | | printLog | Boolean | 是否在控制台打印日志 defalut:false |

LogErrorIncident

日志异常事件

| 属性 | 说明 | | :------------------------: | :----------------: | | GET_BROWSER_SEVERITY_ERROR | 浏览器严重异常事件 | | GET_BROWSER_ERROR | 浏览器异常事件 | | GET_NODE_SEVERITY_ERROR | node严重异常事件 | | GET_NODE_ERROR | node异常事件 |

LogErrorMessage

采集日志实例信息

| 属性 | 类型 | 说明 | | :------: | :----: | :--------------: | | message | String | 【必填】错误信息 | | page | String | 获取页面 | | url | String | 获取地址和端口 | | stack | String | 堆栈信息 | | lineno | Number | 错误的行数 | | filename | String | 异常代码的文件名 |