log4js日志的使用与详解

日志 log4js

1. 安装与引入

npm install log4js

var log4js = require(“log4js”);

2. 配置

log4js.configure({  
    appenders: {  
        fileout: { type: "file", filename: "fileout.log" }, 
        datafileout: {
            type: "dateFile", 
            filename: "datafileout.log", 
            pattern: ".yyyy-MM-dd-hh-mm-ss-SSS"
        },
        consoleout: { type: "console" }, 
    }, 
    categories: {    
        default: { appenders: ["fileout", "consoleout"], level: "debug" },   
        anything: { appenders: ["consoleout"], level: "debug" }
    }
});

3. 使用

	let logger = log4js.getLogger('anything');
 	logger.debug("debug")
    logger.info("info")
    logger.warn("info")
    logger.error("error")
    logger.fatal("fatal")

4. 配置详解

appenders

 appenders: {  
    fileout: { type: "file", filename: "fileout.log" }
 }

appenders中为键值对形式，键为名字，如代码中fileout是下面categories中要用到的名字，可自定义。
值亦为键值对形式，键为属性，必有的属性是type，根据type值的不同，可拥有其他的属性。下面介绍几个常用的type中常用的属性：

• console——输出至控制台

  属性	类型	含义
  layout?	Layout	输出的样式

• file——输出至指定文件

  属性	类型	含义
  filename	string	日志保存文件的路径及文件名，./为项目根目录
  maxLogSize?	number / string	日志文件的最大大小(以字节为单位),如果未指定，则不会发生日志滚动
  backups?	number	日志滚动期间要保留的旧日志文件数，默认值为5
  compress?	boolean	是否压缩backups
  encoding?	string	编码格式，默认为utf-8
  layout?	Layout	输出的样式

  backups是保存旧的日志的文件数，当日志大小超过我们所设定的maxLogSize的值时，会将maxLogSize值大小的日志移动到另一个文件，文件名filename.1,如：
  

  直至输出backups数量的文件，超过的即被删除。所以 所保存的日志文件的大小 = maxLogSize * backups+日志保存路径的大小 。

• dataFile——按时间输出至不同的文件

  属性	类型	含义
  filename	string	文件路径及文件名，./为项目根目录
  pattern?	string	滚动日志的时间类型，默认为 .yyyy-MM-dd
  encoding?	string	编码格式，默认为utf-8
  compress?	boolean	是否压缩滚动日志文件
  daysToKeep?	number	如果此值大于零，则日志滚动期间将删除早于该天数的文件，默认为0
  alwaysIncludePattern?	boolean	在当前日志文件名中和滚动日志一样包括pattern
  layout?	Layout	输出的样式

  pattern是保存滚动日志的时间分割，它可识别出以下字符串

  • yyyy : the full year, use yy for just the last two digits
  • MM : the month
  • dd : the day of the month
  • hh : the hour of the day (24-hour clock)
  • mm : the minute of the hour
  • ss : seconds
  • SSS : milliseconds

  例如代码为

  pattern: ".yyyy-MM-dd-hh-mm-ss"
  

  则每秒都会讲该秒的日志保存为一个文件，若该秒没有日志，则不保存。文件命名为filename加pattern定义的时间。
  

其他的所有type

• logLevelFilter
• categoryFilter
• fileSync
• multiFile
• multiprocess
• recording
• stderr
• stdout

categories

 categories: { 
     default: {appenders: ["fileout", "consoleout"], level: "debug"}, 
     anything: {appenders: ["consoleout"], level: "debug"}
 }

categories是getLogger时指定的类别，格式为键值对，键可自定义，推荐配置一个default，当getLogger不指定类别或指定的类别不存在时，默认使用default，输出时默认输出类别名。
categories的值有3个属性，分别是：

属性	类型	含义
appenders	string[]	上方所定义的appenders的名字，写入多个时全部输出
level	string	输出的日志等级，大于等于所写的等级
enableCallStack?	boolean	写样式时可使用到

5. 日志样式

在appenders中每种type都有一个属性为layout，它定义了日志输出的样式，一样表示为键值对方式。
此处介绍几种常用的内置样式。

   layout: {type: 'basic'}

• basic
  默认样式，文件输出类不指定则为此样式。
  

• colored
  console默认样式，控制台不输出则为此样式
  

• messagePassThrough
  不输出时间与类别
  

• pattern
  支持自定义样式

log4js.configure({
  appenders: {
    out: { 
        type: 'stdout',
        layout: {
          type: 'pattern',
          pattern: '%d %p %c %X{user} %m%n'
        }
    }
  },
  categories: { default: { appenders: ['out'], level: 'info' } }});
  const logger = log4js.getLogger();
  logger.addContext('user', 'charlie');
  logger.info('doing something.');

以上代码输出

2017-06-01 08:32:56.283 INFO default charlie doing something.

pattern可支持的部分字段

• %r 时间为toLocaleTimeString格式
• %p 日志级别
• %c 日志类别
• %d 日期，格式-默认是ISO8601，格式选项有：ISO8601，ISO8601_WITH_TZ_OFFSET，ABSOLUTE，DATE，或与兼容的任何字符串日期格式库。例如%d{DATE}，%d{yyyy/MM/dd-hh.mm.ss}
• %x{} 将动态令牌添加到您的日志中。令牌是在tokens参数中指定的
• %X{} 从Logger上下文中添加值。令牌是上下文值的键。

所有的可支持的字段详见 日志样式