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

有效的日誌記錄和監控對於維護應用程式運作狀況、快速識別問題和提高效能至關重要。在本文中，我們將深入探討 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 日誌庫，提供多個日誌等級、傳輸（日誌目的地）和結構化日誌記錄。

1. 安裝溫斯頓：

   npm install winston

1. 設定溫斯頓

   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 廣泛用於集中式日誌管理和搜尋功能。

1. 安裝 Elasticsearch 和 Elasticsearch Transport

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

1. 設定 Elasticsearch 傳輸

   npm install winston

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

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

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

使用 Node.js 設定 Prometheus

1. 安裝 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");

1. 建立與匯出指標

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

1. 公開指標端點

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

使用 Grafana 進行視覺化

Grafana 是一個強大的工具，用於根據 Prometheus 指標建立儀表板。將 Prometheus 作為 Grafana 中的資料來源集成，然後可視化回應時間和錯誤率等指標。

現實世界用例：電子商務中的日誌記錄和監控

考慮一個電子商務平台，其中日誌記錄和監控對於保持高效能和可靠性至關重要。

1. 記錄所有交易：使用結構化日誌擷取訂單和付款事件，包括 order_id 和 user_id 等元資料。
2. 錯誤追蹤：使用 Winston 記錄付款失敗等錯誤，以及堆疊追蹤和元資料以加快偵錯速度。
3. 監控伺服器運作狀況：設定 Prometheus 來監控回應時間和請求計數，在 Grafana 中進行視覺化以取得即時見解。
4. 設定警報：依照指標配置警報。例如，如果請求持續時間超過閾值，則向管理員發送警報。

此設定提供了應用程式運行狀況的全面視圖，允許主動偵測和解決問題。

結論

在 Node.js 中實現強大的日誌記錄和監控對於維護可靠性和確保快速故障排除至關重要。使用 Winston、Elasticsearch、Prometheus 和 Grafana 等工具，您可以擷取結構化日誌、集中日誌並有效監控關鍵效能指標。

以上是Node.js 中的日誌記錄和監控：最佳實踐的詳細內容。更多資訊請關注PHP中文網其他相關文章！