Debian下JS日志記錄有哪些注意事項

Debian下JS日志記錄注意事項

1. 選擇合適的日志庫

根據應用場景選擇功能匹配的日志庫：

• Winston：功能全面，支持多傳輸（文件、控制臺、HTTP等）、靈活格式化（JSON、文本），適合需要高度定制化的應用；
• Pino：以高性能、低開銷著稱（比Winston快2-3倍），適合高并發、大規模生產環境；
• Morgan：專為Express.js設計，提供HTTP請求日志的靈活格式化（如 combined、common 格式）；
• Log4js：支持日志級別控制、文件輪換、syslog輸出，適合傳統企業級應用。
  示例（Winston配置）：

const winston = require('winston');
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  transports: [
    new winston.transports.File({ filename: 'error.log', level: 'error' }),
    new winston.transports.File({ filename: 'combined.log' })
  ]
});
if (process.env.NODE_ENV !== 'production') {
  logger.add(new winston.transports.Console({ format: winston.format.simple() }));
}

2. 合理設置日志級別

根據環境調整日志級別，避免不必要的性能消耗：

• 開發環境：使用debug級別，記錄詳細調試信息（如變量值、函數調用棧）；
• 測試環境：使用info或warn級別，記錄關鍵流程和潛在問題；
• 生產環境：使用error或warn級別，僅記錄錯誤和警告，減少日志體積。
  示例（環境變量控制）：

const level = process.env.NODE_ENV === 'production' ? 'warn' : 'debug';
const logger = winston.createLogger({ level, format: winston.format.json() });

3. 實現日志輪轉

防止日志文件過大占用磁盤空間，推薦使用以下工具：

• Winston插件：winston-daily-rotate-file，支持按日期輪換（如app-2025-10-16.log），并自動壓縮舊日志；
• 系統工具：logrotate，通過配置文件（如/etc/logrotate.d/my-js-app）實現按大?。ㄈ?0M）或日期輪換，支持保留指定數量（如7天）的日志。
  示例（winston-daily-rotate-file配置）：

const DailyRotateFile = require('winston-daily-rotate-file');
const logger = winston.createLogger({
  transports: [
    new DailyRotateFile({
      filename: 'application-%DATE%.log',
      datePattern: 'YYYY-MM-DD',
      zippedArchive: true,
      maxSize: '20m',
      maxFiles: '14d'
    })
  ]
});

4. 強化安全性

避免敏感信息泄露，保護日志數據的完整性和保密性：

• 敏感數據脫敏：使用sanitize-error等庫過濾日志中的密碼、密鑰、個人身份信息（PII）；
• 權限控制：將日志文件目錄權限設置為640（屬主可讀寫，組可讀），屬主為root或應用專用用戶（如appuser）；
• 傳輸加密：若將日志發送到遠程服務器（如ELK Stack），使用TLS/SSL加密傳輸通道；
• 日志審計：定期檢查日志文件，監控異常訪問（如大量ERROR日志）或未授權修改。
  示例（敏感信息過濾）：

const sanitize = require('sanitize-error');
logger.error('Database connection failed', sanitize(error));

5. 優化性能

避免日志記錄成為應用瓶頸：

• 異步日志記錄：大多數日志庫（如Winston、Pino）默認支持異步寫入，確保日志操作不阻塞主線程；
• 合理控制日志量：避免在循環或高頻函數中記錄debug日志，使用條件判斷（如if (logger.isDebugEnabled())）減少不必要的日志輸出；
• 選擇高性能庫：生產環境優先使用Pino（比Winston快2-3倍），尤其適合高并發場景。
  示例（Pino異步記錄）：

const pino = require('pino');
const logger = pino({ level: 'info' }, pino.destination('app.log')); // 異步寫入

6. 統一日志格式

采用結構化格式（如JSON）便于后續解析和分析：

• 字段要求：包含時間戳（ISO 8601格式）、日志級別（info/error等）、進程ID、模塊名、日志信息和上下文（如請求ID、用戶ID）；
• 工具支持：使用winston.format.json()（Winston）或Pino的默認JSON格式，方便與ELK Stack、Graylog等工具集成。
  示例（結構化日志）：

{
  "timestamp": "2025-10-16T12:34:56.789Z",
  "level": "error",
  "pid": 1234,
  "module": "auth",
  "message": "Failed login attempt",
  "context": { "userId": "admin", "ip": "192.168.1.1" }
}

7. 集中管理與監控

實現日志的統一收集和分析，提升問題排查效率：

• 集中式日志管理：使用ELK Stack（Elasticsearch+Logstash+Kibana）、Graylog或Fluentd，將分散的日志集中存儲、搜索和可視化；
• 實時監控與報警：通過Prometheus+Grafana監控日志指標（如錯誤率、日志量突增），設置報警規則（如ERROR日志超過10條/分鐘時發送郵件或短信通知）。
  示例（PM2日志管理）：

# 安裝pm2和pm2-logrotate
npm install pm2 -g
pm2 install pm2-logrotate

# 配置pm2-logrotate（保留7天日志，壓縮）
pm2 set pm2-logrotate:retain 7
pm2 set pm2-logrotate:compress true

8. 環境適配

根據不同環境（開發、測試、生產）調整日志配置：

• 開發環境：輸出到控制臺（Console transport），使用simple格式（易讀），開啟debug級別；
• 生產環境：輸出到文件（File transport），使用JSON格式，開啟warn或error級別，啟用日志輪轉和集中管理。
  示例（環境變量配置）：

const isProduction = process.env.NODE_ENV === 'production';
const transports = [];
if (isProduction) {
  transports.push(new winston.transports.File({ filename: 'error.log', level: 'error' }));
  transports.push(new winston.transports.File({ filename: 'combined.log' }));
} else {
  transports.push(new winston.transports.Console({ format: winston.format.simple() }));
}
const logger = winston.createLogger({ level: isProduction ? 'warn' : 'debug', transports });