Node.js 中的 Npm Winston

2025年4月29日 | 阅读 6 分钟

Winston 是一个用于 Node.js 的大型日志库，它在服务器端和客户端都具有统一的日志记录功能。日志记录是应用程序最重要的部分之一，通过日志记录可以跟踪事件以识别错误或跟踪应用程序性能。Winston 通过非常可配置和灵活的接口简化了这一点，可以以各种格式和目的地（通常称为传输）进行记录。其多种传输、格式和日志级别使其适合企业级应用程序。

为什么使用 Winston？

日志记录可以真正帮助开发人员调试应用程序，因为他们将拥有关于执行不同阶段确切发生情况的丰富知识。Winston 的一些好处如下：

多种传输：使用 Winston，您可以将日志写入不同的目的地，例如控制台、文件、HTTP，甚至云服务，如 Amazon S3、Azure 或 Datadog。
日志级别：它允许您使用 info、warn、error 等严重性级别进行日志记录，与 Winston 一起，这使得过滤和优先排序更容易。
自定义格式：Winston 允许您使用预定义或自定义格式来格式化您的日志消息，这允许机器轻松解析和读取日志。
异步日志记录：由于 Winston 是非阻塞的，因此日志记录性能不会受到应用程序的影响。
模块化：Winston 可以通过创建自定义传输或格式来根据特定需求进行扩展或定制。

安装 Winston

要将 Winston 添加到 Node.js 应用程序，您需要先安装它。为此，您将使用 npm - Node 包管理器。您可以使用以下命令安装它：

此命令将在您的 node_modules 文件夹中添加 Winston 的引用，并更新您的 package.json 文件。

Winston 的基本日志记录

安装完成后，您就可以开始使用 Winston 进行日志记录了。整个过程首先导入 winston 模块，然后配置不同的传输。下面是一个基本示例：

 
const winston = require('winston');
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    new winston.transports.Console(),
    new winston.transports.File({ filename: 'combined.log' })
  ]
});
logger.info('This is an informational message');
logger.warn('This is a warning message');
logger.error('This is an error message');   

输出

关键特性详解

Winston 默认提供一套开箱即用的日志级别，这些级别取自 npm 日志级别。它们是：

error：用于指示错误和应立即处理的事情。
warn：它指示警告，显示出了什么问题。
info：应用程序特定的日志记录，用于跟踪应用程序。
http：与 HTTP 请求相关的日志条目。
verbose：用于非常详细的日志记录，尤其是在开发过程中。
debug：用于显示详细的调试信息。
silly：非常、非常详细的、崩溃的日志记录。

Level 选项

在创建日志记录器时指定的 level 选项控制着被捕获的日志的最低级别。例如，level 设置为 'warn' 可以确保只记录警告、错误及更严重类别中的消息。

 
const logger = winston.createLogger({
  level: 'warn',
  transports: [
    new winston.transports.Console()
  ]
});
logger.info('This will not be logged');
logger.warn('This will be logged');   

输出

日志格式

Winston 提供了几种配置日志的格式。格式决定了您在控制台或文件中的输出外观。一些常见的格式包括：

JSON 格式：以 JSON 格式记录消息。

Pretty Print：以人类可读的、缩进的格式记录消息。
Timestamp：为每个日志条目添加时间戳。

例如，您可以进行如下配置，为每个日志添加时间戳：

 
const logger = winston.createLogger({
  format: winston.format.combine(
    winston.format.timestamp(),
    winston.format.prettyPrint()
  ),
  transports: [
    new winston.transports.Console()
  ]
});

logger.info('This log will have a timestamp');   

输出

说明

在此示例中，format.combine 函数允许组合多个格式，以便您可以叠加多个转换。

传输

Winston 中的传输主要是日志数据的输出目的地。最常用的传输是：

Console：日志输出到控制台，这对于开发非常重要。
File：将日志条目写入指定的文件。
HTTP：通过 HTTP 发送日志，这是一种用于集中式日志管理系统的非常方便的机制。
云端传输：第三方供应商提供用于向云服务（如 Amazon S3、Azure 或 Google Cloud）进行日志记录的传输。

以下是如何同时记录到控制台和文件的示例：

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

输出

说明

在此示例中，错误日志保存在 error.log 文件中，所有日志都输出到控制台。

自定义传输

您还可以通过创建 Transport 类的子类并定义一些自定义行为来构建 Winston 中的自定义传输；您可以定义一个将日志发送到特定 HTTP 端点或外部服务的传输。这是一个自定义传输的简单示例：

 
const Transport = require('winston-transport');
class CustomTransport extends Transport {
  log(info, callback) {
    console.log(`Custom log: ${info.message}`);
    callback();
  }
}
const logger = winston.createLogger({
  transports: [new CustomTransport()]
});
logger.info('This will be logged via custom transport');   

输出

1. Winston 中的自定义日志级别

它允许开发人员定义用户在其自己的应用程序中需要哪些日志级别。Winston 默认使用 npm 的日志级别 error、warn、info，但可以根据您的需求进行配置。

示例

 
const logger = winston.createLogger({
  levels: {
    critical: 0,
    error: 1,
    warn: 2,
    info: 3,
    debug: 4
  },
  transports: [new winston.transports.Console()]
});
logger.critical('Critical error, needs immediate attention!');   

输出

说明

本节可以详细阐述自定义日志级别为应用程序的用例增加了灵活性，例如按不同严重性或业务需求分离日志级别。

2. Winston 中的异步和同步日志记录

同步和异步日志记录之间的行为差异很大。Winston 默认是异步的；这有助于通过等待日志记录器完成操作来保持应用程序的非阻塞。但是，如果需要，您可以通过传输自定义或添加完成回调钩来添加同步日志记录行为。

示例

 
const winston = require('winston');
const logger = winston.createLogger({
  transports: [
    new winston.transports.Console(),
    new winston.transports.File({ filename: 'async.log' })
  ]
});

logger.on('finish', () => {
  console.log('All logs have been flushed.');
});

logger.info('This is an async log message.');   

输出

3. 日志轮换和管理

通常，日志文件会随着时间的推移而不断增长，这可能导致性能瓶颈。Winston 使用 winston-daily-rotate-file 传输提供日志轮换机制，以避免这种情况。

示例

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

const logger = createLogger({
  format: format.combine(
    format.timestamp(),
    format.json()
  ),
  transports: [
    new DailyRotateFile({
      filename: 'logs/application-%DATE%.log',
      datePattern: 'YYYY-MM-DD',
      maxSize: '20m',
      maxFiles: '14d'
    })
  ]
});

logger.info('This log will rotate daily');   

说明

这在生产应用程序中尤其有用，其中需要在不消耗过多磁盘空间的情况下管理日志。

4. 查询日志

Winston 提供了一个强大的 API 来查询传输中的日志。日志条目可以以编程方式检索，按级别、时间戳等进行过滤。

如何查询日志？

它可以说明查询文件或任何其他传输中的日志的方法，无论是出于调试还是分析目的。

 
logger.query({ limit: 10, level: 'error' }, (err, result) => {
  if (err) {
    console.error(err);
  } else {
    console.log(result);
  }
});   

输出

说明

这可以向开发人员解释他们如何查询日志以分析过去的应用程序行为。

5. 日志记录到外部服务

支持第三方传输。您可以直接将日志记录到第三方服务，如 Loggly、Datadog、Amazon CloudWatch 等。可以想象开发人员如何在他们的 Node.js 应用程序中利用 Winston 进行日志记录，以及可以使用哪些类型的第三方日志服务。

Loggly 示例

 
const { Loggly } = require('winston-loggly-bulk');

const logger = winston.createLogger({
  transports: [
    new Loggly({
      token: "YOUR_LOGGLY_TOKEN",
      subdomain: "YOUR_SUBDOMAIN",
      tags: ["Winston-NodeJS"],
      json: true
    })
  ]
});

logger.info('This log will be sent to Loggly');   

输出

6. 性能和优化

日志记录可能会成为高性能应用程序的瓶颈。您可以概述 Winston 如何通过以下方式确保日志记录得到优化：

缓冲日志条目：Winston 可以缓冲日志消息，然后批量写入，而不是将每条日志消息写入磁盘，从而提高性能。
日志级别过滤：在生产环境中，可以过滤掉低级别的日志记录（如 debug 或 silly），以减少 I/O 开销。
缓冲或选择性日志记录可以提高高负载场景下日志的性能。

7. Winston 和 Express.js

大多数 Node.js 应用程序都设计为使用 Express.js。您可以将 Winston 集成到 Express 应用程序中，以捕获传入的 HTTP 请求和响应。

示例

 
const express = require('express');
const winston = require('winston');
const app = express();
const logger = winston.createLogger({
  transports: [new winston.transports.Console()]
});
app.use((req, res, next) => {
  logger.info(`${req.method} ${req.url}`);
  next();
});
app.get('/', (req, res) => {
  res.send('Hello World');
});
app.listen(3000, () => console.log('Server started on port 3000'));   

输出

下一个主题Npm-faker-in-nodejs

← 上一个下一个 →

Node.js 中的 Npm Winston

为什么使用 Winston？

安装 Winston

Winston 的基本日志记录

关键特性详解

Level 选项

日志格式

说明

传输

说明

自定义传输

1. Winston 中的自定义日志级别

说明

2. Winston 中的异步和同步日志记录

3. 日志轮换和管理

说明

4. 查询日志

如何查询日志？

说明

5. 日志记录到外部服务

6. 性能和优化

7. Winston 和 Express.js

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Node.js 教程

Node.js MySQL

Node.js MongoDB

区别

其他

Node.js 选择题

Node.js Express

面试题

Node.js 中的 Npm Winston

为什么使用 Winston？

安装 Winston

Winston 的基本日志记录

关键特性详解

Level 选项

日志格式

说明

传输

说明

自定义传输

1. Winston 中的自定义日志级别

说明

2. Winston 中的异步和同步日志记录

3. 日志轮换和管理

说明

4. 查询日志

如何查询日志？

说明

5. 日志记录到外部服务

6. 性能和优化

7. Winston 和 Express.js

相关帖子

Node.js fs.unwatchFile() 方法

Node.js 中的 Bcrypt

XAMPP 和 Node.js 的区别

Node.js 中的 vm.SourceTextModule(code[,options]) 函数

Node.js 中的 NODE_ENV 是什么？

Node.js Buffer.kMaxLength 属性

Node.js 中的 v8.writeHeapSnapshot([filename[,options]]) 函数

Node.js 中的环境变量

Node.js 中的代码分割

Node.js writeStream.clearScreendown() 方法

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器