Winston 和 Morgan 的高階 Node.js API 日誌記錄

日誌記錄是任何應用程式的重要組成部分，它提供對應用程式行為的洞察、幫助除錯問題和監控效能。在 Node.js API 中，可以使用 Winston 和 Morgan 等函式庫來實作進階日誌記錄。本文將指導您在 Node.js API 中設定和使用 Winston 和 Morgan 進行進階日誌記錄。

為什麼需要進階日誌記錄
基於以下幾個原因，進階日誌記錄至關重要：

• 調試和故障排除：日誌提供應用程式事件的詳細歷史記錄，這在診斷問題時非常有用。它們有助於識別錯誤的根本原因並了解導致問題的操作順序。

• 監控和維護：持續監控日誌可讓開發人員追蹤應用程式的運作狀況和效能。透過分析日誌，您可以在異常、效能瓶頸和潛在問題變得嚴重之前檢測到它們。

• 審核和合規性：對於許多應用程序，尤其是那些處理敏感資料的應用程序，維護詳細日誌是合規性要求。日誌提供使用者操作和系統變更的記錄，這對於稽核和法規遵循至關重要。

• 安全性：記錄與安全相關的事件，例如失敗的登入嘗試、未經授權的存取和可疑活動，對於偵測和回應安全威脅至關重要。進階日誌記錄有助於維護安全的應用程式環境。

目錄

1. 溫斯頓與摩根簡介
2. 設定 Node.js 專案
3. 安裝溫斯頓和摩根
4. 設定 Winston 進行進階日誌記錄
5. 整合 Morgan 以進行 HTTP 請求日誌記錄
6. 溫斯頓與摩根的結合
7. 自訂日誌格式
8. 記錄到不同的傳輸
9. 錯誤處理與日誌記錄
10. 結論

1.溫斯頓與摩根簡介
Winston 是一個多功能且易於使用的 Node.js 日誌庫。它支援日誌訊息的多種傳輸，這意味著您可以使用各種格式和等級記錄到不同位置（控制台、檔案、遠端伺服器等）。

Morgan 是 Node.js 的 HTTP 請求記錄器中間件。它簡化了以預定義格式記錄 HTTP 請求的過程，這對於追蹤 API 中的傳入請求和回應非常有用。

2.設定 Node.js 專案
首先，如果您還沒有 Node.js 項目，請建立一個：

mkdir node-api-logging
cd node-api-logging
npm init -y

3.安裝Winston和Morgan
安裝 Winston 和 Morgan 以及 Express（用於設定基本 API）：

npm install express winston morgan

4.設定 Winston 進行進階日誌記錄
建立 logger.js 檔案來設定 Winston：

// logger.js
const { createLogger, format, transports } = require('winston');
const { combine, timestamp, printf, errors } = format;

const customFormat = printf(({ level, message, timestamp, stack }) => {
  return `${timestamp} ${level}: ${stack || message}`;
});

const logger = createLogger({
  level: 'info',
  format: combine(
    timestamp(),
    errors({ stack: true }),
    customFormat
  ),
  transports: [
    new transports.Console(),
    new transports.File({ filename: 'logs/error.log', level: 'error' }),
    new transports.File({ filename: 'logs/combined.log' })
  ]
});

module.exports = logger;

5.整合 Morgan 以進行 HTTP 請求日誌記錄
建立一個 middleware/logger.js 檔案以將 Morgan 與 Winston 整合：

// middleware/logger.js
const morgan = require('morgan');
const logger = require('../logger');

const stream = {
  write: (message) => logger.info(message.trim())
};

const morganMiddleware = morgan('combined', { stream });

module.exports = morganMiddleware;

6.溫斯頓與摩根的結合
將 Winston 和 Morgan 整合到您的 Express 應用程式中：

// app.js
const express = require('express');
const logger = require('./logger');
const morganMiddleware = require('./middleware/logger');

const app = express();

// Use Morgan middleware for HTTP request logging
app.use(morganMiddleware);

// Example route
app.get('/', (req, res) => {
  logger.info('Hello world endpoint was called');
  res.send('Hello, world!');
});

// Error handling middleware
app.use((err, req, res, next) => {
  logger.error(err.message, { stack: err.stack });
  res.status(500).send('Something went wrong!');
});

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

7.自訂日誌格式
您可以自訂 Winston 和 Morgan 中的日誌記錄格式。例如，您可能想要記錄其他請求詳細信息，例如標頭、查詢參數或回應時間。

8.登入不同的傳輸
Winston 支援各種傳輸。您可以根據訊息的嚴重性記錄到不同的目標。例如，您可能希望將錯誤日誌傳送到遠端日誌伺服器或 Loggly 或 Papertrail 等第三方服務。

9.錯誤處理與日誌
正確的錯誤處理和日誌記錄對於識別和解決問題至關重要。確保您的錯誤處理中間件使用 Winston 記錄詳細的錯誤訊息。

10.結論
透過結合 Winston 和 Morgan，您可以在 Node.js API 中實作進階日誌記錄。 Winston 提供了一個用於記錄應用程式層級事件的強大框架，而 Morgan 則簡化了 HTTP 請求的記錄。它們共同為您提供全面的日誌記錄解決方案，增強您監控和調試應用程式的能力。

最終程式碼概述
以下是文件及其內容的快速回顧：

• logger.js：使用自訂格式和傳輸配置 Winston。
• middleware/logger.js：將 Morgan 與 Winston 整合。
• app.js：設定 Express 應用程序，整合 Winston 和 Morgan。 透過此設置，您可以有效地記錄和監控 Node.js API，從而更輕鬆地維護和偵錯。

以上是Winston 和 Morgan 的高階 Node.js API 日誌記錄的詳細內容。更多資訊請關注PHP中文網其他相關文章！