blear.node.log

1Introduction
2Example
3Static
4Dependencies
5Reference

1Introduction

description：Node 日志管理
author：ydr.me
create：2016年06月04日14:09:36
update：2016年06月04日14:09:36
github：https://github.com/blearjs/blear.node.log

2Example

var log = require('blear.node.log');

3Static

3.1`.expressMiddleware(options): middleware`

express 中间件，用于记录日志。

3.1.1`options`

类型：Object
说明：配置

3.1.2`options.inject`

类型：Object
说明：配置，注入属性信息
默认：有request time、request IP、request URL、request headers、request session、request query、request body

log.expressMiddleware({
    inject: {
        // 可以使用直接常量
        xxx: 'xxx',
        // 也可以使用间接函数
        yyy: function(req, res) {
            return req.yyy || 'yyy';
        }
    }
});

3.2`.holdError([err]): undefined`

劫持住 Error 对象。

fs.readFile(path, log.holdError);

3.2.1`err`

类型：Error
说明：错误对象，如果有的话

3.3`.manage(options)`

日志文件管理。

3.3.1`options`

类型：Object

说明：配置，默认值有

默认配置 = {
  // 日志的保存目录
  dirname: null,
  outLog: 'out.log',
  errLog: 'err.log',
  // 每天 0 点切割日志
  schedules: [{
      h: [0],
      m: [0]
  }],
  // 只保留 7 天之内日志
  maxLength: 7
};

4Dependencies

5Reference

无。