# rlog

**Repository Path**: rolland/rlog

## Basic Information

- **Project Name**: rlog
- **Description**: 一个前端日志工具,用于输出各种前端常用日志
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2020-08-14
- **Last Updated**: 2024-07-23

## Categories & Tags

**Categories**: logging

**Tags**: None

## README

# rlog

#### 介绍

一个前端日志系统


#### 安装教程

npm i rubylog

## 日志级别 

框架日志分为 NONE，DEBUG，INFO，WARN 和 ERROR 5 个级别，别在不同的场景下使用 

使用外部文件进行配置，方便现场实施进行修改 


* `logger.trace(msg)` ：输出一个堆栈跟踪 0 
    * * `logger.debug(msg)` ：输出一个调试日志 1 
    * 与程序运行时的流程相关的详细信息以及当前变量状态 
* `logger.info(msg)` ：输出一个信息日志 2 
    * 有意义的事件信息，记录程序正常的运行状态，比如收到请求，成功执行。 
* `logger.warn(msg)` ：输出一个警告日志 3 
    * 预期之外的运行时状况，表示系统可能出现问题。 
    * 对于那些目前还不是错误，然而不及时处理也会变成错误的情况，也可以记为WARN，如磁盘过低 
* `logger.error(msg)` ：输出一个错误日志 4 
    * 运行时异常以及预期之外的错误，也需要立即处理，当错误发生时，影响了程序的正确执行。需要注意的是这两种级别属于服务自己的错误，需要管理员介入，用户输入出错不属于此分类，请求后端、读文件、数据库等超时、返回错误结构 

不同级别的上报方式 

1. Trace:打印在控制台 
2. Debug:打印在控制台 
3. Info:保存日志 
4. Warn:保存日志 
5. Error:保存日志,实时上报 





#### 使用说明

日志记录方式

```javascript
//level:日志级别,log:日志内容  
rlog.log(level, log);
//自定义日志参数信息
const debugObj={
        info:'Debug信息',
        module:'视图1',
        debug:{'cardData':cardData},
        codeline:67,
        file:'view_overview.jsx'
}
rlog.log('info',"可以只输入一条文字信息");

rlog.info('可以直接按级别输出信息');

rlog.log('debug',debugObj);

//预设日志方法

rlog.getReactDrawTime('视图');   //获取react模块渲染时间

rlog.event(e);      //输出一条event日志
``` 








#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request