Node.js 日志处理模块log4js_node.js

log4js 是 Node.js 日志处理中的数一数二的模块。比起 console 或者 TJ 的 debug 有其优势，尤其针对投入生产的 Node.js 项目来说下面这些是不可少的：

  1. 日志分级
  2. 日志分类
  3. 日志落盘

本文将会给你一个 log4js 的全面介绍，让你可以在项目中驾轻就熟的使用 log4js，开发调试容易，线上更好地监控或排查问题。

牛刀小试

下面这三行代码为你展示了 log4js 最简单的用法：

// file: simplest.js
var log4js = require('log4js');
var logger = log4js.getLogger();
logger.debug("Time:", new Date());

调用 .getLogger() 可以获得 log4js 的 Logger 实例，这个实例的用法与 console 是一致的，可以调用 .debug （也有 .info 、 .error 等方法）来输出日志。

运行 node simplest.js ，输出如下：

$node simplest.js
[2016-08-21 00:01:24.852] [DEBUG] [default] - Time: 2016-08-20T16:01:24.852Z

Time: 2016-08-20T16:01:24.852Z 是我们想要输出的内容，前面的包含说明符 [2016-08-21 00:01:24.852] [DEBUG] [default] 后文再表。

使用起来是不是也很简单，好了，在我们深入到 log4js 高级用法之前，我们先来熟悉一下几个 log4js 中的概念。

Level

这个理解起来不难，就是日志的分级。日志有了分级，log4js 才能更好地为我们展示日志（不同级别的日志在控制台中采用不同的颜色，比如 error 通常是红色的），在生产可以有选择的落盘日志，比如避免一些属于 .debug 才用的敏感信息被泄露出来。

log4js 的日志分为九个等级，各个级别的名字和权重如下：

{
 ALL: new Level(Number.MIN_VALUE, "ALL"),
 TRACE: new Level(5000, "TRACE"),
 DEBUG: new Level(10000, "DEBUG"),
 INFO: new Level(20000, "INFO"),
 WARN: new Level(30000, "WARN"),
 ERROR: new Level(40000, "ERROR"),
 FATAL: new Level(50000, "FATAL"),
 MARK: new Level(9007199254740992, "MARK"), // 2^53
 OFF: new Level(Number.MAX_VALUE, "OFF")
}

上个图：

ALL OFF 这两个等级并不会直接在业务代码中使用。剩下的七个即分别对应 Logger 实例的七个方法， .trace .debug .info ... 。也就是说，你在调用这些方法的时候，就相当于为这些日志定了级。因此，之前的 [2016-08-21 00:01:24.852] [DEBUG] [default] - Time: 2016-08-20T16:01:24.852Z 中的 DEBUG 既是这条日志的级别。

类型

log4js 还有一个概念就是 category（类型），你可以设置一个 Logger 实例的类型，按照另外一个维度来区分日志：

// file: set-catetory.js
var log4js = require('log4js');
var logger = log4js.getLogger('example');
logger.debug("Time:", new Date());

在通过 getLogger 获取 Logger 实例时，唯一可以传的一个参数就是 loggerCategory（如 'example' ），通过这个参数来指定 Logger 实例属于哪个类别。这与 TJ 的 debug 是一样的：

var debug = require('debug')('worker');

setInterval(function(){
 debug('doing some work');
}, 1000);

在 debug 中 'worker' ，同样也是为日志分类。好了，回来运行 node set-catetory.js ：

[2016-08-21 01:16:00.212] [DEBUG] example - Time: 2016-08-20T17:16:00.212Z
与之前的 [2016-08-21 00:01:24.852] [DEBUG] [default] - Time: 2016-08-20T16:01:24.852Z 唯一不同的地方就在于， [default] 变成了 example 。

那类别有什么用呢，它比级别更为灵活，为日志了提供了第二个区分的维度，例如，你可以为每个文件设置不同的 category，比如在 set-catetory.js 中：

// file: set-catetory.js
var log4js = require('log4js');
var logger = log4js.getLogger('set-catetory.js');
logger.debug("Time:", new Date());

就可以从日志 [2016-08-21 01:24:07.332] [DEBUG] set-catetory.js - Time: 2016-08-20T17:24:07.331Z 看出，这条日志来自于 set-catetory.js 文件。又或者针对不同的 node package 使用不同的 category，这样可以区分日志来源于哪个模块。

Appender

好了，现在日志有了级别和类别，解决了日志在入口处定级和分类问题，而在 log4js 中，日志的出口问题（即日志输出到哪里）就由 Appender 来解决。

默认 appender

下面是 log4js 内部默认的 appender 设置：

// log4js.js
defaultConfig = {
 appenders: [{
  type: "console"
 }]
}

可以看到，在没有对 log4js 进行任何配置的时候，默认将日志都输出到了控制台。

设置自己的 appender

我们可以通过 log4js.configure 来设置我们想要的 appender。

// file: custom-appender.js
var log4js = require('log4js');
log4js.configure({
 appenders: [{
  type: 'file',
  filename: 'default.log'
 }]
})
var logger = log4js.getLogger('custom-appender');
logger.debug("Time:", new Date());

在上例中，我们将日志输出到了文件中，运行代码，log4js 在当前目录创建了一个名为 default.log 文件， [2016-08-21 08:43:21.272] [DEBUG] custom-appender - Time: 2016-08-21T00:43:21.272Z 输出到了该文件中。

log4js 提供的 appender

Console 和 File 都是 log4js 提供的 appender，除此之外还有：

DateFile：日志输出到文件，日志文件可以安特定的日期模式滚动，例如今天输出到 default-2016-08-21.log ，明天输出到 default-2016-08-22.log ；
SMTP：输出日志到邮件；
Mailgun：通过 Mailgun API 输出日志到 Mailgun；
levelFilter 可以通过 level 过滤；
等等其他一些 appender，到 这里 可以看到全部的列表。

过滤级别和类别

我们可以调整 appender 的配置，对日志的级别和类别进行过滤：

// file: level-and-category.js
var log4js = require('log4js');
log4js.configure({
 appenders: [{
  type: 'logLevelFilter',
  level: 'DEBUG',
  category: 'category1',
  appender: {
   type: 'file',
   filename: 'default.log'
  }
 }]
})
var logger1 = log4js.getLogger('category1');
var logger2 = log4js.getLogger('category2');
logger1.debug("Time:", new Date());
logger1.trace("Time:", new Date());
logger2.debug("Time:", new Date());

运行，在 default.log 中增加了一条日志：

[2016-08-21 10:08:21.630] [DEBUG] category1 - Time: 2016-08-21T02:08:21.629Z
来看一下代码：

使用 logLevelFilter 和 level 来对日志的级别进行过滤，所有权重大于或者等于 DEBUG 的日志将会输出。这也是之前提到的日志级别权重的意义；
通过 category 来选择要输出日志的类别， category2 下面的日志被过滤掉了，该配置也接受一个数组，例如 ['category1', 'category2'] ，这样配置两个类别的日志都将输出到文件中。

Layout

Layout 是 log4js 提供的高级功能，通过 layout 我们可以自定义每一条输出日志的格式。log4js 内置了四中类型的格式：

messagePassThrough：仅仅输出日志的内容；
basic：在日志的内容前面会加上时间、日志的级别和类别，通常日志的默认 layout；
colored/coloured：在 basic 的基础上给日志加上颜色，appender Console 默认使用的就是这个 layout；
pattern：这是一种特殊类型，可以通过它来定义任何你想要的格式。
一个 pattern 的例子：

// file: layout-pattern.js
var log4js = require('log4js');
log4js.configure({
 appenders: [{
  type: 'console',
  layout: {
   type: 'pattern',
   pattern: '[%r] [%[%5.5p%]] - %m%n'
  }
 }]
})
var logger = log4js.getLogger('layout-pattern');
logger.debug("Time:", new Date());

%r %p $m $n 是 log4js 内置的包含说明符，可以借此来输出一些 meta 的信息，更多细节，可以参考 log4js 的 文档 。

一张图再来说明一下，Logger、Appender 和 Layout 的定位。

实战：输出 Node 应用的 ACCESS 日志 access.log

为了方便查问题，在生产环境中往往会记录应用请求进出的日志。那使用 log4js 怎么实现呢，直接上代码：

// file: server.js
var log4js = require('log4js');
var express = require('express');

log4js.configure({
 appenders: [{
  type: 'DateFile',
  filename: 'access.log',
  pattern: '-yyyy-MM-dd.log',
  alwaysIncludePattern: true,
  category: 'access'
 }]
});

var app = express();
app.use(log4js.connectLogger(log4js.getLogger('access'), { level: log4js.levels.INFO }));
app.get('/', function(req,res) {
 res.send('前端外刊评论');
});
app.listen(5000);

看看我们做了哪些事情：

配置了一个 appender，从日志中选出类别为 access 的日志，输出到一个滚动的文件中；
log4js.getLogger('access') 获取一个类别为 access 的 Logger 实例，传递给 log4js.connectLogger 中间件，这个中间件收集访问信息，通过这个实例打出。
启动服务器，访问 http://localhost:5000，你会发现目录中多了一个名为 access.log-2016-08-21.log 的文件，里面有两条日志：

[2016-08-21 14:34:04.752] [INFO] access - ::1 - - "GET / HTTP/1.1" 200 18 "" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36"
[2016-08-21 14:34:05.002] [INFO] access - ::1 - - "GET /favicon.ico HTTP/1.1" 404 24 "http://localhost:5000/" "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/52.0.2743.116 Safari/537.36"

通过 log4js 日志的分类和appender功能，我们把访问日志输出到了一个滚动更新的文件之中。

总结

本文为大家全面地介绍了 log4js 的用法，与 console 或者简单的日志工具相比，log4js 使用起来更复杂，当然功能更强大，适合生产级应用的使用。如果大家有兴趣的话，请留言告诉外刊君，接下来可能为大家介绍如何在 Node 应用中做配置管理。

以上是小编为您精心准备的的内容，在的博客、问答、公众号、人物、课程等栏目也有的相关内容，欢迎继续使用右上角搜索按钮进行搜索nodejs
， node.js
， 模块
， log4js
， 日志模块
日志分析模块
nodejs 日志模块、nodejs 日志处理、nodejs log4js、nodejs log4js 配置、nodejs log4js 示例，以便于您获取更多的相关知识。

时间： 2024-04-24 09:22:06

Node.js 日志处理模块log4js_node.js的相关文章

深入理解Node.js的HTTP模块_node.js

前言 我们知道传统的HTPP服务器会由Aphche.Nginx.IIS之类的软件来担任,但是nodejs并不需要,nodejs提供了http模块,自身就可以用来构建服务器,而且http模块是由C++实现的,性能可靠.其中封装了一个高校的HTTP服务器和一个简单的HTTP客户端.http.Server是一个基于事件的HTTP服务器:http.request则是一个HTTP客户端工具,用于向HTTP服务器发送请求,实现内容抓取. 一. HTTP服务器 http.Server提供一套封装级别很低的AP

浅谈Node.js：Buffer模块_node.js

Javascript在客户端对于unicode编码的数据操作支持非常友好,但是对二进制数据的处理就不尽人意.Node.js为了能够处理二进制数据或非unicode编码的数据,便设计了Buffer类,该类实现了Uint8Array接口,并对其进行了优化,它的实例类似于整型数组,但是它的大小在创建后便不可调整.在介绍Buffer如何使用之前,先介绍几个知识点. 1.V8引擎的内存使用限制 V8引擎最大堆内存使用在32位系统上默认为512M,在64位系统上是1GB,虽然可以使用--max-old-sp

Node.js和MongoDB实现简单日志分析系统_node.js

在最近的项目中,为了便于分析把项目的日志都存成了JSON格式.之前日志直接存在了文件中,而MongoDB适时闯入了我的视线,于是就把log存进了MongoDB中.log只存起来是没有意义的,最关键的是要从日志中发现业务的趋势.系统的性能漏洞等.之前有一个用Java写的分析模块,运行在Tomcat下.实现相当的重量级,添加一个新指标的流程也比较繁琐,而且由于NFS的原因还导致分析失败.一直想改写,最初想用Ruby On Rails,可是一直没有时间学习和开发(在找借口啊!).在杭州QCon 201

node.js的multipart模块问题

问题描述 node.js的multipart模块问题 multipart模块已经安装好了,node.js代码中有一行var parser=new multipart.parser()为什么运行后该行代码会报错:multipart.parser is not a function 解决方案 Node.js工具模块Node.js 模块和包Node.js fs 模块 解决方案二: https://cnodejs.org/topic/4ffed8544764b729026b1da3

Node.js的Formidable模块的使用

今天总结了下Node.js的Formidable模块的使用,下面做一些简要的说明. 1)     创建Formidable.IncomingForm对象 var form = new formidable.IncomingForm() 2)     form.encoding = 'utf-8' 设置表单域的编码 3)     form.uploadDir = "/my/dir"; 设置上传文件存放的文件夹,默认为系统的临时文件夹,可以使用fs.rename()来改变上传文件的存放位置

关于在 Node.js 中引用模块，知道这些就够了

本文讲的是关于在 Node.js 中引用模块,知道这些就够了, Node 提供了两个核心模块来管理模块依赖: require 模块在全局范围内可用,不需要写 require('require'). module 模块同样在全局范围内可用,不需要写 require('module'). 你可以将 require 模块理解为命令,将 module 模块理解为所有引入模块的组织者. 在 Node 中引入一个模块其实并不是个多么复杂的概念. const config = require('/path/t

node.js的mysql模块query方法里的字符串拼接问题

问题描述 node.js的mysql模块query方法里的字符串拼接问题 我写了一个和mysql交互的Node.js.大致功能是,在浏览器端提交用户信息表单后,会在现有的表userInfo里插入一条用户记录:然后针对这条用户记录自动再生成一个表,该表的名称是根据这条记录的id动态生成的. 该部分我写的代码如下: //上面的代码已经实现把一条新的用户记录插入到userInfo里了. var userId; var tableName; db.query(//这里通过query方法获取这条新记录的i

Node.js中process模块常用的属性和方法_node.js

前言 虽然node对操作系统做了很多抽象的工作,但是你还是可以直接和他交互,比如和系统中已经存在的进程进行交互,创建工作子进程.node是一个用于事件循环的线程,但是你可以在这个事件循环之外创建其他的进程(线程)参与工作. 如果不是和命令行工具打交道,可能我们很少有机会去用到process模块中的一些方法或者属性.不过如果你要做类似于webpack或者gulp等较为复杂的构建工具,由于bash界面就是和用户直接交流的工具,因此友好的输入输出,完整的提示都非常有必要了. 属性 一张表格大概可以看到

Node.js 支持 ES6 模块的进展

本文讲的是Node.js 支持 ES6 模块的进展, 几个月前我写了篇文章阐述 Node.js 现有的 CommonJS 模块系统与 ES6 模块系统的一些区别,以及由此产生的在 Node.js 中实现 ES6 模块系统的挑战.本文将跟进相关进展. 何时知晓 如果你没有读过我之前的文章,在继续阅读之前,建议你看一下,里面描述了两种模块系统架构一些重大差异.简单来说:CommonJS 和 ES6 模块的根本差异在于模块结构解析完全并能够在其他代码里使用的时机. 例如,有如下简单的 CommonJS