在生产中避免 console.log：稳健日志记录的最佳实践-js教程-PHP中文网

在生产中避免 console.log：稳健日志记录的最佳实践

Patricia Arquette

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

原创

617 人浏览过

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');

登录后复制