nodejs log4js 使用详解


Posted in NodeJs onMay 31, 2019

本文章针对 log4js v4.3

本文对自己用log4js的技术点简单的做一个记录,有一些技术点没有用到或者写全,会在后面用到的时候进行更新。

先大概的对log4js 的基本用法做一个总结,使用configure()方法对日志输出进行配置,使用 getlogger()方法获取logger对象,然后使用logger 对象进行打印各个级别的日志。其中比较复杂的是 configure()方法中的配置对象appenders 和 categories 下面重点讲解这两个对象

安装

npm install --save log4js

日志级别level

log4js的分为以下几个级别,级别的顺序也是按如下排列,logger只会打印大于等于logger对象设置的level的日志。

  • trace
  • debug
  • info
  • warn
  • error
  • fatal

简单的用法

var log4js = require('log4js');
var logger = log4js.getLogger();
logger.level = 'debug';
logger.debug("Some debug messages");

getLogger()方法返回一个logger对象,想对日志进行记录就必须使用logger对象,将logger对象的 level设置为debug(默认为OFF不会输出任何日志)

在node 环境运行上面的代码之后发现在控制台打印出了对应的日志信息,但是这跟我想要的完全不一样,我想要的是根据我自己的想法将日志进行分类方便查找和统计。接下来我们就看如何对日志进行分类。

configure(string | object) 方法

通过调用configure 方法就可以实现我们对日志进行分类管理的目的。方法的参数可以是一个字符串或者是一个object 字符串参数被视为用于加载配置的文件名,配置文件是一个json 文件,也可以直接将配置对象传给configure。

配置对象

本次只对配置对象中最常用的appenders 和categories 进行介绍,还有部分属性暂时还没有用到等用到的时候在进行补充,如果平常用的话这两个属性应该就够了。

简单的总结一下这两个属性,先有一个概念性的认识了解一下他们分别是干什么的。

appenders 主要是用来定义以怎样的方式输出,输出到哪里(主要功能不仅限于)

categories 是用来定义日志输出的规则然后调用之前定义好的 appenders 进行输出

写一个简单的例子方便理解一下

const log4js = require('log4js');
log4js.configure({
 appenders: {
  out: { type: 'stdout' },
  app: { type: 'file', filename: 'application.log' }
 },
 categories: {
  default: { appenders: [ 'out', 'app' ], level: 'debug' }
 }
});

var logger = log4js.getLogger();
logger.debug("Some debug messages");

运行上的代码将会创建application.log 文件在项目目录下,同时会把日志打到控制台和 application.log文件中.
上面定义了两个appender 一个是输出到 stdout 一个是输出到 file ,可以看出appender主要使用来定义输出位置的
同时在categories 中定义了一个规则,调用了appender中定义的输出,并且输出级别为 debug

appenders

appenders 的是一个map, key 代表的是appender的名字是一个字符串,value里面有一个必选的属性是type,根据type 的不同value 的格式也不一样,下面我们说几种常用的 type

file

file 日志将会输出到指定的文件中。

例子

log4js.configure({
 appenders: {
  everything: { type: 'file', filename: 'all-the-logs.log' }
 },
 categories: {
  default: { appenders: [ 'everything' ], level: 'debug' }
 }
});

const logger = log4js.getLogger();
logger.debug('I will be logged in all-the-logs.log');

常用配置属性

1. type:'file'
2. filename string 输出文件的名字
3. maxLogSize integer日志文件的最大大小(以字节为单位)。如果未指定,则不会发生日志滚动。
4. backups日志滚动期间要保留的旧日志文件数默认为5
5. layout 默认是basic layout
6. keepFileExt boolean  默认为false 滚动日志文件时保留文件扩展名(file.log变为file.1.log而不是file.log.1)
7. compress 对滚动的日志文件进行压缩

dateFile

dateFile 日志的滚动将根据配置的时间格式进行滚动而不是文件大小

例子

log4js.configure({
 appenders: {
  everything: { type: 'dateFile', filename: 'all-the-logs.log' }
 },
 categories: {
  default: { appenders: [ 'everything' ], level: 'debug' }
 }
});

常用配置属性

1. type:'dateFile'
2. filename string 输出文件的名字
3. pattern(默认为.yyyy-MM-dd) - 用于确定何时滚动日志的模式。
4. layout 默认是basic layout
5. daysToKeep integer(默认为0) - 如果此值大于零,则在日志滚动期间将删除早于该天数的文件。
6. keepFileExt (默认为false) - 在滚动日志文件时保留文件扩展名(file.log变为file.2017-05-30.log而不是file.log.2017-05-30
7. compress 对滚动的日志文件进行压缩

categories

categories 也是一个map类型的数据,key是 category 的名字是一个字符串,value 是一个对象。

value 的常用属性

  1. level 定义打印日志的级别
  2. appenders 定义打印的appender

getLogger([category]) 方法

getLogger 方法返回的是一个logger 对象,logger对象用来打印各个级别的日志。

getlogger 方法有一个可选参数category的名字,不写的情况会使用 categories 中default 定义的规则进行打印,填写之后会根据对应的 category定义的规则进行打印日志。

参考文档 api

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

NodeJs 相关文章推荐
NodeJS学习笔记之网络编程
Aug 03 NodeJs
如何正确使用Nodejs 的 c++ module 链接到 OpenSSL
Aug 03 NodeJs
Nodejs为什么选择javascript为载体语言
Jan 13 NodeJs
nodejs 实现钉钉ISV接入的加密解密方法
Jan 16 NodeJs
nodejs中使用HTTP分块响应和定时器示例代码
Mar 19 NodeJs
简单好用的nodejs 爬虫框架分享
Mar 26 NodeJs
Nodejs中使用captchapng模块生成图片验证码
May 18 NodeJs
NodeJs使用Mysql模块实现事务处理实例
May 31 NodeJs
NodeJS收发GET和POST请求的示例代码
Aug 25 NodeJs
nodejs判断文件、文件夹是否存在及删除的方法
Nov 10 NodeJs
nodejs异步编程基础之回调函数用法分析
Dec 26 NodeJs
node快速搭建后台的实现步骤
Feb 18 NodeJs
如何让Nodejs支持H5 History模式(connect-history-api-fallback源码分析)
May 30 #NodeJs
nodejs中实现修改用户路由功能
May 24 #NodeJs
nodejs实现用户登录路由功能
May 22 #NodeJs
基于nodejs的微信JS-SDK简单应用实现
May 21 #NodeJs
nodejs中实现用户注册路由功能
May 20 #NodeJs
nodejs实现日志读取、日志查找及日志刷新的方法分析
May 20 #NodeJs
NodeJS读取分析Nginx错误日志的方法
May 14 #NodeJs
You might like
ThinkPHP采用原生query实现关联查询left join实例
2014/12/02 PHP
PHP实现的最大正向匹配算法示例
2017/12/19 PHP
PHP缓存工具XCache安装与使用方法详解
2018/04/09 PHP
javascript 跨浏览器开发经验总结(五) js 事件
2010/05/19 Javascript
可以用来调试JavaScript错误的解决方案
2010/08/07 Javascript
js操纵跨frame的三级联动select下拉选项实例介绍
2013/05/19 Javascript
jquery animate实现鼠标放上去显示离开隐藏效果
2013/07/21 Javascript
js AppendChild与insertBefore用法详细对比
2013/12/16 Javascript
动态载入js提高网页打开速度的方法
2014/07/04 Javascript
js实现点击链接后延迟3秒再跳转的方法
2015/06/05 Javascript
javascript检查浏览器是否已经启用XX功能
2015/07/10 Javascript
浅谈JavaScript超时调用和间歇调用
2015/08/30 Javascript
javaScript如何跳出多重循环break、continue
2016/09/01 Javascript
原生JS实现层叠轮播图
2017/05/17 Javascript
EasyUI Datebox 日期验证之开始日期小于结束时间
2017/05/19 Javascript
angular+webpack2实战例子
2017/05/23 Javascript
webpack本地开发环境无法用IP访问的解决方法
2018/03/20 Javascript
vue2.0 移动端实现下拉刷新和上拉加载更多的示例
2018/04/23 Javascript
微信小程序自定义tab实现多层tab嵌套功能
2018/06/15 Javascript
浅析vue-router jquery和params传参(接收参数)$router $route的区别
2018/08/03 jQuery
layui 表格的属性的显示转换方法
2018/08/14 Javascript
jQuery实现轮播图及其原理详解
2020/04/12 jQuery
jquery中为什么能用$操作
2019/06/18 jQuery
[05:36]DOTA2 2015国际邀请赛中国区预选赛第四日TOP10
2015/05/29 DOTA
Python统计日志中每个IP出现次数的方法
2015/07/06 Python
Python的pycurl包用法简介
2015/11/13 Python
Python如何使用Gitlab API实现批量的合并分支
2019/11/27 Python
python pyenv多版本管理工具的使用
2019/12/23 Python
python模拟点击网页按钮实现方法
2020/02/25 Python
分享29个基于Bootstrap的HTML5响应式网页设计模板
2015/11/19 HTML / CSS
乐高奥地利官方商店:LEGO Shop AT
2019/07/16 全球购物
小学教师岗位职责
2013/11/25 职场文书
公司授权委托书
2014/04/04 职场文书
小学捐书活动总结
2014/07/05 职场文书
颂军魂爱军营演讲稿
2014/09/13 职场文书
一次线上mongo慢查询问题排查处理记录
2022/03/18 MongoDB