快捷導(dǎo)航

Nodejs使用winston進行日志記錄詳解

更新時間：2024年01月15日 11:02:11 作者：東方小月

在生產(chǎn)環(huán)境中,更常見的做法是使用專門的日志記錄庫,如winston、log4js等,來實現(xiàn)更靈活和可配置的日志記錄功能,本篇文章將介紹的是winston的強大的日志記錄功能,快跟隨小編一起學(xué)習(xí)一下吧

那么在NodeJS中該如何進行日志記錄呢? 有小伙伴就會說console.log! 確實,Node.js中可以使用console.log進行簡單的日志記錄,但是它將信息輸出到控制臺就結(jié)束了,不會被持久化保存到文件或其他存儲設(shè)備中。所以通常只是在開發(fā)和調(diào)試階段使用一下。

在生產(chǎn)環(huán)境中，更常見的做法是使用專門的日志記錄庫，如winston、log4js等，來實現(xiàn)更靈活和可配置的日志記錄功能。本篇文章將介紹的是winston的強大的日志記錄功能。下面我們就從一個簡單的node項目開始吧!

初始化項目

新建目錄執(zhí)行

npm init

初始化一個 node 項目。

然后在 package.json 文件中新增type:module字段,這樣我們就可以使用 ES6 語法了

{
  "name": "winston",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "type": "module",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

新建一個index.js文件。ok，接下來我們就可以使用 winston 了

安裝使用 winston

執(zhí)行命令npm i winston -S安裝winston,安裝完成我們就可以在程序中導(dǎo)入使用了

比如在index.js中我們可以使用 winston.createLogger 創(chuàng)建一個日志記錄器

import winston from "winston";
const { format, transports } = winston;
const logger = winston.createLogger({
  level: "debug",
  format: format.simple(),
  transports: [new transports.Console()],
});

logger.info("cxkhtw");

然后我們執(zhí)行node index.js就會看到控制臺打印了

info: cxkhtw

日志記錄器接受以下參數(shù)：

名稱	默認值	描述
level	'info'	僅在 info.level 小于或等于此級別時記錄
levels	winston.config.npm.levels	表示日志優(yōu)先級的級別（和顏色）
format	winston.format.json	用于 info 消息的格式化（參見：Formats）
transports	[]	日志傳傳輸方式
exitOnError	true	如果為 false，則處理的異常不會導(dǎo)致進程退出
exceptionHandlers	[]	未捕獲異常處理方式
silent	false	如果為 true，則所有日志都將被禁止

我們簡單看下上面常用的參數(shù)

level

它表示日志記錄的最低等級，在 winston 中，日志級別遵循 RFC5424 指定的嚴重性順序：所有級別的嚴重性被規(guī)定為從最重要到最不重要的數(shù)字遞增。

const levels = {
  error: 0,
  warn: 1,
  info: 2,
  http: 3,
  verbose: 4,
  debug: 5,
  silly: 6,
};

比如上面我們指定的 level 為 debug，那么 debug 及以上都會被記錄，下面的則不會被打印，比如我們加幾種打印類型

logger.info("cxkhtw");
logger.debug("cxkhtw");
logger.warn("cxkhtw");
logger.silly("cxkhtw");

執(zhí)行程序后會發(fā)現(xiàn)只記錄了前三個

format

format可以規(guī)定日志的格式，默認是format.json也就是 JSON 格式，比如我們將format去掉再執(zhí)行程序

const logger = winston.createLogger({
  level: "debug",
  transports: [new transports.Console()],
});

你會發(fā)現(xiàn)打印出來的變成 JSON 格式了

我們還可以使用format.combine組合我們需要的格式

format: format.combine(format.timestamp(), format.simple()),

更多格式可以參見formats

transports

transports可以理解為日志的傳輸方式，比如我們想傳輸?shù)娇刂婆_，文件，數(shù)據(jù)庫，接口等等，都可以選擇對應(yīng)transports，比如上面的new transports.Console()就可以讓我們在控制臺看到打印的日志。

1. transports.File

如果我們想將日志記錄在文件中，可以使用new transports.File進行配置

const logger = winston.createLogger({
  level: "debug",
  format: format.simple(),
  transports: [
    new transports.Console(),
    new transports.File({
      dirname: "logs",
      filename: "index.log",
    }),
  ],
});

這時候再執(zhí)行程序你就會發(fā)現(xiàn)多了個 logs/index.log 文件并且記錄了打印的日志

如果將所有日志都記錄在一個文件中，那這個文件豈不是越來越大？不用擔心。winston還給我們提供了日志分割的功能,只需要配置maxsize屬性即可，單位是字節(jié)，為了更好的演示這里我們設(shè)置 1024 字節(jié)也就是 1kb

const logger = winston.createLogger({
  level: "debug",
  format: format.simple(),
  transports: [
    new transports.Console(),
    new transports.File({
      dirname: "logs",
      filename: "index.log",
      maxsize: 1024,
    }),
  ],
});

然后多執(zhí)行幾次就會發(fā)現(xiàn)日志文件新增了一個，并且第一個日志文件大小剛好 1kb 左右

一般來說我們進行日志分割都是根據(jù)時間來分割的，這樣方便后期排查問題，那么winston支持按時間分割嗎？答案是肯定的

2. transports.DailyRotateFile

如果想根據(jù)時間分割日志，我們需要換別的 Transport ，winston提供了很多transport,感興趣的可以點進去看下。我們這里使用DailyRotateFile來分割日志

我們首先要安裝npm install winston-daily-rotate-file -S,然后導(dǎo)入就可以使用了

import winston from "winston";
import "winston-daily-rotate-file";
const { format, transports } = winston;
const logger = winston.createLogger({
  level: "debug",
  format: format.simple(),
  transports: [
    new transports.Console(),
    new transports.DailyRotateFile({
      level: "debug",
      dirname: "logs",
      filename: "index-%DATE%.log",
      datePattern: "YYYY-MM-DD-HH-mm",
      maxSize: 1024,
    }),
  ],
});

logger.info("cxkhtw");
logger.debug("cxkhtw");
logger.warn("cxkhtw");
logger.info("cxkhtw");

這時候每分鐘的日志都會被記錄在不同的文件中了,當然你可以設(shè)置datePattern來規(guī)定這個時間

3. transports.Http

有的時候我們想將日志上報到指定接口中進行記錄 winston 也是支持的，可以使用內(nèi)置的 transport.Http 進行配置，為了更好的演示，我們用express寫一個簡單的接口，安裝express后新建一個 server.js

import express from "express";
import bodyParser from "body-parser";
const app = express();
const port = 3000;
app.use(bodyParser.json());
// 定義一個 POST請求的路由
app.post("/", (req, res) => {
  console.log(req.body);
  res.send("Hello, World!");
});

// 啟動服務(wù)器
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

注意這里還需要安裝body-parser讓我們的接口可以接收 JSON 文件，然后新建一個終端執(zhí)行node server.js啟動一個端口為 3000 的接口

在我們程序中的transports添加一個transports.Http,并傳入一些配置參數(shù)

import winston from "winston";
import "winston-daily-rotate-file";
const { format, transports } = winston;
const logger = winston.createLogger({
  level: "debug",
  format: format.simple(),
  transports: [
    new transports.Console(),
    new transports.Http({
      level: "info",
      host: "localhost",
      port: 3000,
      path: "/",
    }),
  ],
});

logger.info("cxkhtw");
logger.debug("cxkhtw");
logger.warn("cxkhtw");
logger.info("cxkhtw");

然后執(zhí)行一下，可以發(fā)現(xiàn)我們接口中拿到了日志信息,后面可以根據(jù)自己的需求將這些信息存儲下來

winston的transport還有很多,由于篇幅有限這里先只介紹這幾個常用的,感興趣的可以自己查看

exceptionHandlers

除了上述功能外，winston 還可以配置處理未捕獲異常,如下

import winston from "winston";
import "winston-daily-rotate-file";
const { format, transports } = winston;
const logger = winston.createLogger({
  level: "debug",
  format: format.simple(),
  transports: [new transports.Console()],
  exceptionHandlers: [
    new transports.File({
      dirname: "errorlogs",
      filename: "error.log",
    }),
  ],
});
throw Error("這是一條錯誤信息");

運行就會發(fā)現(xiàn)多了一個errorlogs/error.log文件