Winston 日志库使用教程

Winston 日志库使用教程

winstonA logger for just about everything.项目地址:https://gitcode.com/gh_mirrors/wi/winston

项目介绍

Winston 是一个通用的日志库，适用于 Node.js 应用程序。它支持多种传输方式，如文件、控制台等，并允许自定义日志级别和格式。Winston 的设计目标是灵活性和可扩展性，使其成为处理日志记录的强大工具。

项目快速启动

安装

首先，通过 npm 安装 Winston：

npm install winston

基本使用

以下是一个简单的 Winston 日志记录器示例：

const winston = require('winston');

const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    new winston.transports.File({ filename: 'error.log', level: 'error' }),
    new winston.transports.File({ filename: 'combined.log' }),
  ],
});

// 如果不在生产环境，将日志输出到控制台
if (process.env.NODE_ENV !== 'production') {
  logger.add(new winston.transports.Console({
    format: winston.format.simple(),
  }));
}

logger.info('Hello, Winston!');

应用案例和最佳实践

自定义日志级别和格式

Winston 允许你自定义日志级别和格式。以下是一个自定义日志级别的示例：

const myCustomLevels = {
  levels: {
    foo: 0,
    bar: 1,
    baz: 2,
    foobar: 3,
  },
  colors: {
    foo: 'blue',
    bar: 'green',
    baz: 'yellow',
    foobar: 'red',
  },
};

const customLevelLogger = winston.createLogger({
  levels: myCustomLevels.levels,
  transports: [
    new winston.transports.Console({
      format: winston.format.combine(
        winston.format.colorize(),
        winston.format.simple()
      ),
    }),
  ],
});

winston.addColors(myCustomLevels.colors);

customLevelLogger.foobar('some foobar level-ed message');

日志分割

在生产环境中，日志文件可能会变得非常大。Winston 支持使用 winston-daily-rotate-file 传输来分割日志文件：

npm install winston-daily-rotate-file

const { createLogger, transports, format } = require('winston');
require('winston-daily-rotate-file');

const transport = new transports.DailyRotateFile({
  filename: 'application-%DATE%.log',
  datePattern: 'YYYY-MM-DD-HH',
  zippedArchive: true,
  maxSize: '20m',
  maxFiles: '14d',
});

const logger = createLogger({
  level: 'info',
  format: format.combine(
    format.timestamp(),
    format.json()
  ),
  transports: [transport],
});

logger.info('This will be logged to a daily rotating file.');

典型生态项目

winston-transport

winston-transport 是 Winston 的一个核心模块，用于创建自定义传输。如果你需要将日志发送到自定义目的地，可以使用这个模块。

express-winston

express-winston 是一个 Express 中间件，用于记录请求和响应。它与 Winston 集成，可以轻松地将日志记录到文件或控制台。

npm install express-winston

const express = require('express');
const expressWinston = require('express-winston');
const winston = require('winston');

const app = express();

app.use(expressWinston.logger({
  transports: [
    new winston.transports.Console()
  ],
  format: winston.format.combine(
    winston.format.colorize(),
    winston.format.json()
  ),
  meta: true,
  msg: "HTTP {{req.method}} {{req.url}}",
  expressFormat: true,
  colorize: false

winstonA logger for just about everything.项目地址:https://gitcode.com/gh_mirrors/wi/winston