Node.js+Winston庫(kù)怎么構(gòu)建簡(jiǎn)單日志功能

這篇文章主要講解了“Node.js+Winston庫(kù)怎么構(gòu)建簡(jiǎn)單日志功能”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“Node.js+Winston庫(kù)怎么構(gòu)建簡(jiǎn)單日志功能”吧！

Winston  是強(qiáng)大、靈活的 Node.js 開(kāi)源日志庫(kù)之一，理論上， Winston  是一個(gè)可以記錄所有信息的記錄器。這是一個(gè)高度直觀的工具，易于定制?？梢酝ㄟ^(guò)更改幾行代碼來(lái)調(diào)整其背后的邏輯。它使對(duì)數(shù)據(jù)庫(kù)或文件等持久存儲(chǔ)位置的日志記錄變得簡(jiǎn)單容易。【推薦學(xué)習(xí)：《nodejs 教程》】

Winston 提供以下功能：

• 集中控制日志記錄的方式和時(shí)間：在一個(gè)地方更改代碼即可

• 控制日志發(fā)送的位置：將日志同步保存到多個(gè)目的地（如Elasticsearch、MongoDB、Postgres等)。

• 自定義日志格式：帶有時(shí)間戳、顏色日志級(jí)別、JSON格式等前綴。

winston實(shí)踐

實(shí)踐代碼將在項(xiàng)目 pretender-service 中增加日志功能，安裝依賴：

npm install winston --save

接下來(lái)需要初始化 logger ，由于項(xiàng)目中已經(jīng)存在一個(gè) logger.js 文件，這里再創(chuàng)建一個(gè) winstonLogger.js ，代碼如下：

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

module.exports = createLogger({
    transports: [
        new transports.File({
            filename: "logs/server.log",
            level: "info",
            format: format.combine(
                format.timestamp({ format: "MMM-DD-YYYY HH:mm:ss" }),
                format.align(),
                format.printf(
                    (info) =>
                        `${info.level}: ${[info.timestamp]}: ${info.message}`
                )
            ),
        }),
    ],
});

通過(guò)調(diào)用 winston 庫(kù)中的 createLogger 函數(shù)來(lái)初始化記錄器。在 transports 對(duì)象中，可以提供一個(gè)文件名將日志存儲(chǔ)在文件中。默認(rèn)情況下，日志記錄未格式化并打印為帶有兩個(gè)參數(shù)的 JSON 字符串，日志消息和等級(jí)。

下面對(duì)之前的 logger 進(jìn)行修改，將winston 日志記錄器加入進(jìn)去，具體修改方式參閱代碼，下面給出其使用方法：

const winlogger = require("./winstonLogger");
winlogger.info("日志內(nèi)容");

執(zhí)行程序后可以會(huì)在根目錄生成相應(yīng)的日志文件 logs/server.log

也可以更改日志級(jí)別，修改 logger ，只在 console.error 方式下使用 winston：

記錄了數(shù)據(jù)庫(kù)連接錯(cuò)誤信息，上面的信息僅只是為了演示。

多 transports

winston 允許設(shè)置多種 transport ，在 winstonLogger.js  中更改 createLogger 函數(shù)如下：

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

module.exports = createLogger({
    format: format.combine(
        format.timestamp({ format: "MMM-DD-YYYY HH:mm:ss" }),
        format.align(),
        format.printf((i) => `${i.level}: ${[i.timestamp]}: ${i.message}`)
    ),
    transports: [
        new transports.File({
            filename: "logs/info.log",
            level: "info",
            format: format.combine(
                format.printf((i) =>
                    i.level === "info"
                        ? `${i.level}: ${i.timestamp} ${i.message}`
                        : ""
                )
            ),
        }),
        new transports.File({
            filename: "logs/error.log",
            level: "error",
        }),
    ],
});

再次執(zhí)行程序，將會(huì)看到 error.log 和 info.log 文件，由于在 logger 中未設(shè)置 info ，因此 info.log 的內(nèi)容為空，error.log 內(nèi)容和上面的一樣。

多 loggers

winston 允許設(shè)置多個(gè) logger ，在實(shí)際項(xiàng)目中可以為每個(gè)模塊創(chuàng)建一個(gè)記錄器 logger , 如下代碼，創(chuàng)建一個(gè)用戶日志記錄器和登錄驗(yàn)證記錄器：

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

const customFormat = format.combine(
    format.timestamp({ format: "MMM-DD-YYYY HH:mm:ss" }),
    format.align(),
    format.printf((i) => `${i.level}: ${[i.timestamp]}: ${i.message}`)
);

const globalLogger = createLogger({
    format: customFormat,
    transports: [
        new transports.File({
            filename: "logs/info.log",
            level: "info",
            format: format.combine(
                format.printf((i) =>
                    i.level === "info"
                        ? `${i.level}: ${i.timestamp} ${i.message}`
                        : ""
                )
            ),
        }),
        new transports.File({
            filename: "logs/error.log",
            level: "error",
        }),
    ],
});

const authLogger = createLogger({
    transports: [
        new transports.File({
            filename: "logs/authLog.log",
            format: customFormat,
        }),
    ],
});

module.exports = {
    globalLogger: globalLogger,
    authLogger: authLogger,
};

修改后代碼創(chuàng)建了一個(gè)全局記錄器 globalLogger 和一個(gè)鑒權(quán)記錄器 authLogger ，對(duì)應(yīng)修改 logger.js：

const { globalLogger } = require("./winstonLogger");
globalLogger.error(message);

每日滾動(dòng)日志文件

正如前面介紹的最佳實(shí)踐中提到的，按照特定的條件對(duì)日志文件進(jìn)行分割，通常按照日期、大小進(jìn)行分割，并設(shè)置保存的日志天數(shù)。為實(shí)現(xiàn)這些需求，要有一個(gè)安裝一個(gè)  Winston  相關(guān)的依賴庫(kù)。

npm install winston-daily-rotate-file --save

安裝完成后使用以下代碼更新到 winstonLogger.js 文件：

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

const customFormat = format.combine(
    format.timestamp({ format: "MMM-DD-YYYY HH:mm:ss" }),
    format.align(),
    format.printf((i) => `${i.level}: ${[i.timestamp]}: ${i.message}`)
);
const defaultOptions = {
    format: customFormat,
    datePattern: "YYYY-MM-DD",
    zippedArchive: true,
    maxSize: "20m",
    maxFiles: "14d",
};
const globalLogger = createLogger({
    format: customFormat,
    transports: [
        new transports.DailyRotateFile({
            filename: "logs/info-%DATE%.log",
            level: "info",
            ...defaultOptions,
        }),
        new transports.DailyRotateFile({
            filename: "logs/error-%DATE%.log",
            level: "error",
            ...defaultOptions,
        }),
    ],
});

const authLogger = createLogger({
    transports: [
        new transports.DailyRotateFile({
            filename: "logs/authLog-%DATE%.log",
            ...defaultOptions,
        }),
    ],
});

module.exports = {
    globalLogger: globalLogger,
    authLogger: authLogger,
};

運(yùn)行項(xiàng)目，可以看到日志文件：

感謝各位的閱讀，以上就是“Node.js+Winston庫(kù)怎么構(gòu)建簡(jiǎn)單日志功能”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì)Node.js+Winston庫(kù)怎么構(gòu)建簡(jiǎn)單日志功能這一問(wèn)題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！