winston日志框架使用

app-root-path处理相对路径

基本概念

传输是Winston引入的一个概念，它指的是用于日志的存储/输出机制。Winston带有三个核心传输元素-控制台，文件和HTTP。本教程专注于控制台和文件传输：控制台传输将信息记录传输到控制台，文件传输将信息记录传输到指定的文件。每个传输定义都可以包含自己的配置设置，例如文件大小，日志级别和日志格式。以下是我们将使用的每个传输设置的快速摘要：

level - 要记录的消息级别。
filename - 用于将日志数据写入的文件。
handleExceptions - 捕获并记录未处理的异常。
json - 以JSON格式记录日志数据。
maxsize - 在创建新文件之前，日志文件的最大大小（以字节为单位）。
maxFiles - 限制超出日志文件大小时创建的文件数。
colorize - 着色输出。这在查看控制台日志时很有用。
记录级别表示消息优先级，并由整数表示。Winston使用npm优先级从0到5（从最高到最低）的日志记录级别：

0：error
1：warn
2：info
3：verbose
4：debug
5：silly
指定特定传输的日志记录级别时，将记录该级别或更高级别的任何内容。例如，通过指定信息级别，将记录级别为错误，警告或信息的任何内容。调用记录器时指定了日志级别，这意味着我们可以执行以下操作来记录错误：logger.error('test error message').

基本示例

const { createLogger, format, transports } = require('winston');

const logger = createLogger({
  level: 'info',
  format: format.combine(
    format.timestamp({
      format: 'YYYY-MM-DD HH:mm:ss'
    }),
    format.errors({ stack: true }),
    format.splat(),
    format.json()
  ),
  defaultMeta: { service: 'your-service-name' }
});

logger.add(new transports.Console({
  format: format.combine(
    format.colorize(),
    format.simple()
  )
}));
// 以json格式logging
logger.log({
  level: 'info',
  message: 'Pass an object and this works',
  additional: 'properties',
  are: 'passed along'
});

console中打印结

按照其他格式打印：

插入变量

logger.log('info', 'test message %s', 'my string');

console中结果输出：info: test message my string {"service":"your-service-name","timestamp":"2019-03-07 23:11:21"}

logger.log('info', 'test message %d', 123);

console中结果输出：info: test message 123 {"service":"your-service-name","timestamp":"2019-03-07 23:13:25"}

logger.log('info', 'test message %s, %s', 'first', 'second', { number: 123 });

console中结果输出：info: test message first, second {"service":"your-service-name","timestamp":"2019-03-07 23:14:25","number":123}

logger.info('Found %s at %s', 'error', new Date());

console中结果输出：Found error at Thu Mar 07 2019 23:15:42 GMT+0800 (中国标准时间) {"service":"your-service-name","timestamp":"2019-03-07 23:15:42"}

logger.info('Found %s at %s', 'error', new Error('chill winston'));

console中结果输出：Found error at Error: chill winston {"service":"your-service-name","timestamp":"2019-03-07 23:16:56"}
还有这些请自己尝试：

logger.info('Found %s at %s', 'error', /WUT/);
logger.info('Found %s at %s', 'error', true);
logger.info('Found %s at %s', 'error', 100.00);
logger.info('Found %s at %s', 'error', ['1, 2, 3']);

分别打印：
info: Found error at /WUT/ {"service":"your-service-name","timestamp":"2019-03-07 23:19:22"}
info: Found error at true {"service":"your-service-name","timestamp":"2019-03-07 23:19:22"}
info: Found error at 100 {"service":"your-service-name","timestamp":"2019-03-07 23:19:22"}
info: Found error at 1, 2, 3 {"service":"your-service-name","timestamp":"2019-03-07 23:19:22"}

打印Error实例

logger.warn(new Error('Error passed as info'));

console输出Error实例

logger.log('error', new Error('Error passed as message'));

console打印Error实例.png

logger.error(new Error('Error as info'));

logger.error打印.png

winston框架在express项目中的使用

封装中间件文件

在/middlewares文件下新建logger.js文件

const { createLogger, format, transports } = require('winston');
const { combine, timestamp, printf } = format;
const customFormat = printf((info) => {
  let { message } = info;
  if (typeof message === 'object') {
    let cache = [];
    message = JSON.stringify(message, (key, value) => {
      if (typeof value === 'object' && value !== null) {
        if (cache.indexOf(value) !== -1) {
          // Duplicate reference found
          try {
            // If this value does not reference a parent it can be deduped
            return JSON.parse(JSON.stringify(value));
          } catch (error) {
            // discard key if value cannot be deduped
            return undefined;
          }
        }
        // Store value in our collection
        cache.push(value);
      }
      return value;
    });
    cache = [];
  }
  return `> ${info.timestamp} ${info.level}: ${message}`;
});

const logger = createLogger({
  format: combine(
    format.colorize(),
    timestamp({
      format: 'YYYY-MM-DD HH:mm:ss',
    }),
    customFormat,
  ),
  transports: [new transports.Console()],
});
// 导出中间件函数
module.exports = (req, res, next) => {
  logger.info(`handle request url ${req.url}`);
  next();
};

app.js文件中使用logger中间件,对request和response进行处理

const Express = require('express');
const app = new Express();
const logger = require('./middlewares/logger');
...
app.use('/user_url', logger, (req, res) => {
...
}