Node.js 中的日誌記錄和監控：最佳實踐-js教程-PHP中文網

Node.js 中的日誌記錄和監控：最佳實踐

Mary-Kate Olsen

發布： 2024-11-07 00:56:02

原創

983 人瀏覽過

Logging and Monitoring in Node.js: Best Practices

有效的日誌記錄和監控對於維護應用程式運作狀況、快速識別問題和提高效能至關重要。在本文中，我們將深入探討 Node.js 應用程式的日誌記錄和監控，涵蓋選擇日誌記錄等級、設定結構化日誌、與監控工具整合以及使用 Winston 和 Elasticsearch 的最佳實踐等關鍵主題。

日誌記錄和監控簡介

日誌記錄有助於捕獲應用程式中的即時事件、錯誤和其他重要信息，而監控則涉及追蹤一段時間內的應用程式效能指標。它們共同提供了有關應用程式運行狀況的重要見解，從而能夠主動解決問題。

在 Node.js 中設定基本日誌記錄

內建的控制台物件提供了簡單的日誌記錄功能，但專用的日誌記錄庫對於生產應用程式來說更加強大。

基本控制台日誌記錄

console.log("Server started on port 3000");
console.warn("This is a warning");
console.error("Error occurred while processing request");

登入後複製

但是，控制台日誌記錄在複雜應用中存在局限性，例如缺乏日誌等級控制以及沒有日誌持久化。

溫斯頓介紹

Winston 是一個受歡迎的 Node.js 日誌庫，提供多個日誌等級、傳輸（日誌目的地）和結構化日誌記錄。

安裝溫斯頓：

   npm install winston

登入後複製

設定溫斯頓

   const winston = require("winston");

   // Configure logger
   const logger = winston.createLogger({
       level: "info",
       format: winston.format.combine(
           winston.format.timestamp(),
           winston.format.json()
       ),
       transports: [
           new winston.transports.Console(),
           new winston.transports.File({ filename: "app.log" })
       ]
   });

   // Logging examples
   logger.info("Server started on port 3000");
   logger.error("Database connection failed");

登入後複製

選擇適當的日誌級別

日誌等級根據日誌訊息的重要性進行分類。常見的日誌等級有：

錯誤：需要立即關注的嚴重問題，例如資料庫或伺服器故障。
警告：非關鍵問題，例如已棄用的 API。
訊息：一般應用程式訊息，例如伺服器啟動或關閉。
調試：開發過程中有用的詳細信息，例如變數值。

在 Winston 中配置日誌級別

logger.level = "debug"; // Sets the minimum log level to debug, capturing all messages.

登入後複製

在生產中，最好將日誌等級保持在 info 或 warn 以避免不必要的日誌資料。

結構化日誌記錄的一致性

結構化日誌記錄透過保持一致的格式可以更輕鬆地過濾和分析日誌。

將元資料新增至日誌

user_id 或 request_id 等元資料可以幫助追蹤日誌中的特定操作：

logger.info("User login successful", { user_id: "12345" });
logger.error("Failed to fetch user data", { user_id: "12345", error: "Database unavailable" });

登入後複製

與 Elasticsearch 整合以實現集中日誌記錄

Elasticsearch 廣泛用於集中式日誌管理和搜尋功能。

安裝 Elasticsearch 和 Elasticsearch Transport

console.log("Server started on port 3000");
console.warn("This is a warning");
console.error("Error occurred while processing request");

登入後複製

設定 Elasticsearch 傳輸

   npm install winston

登入後複製

此設定會將日誌傳送至 Elasticsearch，讓您可以使用 Kibana 進行即時日誌搜尋和分析。

使用 Prometheus 和 Grafana 監控應用程式指標

監控追蹤 CPU 使用率、記憶體和回應時間等應用程式效能指標，有助於確保應用程式穩定。

使用 Node.js 設定 Prometheus

安裝 Prometheus 用戶端庫

   const winston = require("winston");

   // Configure logger
   const logger = winston.createLogger({
       level: "info",
       format: winston.format.combine(
           winston.format.timestamp(),
           winston.format.json()
       ),
       transports: [
           new winston.transports.Console(),
           new winston.transports.File({ filename: "app.log" })
       ]
   });

   // Logging examples
   logger.info("Server started on port 3000");
   logger.error("Database connection failed");

登入後複製

建立與匯出指標

logger.level = "debug"; // Sets the minimum log level to debug, capturing all messages.

登入後複製

公開指標端點

logger.info("User login successful", { user_id: "12345" });
logger.error("Failed to fetch user data", { user_id: "12345", error: "Database unavailable" });

登入後複製