سجل

هذا سجل خفيف الوزن لـ Node.JS. يمكن أن يخرج السجلات في مستويات مختلفة ، ويمكنك تخصيص النطاق والمعرف والمنطقة الزمنية.

التثبيت

npm i @sumor/logger --save

المتطلبات المسبقة

إصدار Node.JS

يتطلب الإصدار 16.x أو أعلى من Node.JS

تتطلب الوحدة ES Node.JS

نظرًا لأن هذه الحزمة مكتوبة بوحدة ES ، يرجى تغيير الرمز التالي في ملف package.json الخاص بك:

{
  "type": "module"
}

الاستخدام

الاستخدام العام

import Logger from '@sumor/logger'
const logger = new Logger()

logger.trace('مرحباً بالعالم!')
// ستشاهد الناتج التالي:
// 2020-01-01 00:00:00.000 TRACE MAIN - مرحباً بالعالم!

تغيير النطاق

في بعض الحالات ، نحتاج إلى تصنيف السجلات. يُستخدم النطاق لهذا الغرض.

import Logger from '@sumor/logger'
const logger = new Logger({
  scope: 'DEMO'
})
logger.trace('مرحباً بالعالم!')
// ستشاهد الناتج التالي:
// 2020-01-01 00:00:00.000 TRACE DEMO - مرحباً بالعالم!

مُعرّف المستخدم

في بعض الحالات ، نحتاج إلى معرّف المستخدم. يُستخدم المعرف لهذا الغرض.

import Logger from '@sumor/logger'
const logger = new Logger({
  id: 'USER001'
})
logger.trace('مرحباً بالعالم!')
// ستشاهد الناتج التالي:
// 2020-01-01 00:00:00.000 TRACE MAIN USER001 - مرحباً بالعالم!

تغيير المستوى

في معظم الأحيان ، نحتاج إلى إخراج سجلات من مستوى معين. ثم يمكننا تقرير ما إذا كان نحفظها وعرضها أم لا.

import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('مرحباً بالعالم!') // التتبع هو أدنى مستوى، سيتم عرض جميع السجلات
logger.debug('مرحباً بالعالم!')
logger.info('مرحباً بالعالم!')
logger.warn('مرحباً بالعالم!')
logger.error('مرحباً بالعالم!')
logger.fatal('مرحباً بالعالم!') // الحرج هو أعلى مستوى، سيتم عرض أخطاء الجرح الحرج فقط

تغيير المنطقة الزمنية

import Logger from '@sumor/logger'
const logger1 = new Logger({
  offset: 2 * 60 // إزاحة UTC+2 هي 2 ساعات
})
logger1.info('مرحباً بالعالم!')
// ستشاهد الناتج التالي:
// 2020-01-01 02:00:00.000 INFO MAIN - مرحباً بالعالم!

const logger2 = new Logger({
  offset: 8 * 60 // إزاحة UTC+8 هي 8 ساعات
})
logger2.info('مرحباً بالعالم!')
// ستشاهد الناتج التالي:
// 2020-01-01 08:00:00.000 INFO MAIN - مرحباً بالعالم!

رمز محدد مسبقًا

import Logger from '@sumor/logger'
const code = {
  trace: {
    HTTP_ACCESS: 'المستخدم يصل عبر HTTP وعنوان الآي بي هو {ip}'
  },
  debug: {
    USER_TOKEN_LOADED: 'تمت قراءة معلومات تسجيل الدخول للمستخدم ومعرّف المستخدم هو {id}'
  },
  info: {
    USER_LOGIN: 'المستخدم يقوم بتسجيل الدخول ومعرّف المستخدم هو {id}'
  },
  warn: {
    USER_LOGOUT: 'المستخدم يقوم بتسجيل الخروج ومعرّف المستخدم هو {id}'
  },
  error: {
    USER_LOGIN_FAILED: 'فشل تسجيل الدخول للمستخدم ومعرّف المستخدم هو {id}'
  },
  fatal: {
    USER_LOGIN_BLOCKED: 'تم حظر تسجيل الدخول للمستخدم ومعرّف المستخدم هو {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: 'المستخدم يقوم بتسجيل الدخول ومعرّف المستخدم هو {id}'
  }
}
const logger1 = new Logger({
  code,
  i18n
})

logger1.code('USER_LOGIN', { id: 'USER001' })
// ستشاهد الناتج التالي:
// 2020-01-01 00:00:00.000 INFO MAIN - المستخدم يقوم بتسجيل الدخول ومعرّف المستخدم هو USER001

const logger2 = new Logger({
  code,
  i18n,
  language: 'zh-US'
})

logger2.code('USER_LOGIN', { id: 'USER001' })
// ستشاهد الناتج التالي:
// 2020-01-01 00:00:00.000 INFO MAIN - المستخدم يقوم بتسجيل الدخول ومعرّف المستخدم هو USER001

const logger3 = new Logger({
  code,
  i18n,
  language: 'zh-CN'
})

logger3.code('USER_LOGIN', { id: 'USER001' })
// ستشاهد الناتج التالي:
// 2020-01-01 00:00:00.000 INFO MAIN - المستخدم يقوم بتسجيل الدخول ومعرّف المستخدم هو USER001

إعداد اللغة العمومية

process.env.LANGUAGE = 'zh-CN'
import Logger from '@sumor/logger'

const code = {
  info: {
    USER_LOGIN: 'المستخدم يقوم بتسجيل الدخول ومعرّف المستخدم هو {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: 'المستخدم يقوم بتسجيل الدخول ومعرّف المستخدم هو {id}'
  }
}
const logger = new Logger({
  code,
  i18n
})

logger.code('USER_LOGIN', { id: 'USER001' })
// ستشاهد الناتج التالي:
// 2020-01-01 00:00:00.000 INFO MAIN - المستخدم يقوم بتسجيل الدخول ومعرّف المستخدم هو USER001

تصفية المستوى

عندما تريد تصفية السجلات حسب المستوى ، يمكنك استخدام الكود التالي:

import Logger from '@sumor/logger'
const logger = new Logger({
  level: 'info'
})
logger.trace('مرحباً بالعالم!') // التتبع هو أدنى مستوى، لن يتم عرضه
logger.debug('مرحباً بالعالم!') // التصحيح أدنى من مستوى المعلومات، لن يتم عرضه
logger.info('مرحباً بالعالم!') // المعلومات نفسها كما في المعلومات، ستكون النتيجة
logger.warn('مرحباً بالعالم!') // التحذير أعلى من المعلومات، سيتم العرض
logger.error('مرحباً بالعالم!') // الخطأ أعلى من المعلومات، ستتم العرض
logger.fatal('مرحباً بالعالم!') // الحرج هو أعلى مستوى، سيتم العرض

process.env.LOG_LEVEL = 'warn' // تغيير مستوى المخزون في الوقت الحقيقي
logger.info('مرحباً بالعالم!') // المعلومات أدنى من التنبيه، لن يتم العرض