اجتناب از console.log در تولید: بهترین روش‌ها برای ورود به سیستم قوی

Summarize this content to 400 words in Persian Lang

مقدمه

ورود به سیستم برای اشکال زدایی و نظارت بر برنامه ها بسیار مهم است، اما ثبت نامناسب می تواند منجر به مشکلات عملکرد، آسیب پذیری های امنیتی و خروجی به هم ریخته شود. در این مقاله، بررسی خواهیم کرد که چرا باید از console.log در تولید خودداری شود و بهترین شیوه ها را با استفاده از مثال ارائه می کنیم.

چرا باید از console.log در Production اجتناب کرد؟

سربار عملکرد
-> این در سیستم من حدود 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’);
}

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

بهترین روش ها برای ورود به سیستم تولید

از یک کتابخانه ثبت نام مناسب استفاده کنید
کتابخانه‌هایی مانند مورگان، وینستون، پینو، یا 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’);

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

نتیجه گیری

استفاده از console.log در تولید می‌تواند منجر به مشکلات عملکرد، خطرات امنیتی و گزارش‌های به هم ریخته شود. با اتخاذ شیوه‌های ثبت مناسب با کتابخانه‌های اختصاصی و متدولوژی‌های ایمن، می‌توانید اطمینان حاصل کنید که برنامه شما قوی، قابل نگهداری و ایمن است.

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

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

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