[Logging with Winston and Node.js](https://www.section.io/engineering-education/logging-with-winston/)

假設您有一個在生產環境中執行的應用程式，每天有數百萬使用者賺取數千美元。應用程式可能存在錯誤的原因有多種，作為開發人員，您需要找出原因並修復它。沒有人願意使用有問題的應用程式，修復錯誤會花費時間和金錢。

你怎麼能解決這個問題？也許通過回到程式碼並檢查每一行程式碼是否按預期執行。這對於小型應用程式來說更容易，但即便如此，嘗試觸發與使用者相同型別的錯誤也可能很困難。想象一下，這在大型應用程式中會有多難。

假設有一個例項，應用程式收集一些使用者的資訊並將它們儲存到資料庫中。

如果應用程式失敗，伺服器將向終端使用者返回系統錯誤。最好能捕獲這些例項並解決這些錯誤。在這種情況下，您如何知道使用者 a 或使用者 b 遇到了單個系統錯誤？這些錯誤可能由程式碼中的錯誤、損壞的檔案、錯誤的邏輯或資料型別不匹配觸發。

如果你需要避免這種挫折，你就無法避免日誌記錄。日誌是程式設計師首先要查詢的地方，用於跟蹤錯誤和事件流，尤其是來自伺服器的事件。日誌會告訴您當應用程式執行並與使用者互動時會發生什麼。日誌記錄的一個很好的用例是，例如，如果您的系統中有一個錯誤，並且您想了解導致其發生的步驟。

日誌記錄是將應用程式活動生成的資訊記錄到日誌檔案中的過程。儲存在日誌檔案中的訊息稱為日誌。日誌是記錄在日誌檔案中的單個例項。

在 Node.js 中構建應用程式日誌至關重要。在本地執行應用程式時，可以將其掛接到偵錯程式上，非常棒，可以在執行應用程式時發現問題。在開發過程中，您通常會使用 console.log 來獲取應用程式日誌。

但是當一個應用程式投入生產並且使用者開始與之互動時，你就不能再使用 console.log 了。如果出現問題並且應用程式崩潰，則無法使用控制檯進行檢查。如果你有一個簡潔、乾淨和高質量的日誌中介軟體，比如 Winston，那會很有幫助。

Winston 處理您的應用程式活動並將有用的資訊生成到日誌檔案或資料庫中。之後，您可以檢查應用程式生成的所有活動。

本指南將在 Winston 的上下文中解釋日誌記錄。

瞭解生產應用程式是否出現問題的唯一方法是建立日誌。 記錄重新建立併為您儲存該問題。 如果出現問題或出現問題，日誌會告訴您。

瞭解系統的行為方式。 日誌記錄將生成有關係統如何與使用者互動以及進出系統的資訊。

跟蹤您的系統活動。 日誌可以顯示例項發生的時間以及觸發日誌的原因。

通常，日誌記錄的臨界值是：

* 錯誤跟蹤
* 除錯
* 應用效能

# 選擇 winston 的收益

Winston 是最好的日誌中介軟體之一，每週下載量約為 4,000,000 次。以下屬性使 Winston 成為整體通用的日誌記錄中介軟體。

* 它使用簡單且可配置。
* 日誌級別（優先順序）。 Winston 提供日誌記錄級別。它們表示日誌優先順序；這使您能夠從需要較少關注的日誌中整理出關鍵日誌。例如：{錯誤：0，警告：1，資訊：2，詳細：3，除錯：4，傻：5}。在這種情況下，錯誤日誌的優先順序高於詳細日誌。
* 記錄通道（傳輸）。一個好的記錄器有不同的方式來選擇你的日誌輸出目的地。使用 Winston，您可以以不同方式傳送和儲存日誌，例如檔案、資料庫、電子郵件和控制檯。
* 日誌格式。 Winston 為您提供了多種日誌格式。例如，在將日誌儲存到 Mongo 資料庫時，日誌格式需要為 JSON 格式。
* 日誌分析。 Winston 可幫助您分析程式碼塊並測量成功執行程式碼所需的時間。

# Winston transporters

Winston 的特性之一是它支援各種傳輸，例如檔案傳輸。 這會將生成的日誌訊息儲存到日誌檔案中。 該檔案是在您的系統中指定的。 如果應用程式建立了它的第一個日誌例項，該檔案將自動生成。 之後，任何日誌都將儲存到建立的檔案中。

為此，記錄器配置物件需要指向一個檔案（檔案傳輸器）。 只需將新 winston.transports.File 中的傳輸配置物件 .transports.Console() 替換為 .transports.File() 即可，如下所示。

```typescript
transports.File({
    filename: 'logs/example.log'
})
```

這指定生成的任何日誌都將儲存在日誌資料夾下的 example.log 檔案中。

傳輸配置將是：

```typescript
// Logger configuration
const logConfiguration = {
    'transports': [
        new winston.transports.File({
            filename: 'logs/example.log'
        })
    ]
};
```

log 檔案的內容：

![](https://img-blog.csdnimg.cn/img_convert/b46639df5197c5aed592e5ea7bb21770.png)

Winston 允許您實現多個日誌傳輸，即可以將日誌記錄到檔案、控制檯或資料庫中。

下面的 Logger 配置記錄到控制檯和檔案。 我們將向日志配置物件新增一個傳輸陣列。 在本指南的後面，我們將向您展示如何將日誌例項記錄到資料庫中。
```typescript
const logConfiguration = {
    transports: [
        new winston.transports.Console({
            level: 'warn'
        }),
        new winston.transports.File({
            level: 'error',
            // Create the log directory if it does not exist
            filename: 'logs/example.log'
        })
    ]
};

const logger = winston.createLogger(logConfiguration);

// Log some messages
logger.error("Hello, Winston logger, the first error!");
logger.warn("Hello, Winston logger, the first warning!");
logger.warn("Hello, Winston logger, the second warning!");
logger.error("Hello, Winston logger, the second error!");
logger.info("Hello, Winston logger, some info!");
logger.debug("Hello, Winston logger, a debug!");
```

這規定：

* 日誌將顯示在控制檯輸出中。
* 只有屬於錯誤級別的日誌才會記錄在 example.log 檔案中。

使用 Winston，您可以指定儲存日誌的預設格式。

例如，假設我們想以 JSON 格式登入，我們可以使用 Winston.format 指定，並且日誌例項將以 JSON 格式儲存。

```typescript
format: winston.format(
)
```

該格式採用其他日誌表單屬性，例如

* ms() - 自記錄上次日誌以來的時間（以毫秒為單位）。
* label() - 向記錄的訊息新增標籤。
* timestamp() - 收到日誌訊息的時間戳。
* splat() - 提供字串插值。

要將其應用到您的日誌中，您需要使用 format.combine，如下例所示。

```typescript
const logConfiguration = {
    transports: [
        new winston.transports.Console()
    ],
    format: winston.format.combine(
        winston.format.label({
            label: `Label?️`
        }),
        winston.format.timestamp({
           format: 'MMM-DD-YYYY HH:mm:ss'
       }),
        winston.format.printf(info => `${info.level}: ${info.label}: ${[info.timestamp]}: ${info.message}`),
    )
};

const logger = winston.createLogger(logConfiguration);

// Log a message
logger.info("Hello, Winston logger, some info!");
```

輸出：

> info: Label?️: Nov-18-2020 08:10:44: Hello, Winston logger, some info!

# Configuring Winston with a server

讓我們建立一個簡單的 Express 伺服器，我們可以使用 Winston 進行一些日誌記錄。 這將是一個小專案，可以讓您使用 Winston 記錄來自伺服器請求和響應的日誌。

繼續使用 npm install express 安裝 Express 庫。

這是我們小專案的結構：

![](https://img-blog.csdnimg.cn/img_convert/4385aacb44f5b544fcda784eca89fd4e.png)

* Logs - 將儲存由 Winston 檔案傳輸生成的日誌檔案。
* app.js - 將成為我們的伺服器應用程式。
* Utils - 將儲存 Winston logger.js，我們將在其中新增 Winston 傳輸和格式等配置。

Logger.js:

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

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

app.js:

```typescript
const express = require('express');

// Require logger.js
const logger = require('./utils/logger');
const app = express();
const port = 3000;
const host = "localhost";

// Dummy Express GET call
app.get('/',(req,res) => {
    res.send("Hello World!");
    logger.info("Server Sent A Hello World!");
})

// Introduce error by using undefined variable 'y'
app.get('/calc',(req,res) => {
    const x = y + 10;
    res.send(x.toString());
})

// Capture 500 errors
app.use((err,req,res,next) => {
res.status(500).send('Could not perform the calculation!');
   logger.error(`${err.status || 500} - ${res.statusMessage} - ${err.message} - ${req.originalUrl} - ${req.method} - ${req.ip}`);
})

// Capture 404 erors
app.use((req,res,next) => {
    res.status(404).send("PAGE NOT FOUND");
    logger.error(`400 || ${res.statusMessage} - ${req.originalUrl} - ${req.method} - ${req.ip}`);
})
// Run the server
app.listen(port, () => {
    console.log("Server started...");
    logger.info(`Server started and running on http://${host}:${port}`)
})
```

每次伺服器啟動時，Winston 都會將日誌記錄到 server.log 檔案中。

伺服器執行時，訪問以下頁面會在每次呼叫連結時建立日誌。

http://localhost:3000/ - 伺服器將傳送一條 hello world 訊息。 我們希望 Winston 捕獲它並將其記錄在我們的日誌檔案中。

http://localhost:3000/calc - 我們試圖將變數 y 新增到變數 x。 在這種情況下，未定義變數 y。 這將產生一個錯誤，我們希望 Winston 為我們捕獲這個例項。

http://localhost:3000/hello - 我們建立的伺服器沒有這樣的 URL。 我們希望 Winston 在指向我們 IP 地址的連結被訪問但無法找到時通知我們； 那是 404 錯誤。

output:

> info: Nov-12-2020 10:07:59: 	Server started and running on http://localhost:3000
info: Nov-12-2020 10:08:02: 	Server Sent A Hello World!
error: Nov-12-2020 10:08:05: 	500 - Internal Server Error - y is not defined - /calc - GET - ::1
error: Nov-12-2020 10:08:10: 	400 || Not Found - /hello - GET - ::1

關於 Node.js 應用裡使用 winston 進行日誌記錄的最佳實踐

相關文章