Nodejs Express日志管理插件express-winston-logger的使用

Nodejs Express日志管理插件express-winston-logger的使用
express-winston-logger 并不是一个官方的 npm 包，但你可以使用 winston 和 express-winston 来实现类似的功能。winston 是一个功能强大的日志库，而 express-winston 则是一个专门为 Express.js 应用程序设计的日志中间件。

下面是如何使用 winston 和 express-winston 在 Node.js 和 Express.js 中进行日志管理：

  1. 安装必要的依赖: 首先，你需要安装 winston 和 express-winston:

    npm install winston express-winston

  2. 配置日志记录器: 创建一个日志配置文件（例如 logger.js）:

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

// 日志格式化
const { combine, timestamp, printf } = format;

// 定义自定义日志格式
const myFormat = printf(info => {
  return `${info.timestamp} ${info.level}: ${info.message}`;
});

// 创建日志记录器
const logger = createLogger({
  level: 'info', // 设置日志级别
  format: combine(
    timestamp(),
    myFormat
  ),
  transports: [
    new transports.Console(), // 控制台输出
    new transports.File({ filename: 'combined.log' }) // 文件输出
  ]
});

module.exports = logger;

  3. 在 Express 应用中使用日志中间件: 在你的 Express 应用中引入并使用 express-winston:

    const express = require('express');
const app = express();
const logger = require('./logger'); // 引入日志配置

// 使用 express-winston 进行请求日志记录
app.use(expressWinston.logger({
  transports: [
    new transports.Console({
      json: true,
      colorize: true
    }),
    new transports.File({
      filename: 'logs/http.log'
    })
  ],
  meta: true, // 记录请求元数据
  msg: "HTTP {{req.method}} {{req.url}}", // 自定义日志信息
  expressFormat: true, // 使用 Express 的日志格式
  colorize: false, // 不需要颜色
  ignoreRoute: function (req, res) { return false; } // 总是记录日志
}));

// 示例路由
app.get('/', (req, res) => {
  logger.info('访问了主页');
  res.send('Hello World!');
});

// 启动应用
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

  4. 错误处理: 如果你想记录错误日志，可以添加错误处理中间件：

    app.use(expressWinston.errorLogger({
  transports: [
    new transports.Console({
      json: true,
      colorize: true
    }),
    new transports.File({
      filename: 'logs/error.log'
    })
  ]
}));

通过上述步骤，你就可以为你的 Express.js 应用程序设置一个基本的日志管理系统。这个系统将帮助你更好地监控和调试应用程序的行为。


3 回复

当然，Express应用中使用express-winston-logger来管理日志是个不错的选择。首先，你需要安装它，可以通过npm来安装：

npm install express-winston winston --save

然后，在你的Express应用中配置它：

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

const app = express();

// 设置日志格式和传输方式
app.use(expressWinston.logger({
    transports: [
        new winston.transports.Console({
            json: true,
            colorize: true
        })
    ],
    meta: true, // 记录请求元数据
    msg: "HTTP {{req.method}} {{req.url}}", // 日志模板
    expressFormat: true, // 使用默认的Express日志格式
    colorize: false, // 不要对输出进行颜色编码
}));

app.get('/', (req, res) => {
    res.send('Hello World!');
});

app.use(expressWinston.errorLogger({
    transports: [
        new winston.transports.Console({
            json: true,
            colorize: true
        })
    ]
}));

app.listen(3000);

这样，每当你发起一个请求时，都会在控制台看到详细的日志信息。希望这能帮到你！


express-winston 是一个强大的中间件，用于在Express应用中记录请求和响应信息。它基于 Winston 日志库，可以灵活地配置日志输出格式、存储方式等。

安装

首先，你需要安装 express-winston 和 winston：

npm install express-winston winston

基本使用

以下是一个简单的例子，展示如何在 Express 应用中使用 express-winston 来记录请求和响应信息：

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

const app = express();

// 设置日志格式
const logger = winston.createLogger({
    transports: [
        new winston.transports.Console({
            format: winston.format.combine(
                winston.format.timestamp(),
                winston.format.simple()
            )
        })
    ]
});

// 使用 express-winston 进行请求日志记录
app.use(expressWinston.logger({
    winstonInstance: logger,
    msg: "HTTP {{req.method}} {{req.url}}",
    expressFormat: true, // 使用默认的Express日志格式
    colorize: true
}));

// 示例路由
app.get('/', (req, res) => {
    res.send('Hello World!');
});

// 错误处理
app.use(expressWinston.errorLogger({
    winstonInstance: logger
}));

const port = process.env.PORT || 3000;
app.listen(port, () => {
    console.log(`Server is running on port ${port}`);
});

解释

  1. 创建日志实例：我们使用 winston.createLogger 创建了一个日志实例，并设置了一个控制台传输器。
  2. 中间件配置：通过 expressWinston.logger 配置了请求日志记录中间件。这里我们设置了日志消息模板 (msg)，指定了是否使用Express的日志格式 (expressFormat)，以及是否为输出添加颜色 (colorize)。
  3. 错误处理：使用 expressWinston.errorLogger 来捕获并记录任何由Express处理过程中产生的错误。

这样，每当你访问你的应用时，相应的日志信息将被打印到控制台上。这对于调试和监控应用程序的行为非常有帮助。

express-winston-logger 并不是一个广泛认可或使用的库名称。不过，你可以使用 winston 结合 express-winston 来实现日志管理。首先安装这两个库：

npm install winston express-winston

然后，在你的Express应用中配置：

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

const app = express();

// 日志中间件
app.use(expressWinston.logger({
  transports: [
    new winston.transports.Console()
  ],
  format: winston.format.combine(
    winston.format.json(),
    winston.format.prettyPrint(),
    winston.format.colorize()
  )
}));

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000);

这段代码会在每个HTTP请求时记录日志到控制台。

回到顶部