CloudLog.JS

基本功能

将不同级别的日志以不同颜色格式化输出到控制台

将日志记录上传到 MongoDB 数据库

将 MongoDB 数据库内的日志记录可视化展示（并提供筛选功能）

使用方法

开始使用

1、导入包

npm install cloudlogjs --save

你也可以使用其他任何你喜欢的包管理器，这里演示使用 npm。

2、引入 CloudLog.JS

//nodejs
const cloudlog = require('cloudlogjs');
//ES6 Module
import cloudlog from 'cloudlogjs';

3、初始化

const logger = new cloudlog();

格式化输出日志

logger.trace('这是一个TRACE级别日志');
logger.debug('这是一条debug信息');
logger.info('这是一条消息');
logger.warn('这是一条警告');
logger.error('这是一条错误信息');
logger.fatal('这是一条致命错误信息');

如果你想要在输出日志的时候附加数据，你可以传入第二个参数：

logger.debug('这是一条debug信息',{name:'info',message:'Hello, CloudLog!'});

如果有某一条数据你不想上传到数据库，你可以传入第三个参数：

logger.debug('这条信息不会被上传到数据库',{name:'info',message:'Hello, CloudLog!'},false);

logger.debug('这条信息不会被上传到数据库',undefined,false);//不附加数据的情况

将日志上传到数据库

注意，如果你不做这一步操作，那么 CloudLog 会以本地模式运行，这样你的log数据不会上传到数据库。

你可以使用一个免费的 MongoDB 云数据库，注册地址：https://www.mongodb.com/atlas/database

如果你使用自己搭建的 CloudLOG 后端，你可以使用你后端服务器的本地数据库，例如：mongodb://localhost:27017

总之，最终你会得到一个允许 CloudLOG 后端访问的数据库链接，格式类似于这样：

mongodb://localhost:27017 或mongodb+srv://username:password@......

这就是你要将日志上传到数据库的链接。

或者，你可以非常简单地搭建一个 CloudLOG后端：

cd backend
npm install
npm run serve

然后，初始化 logger，告诉它你需要使用的 CloudLOG 后端 url 与数据库链接：

第一个参数是使用的 CloudLOG 后端 url，第二个参数是数据库链接。

logger.init('https://cl.xxx.com', 'mongodb+srv://username:password@......');

这样，你的日志就会被上传到数据库。

设置日志级别

你可以设置要输出的日志级别，所有在该级别以下的日志将不会被输出到控制台上。

logger.setLevel('DEBUG');//DEBUG 级别以下的日志不会输出

但是，所有级别的日志都会被上传到数据库，原因是CloudLOG 前端有筛选显示日志级别的选项。

设置日志集合

如果你没有设置日志集合，那么所有日志都会被打到默认的 main 集合中，你可以手动设置要将日志打到哪个集合中，以区分不同系统的日志：

logger.setCollection('MyCollection');

上传日志开关

你可以通过 setUpload 来开关是否要上传日志。

logger.setUpload(false);//关闭上传开关
//以下数据不会被上传：
logger.trace('网络些许波动');
logger.debug('当前正在处理数据：',{id:'114514',name:'Tadokoro Lee',location:'Shimokitazawa'});
logger.info('有新用户注册');
logger.setUpload(true);//打开上传开关
//以下数据会被上传
logger.warn('服务器负载接近阈值');
logger.error('错误的数据录入');
logger.fatal('服务器负载过大',);

一个完整的示例

const cljs = require('cloudlogjs');
//或： import cljs from 'cloudlogjs';

const logger = new cljs();//初始化
logger.init('https://cl.xxx.com','mongodb+srv://username:password@......')//设置后端及数据库链接
logger.setLevel('DEBUG');//只会显示DEBUG级别以上的日志

logger.trace('这是一个TRACE级别日志');
logger.debug('这是一条debug信息');
logger.info('这是一条消息');
logger.warn('这是一条警告');
logger.error('这是一条错误信息');
logger.fatal('这是一条致命错误信息');

使用 CloudLOG 前端

当你完成后端服务的启动后，你就可以访问 CloudLOG 网站了：

比如，如果你在本地启动了 CloudLOG 服务，你可以访问：

http://localhost:3001 来访问 CloudLOG 前端。

如果你使用了我提供的公用 CloudLOG 服务，请访问：

https://cl.xxx.com/

然后，在数据源管理中提供数据库访问链接，并为其设置一个备注后，你就可以访问到数据库里的 log 了。

你可以使用筛选功能来筛选你想要看到的信息: