在生產中避免 console.log：穩健日誌記錄的最佳實踐-js教程-PHP中文網

在生產中避免 console.log：穩健日誌記錄的最佳實踐

Patricia Arquette

發布： 2024-12-09 09:15:08

原創

615 人瀏覽過

Avoiding console.log in Production: Best Practices for Robust Logging

簡介

日誌記錄對於偵錯和監控應用程式至關重要，但不正確的日誌記錄可能會導致效能問題、安全漏洞和混亂的輸出。在本文中，我們將探討為什麼在生產中應避免使用 console.log，並使用範例提供最佳實踐。

為什麼在生產中應該避免使用 console.log？

性能開銷 ->在我的系統中，這大約花了 46 秒。

console.time("with -> console.log");
for (let i = 0; i < 1000000; i++) {
    console.log(`Iteration number: ${i}`);
}
console.timeEnd("with -> console.log");

登入後複製

此循環將訊息記錄一百萬次，導致效能下降。

->在我的系統中這大約花了 1 毫秒。

console.time("without -> console.log");
for (let i = 0; i < 1000000; i++) {
}
console.timeEnd("without -> console.log");

登入後複製

安全風險 記錄敏感資訊可能會將資料暴露給非預期方。此程式碼會記錄敏感憑證，從而帶來安全風險。

const userCredentials = { username: 'john_doe', password: 's3cr3t' };
console.log(userCredentials);

登入後複製

雜亂的原木 頻繁的日誌記錄可能會使控制台不堪重負，從而很難找到相關資訊。

function processOrder(order) {
  console.log('Processing order:', order);
  // Order processing logic here
  console.log('Order processed successfully');
}

登入後複製

生產環境中登入的最佳實務

使用適當的日誌庫 morgan、winston、pino 或 log4js 等函式庫提供帶有日誌等級的結構化日誌記錄。

const pino = require('pino');
const logger = pino();

function processOrder(order) {
  logger.info({ order }, 'Processing order');
  // Order processing logic here
  logger.info('Order processed successfully');
}

登入後複製

安全地記錄敏感資訊 避免直接記錄敏感資料。

const userCredentials = { username: 'john_doe', password: 's3cr3t' };
logger.info({ username: userCredentials.username }, 'User logged in');

登入後複製

實作條件日誌記錄

const isProduction = process.env.NODE_ENV === 'production';

function log(message) {
  if (!isProduction) {
    console.log(message);
  }
}

log('This message will only appear in development');

登入後複製

登入伺服器或外部服務

const axios = require('axios');

function logToServer(message) {
  axios.post('/api/log', { message })
    .catch(error => console.error('Failed to send log:', error));
}

logToServer('This is an important event');

登入後複製