registrador

Una herramienta de Sumor Cloud.
Documentación adicional

Este es un registrador ligero para Node.JS. Puede mostrar registros en diferentes niveles, y puede personalizar el alcance, id y zona horaria.

Instalación

npm i @sumor/logger --save

Requisitos previos

Versión de Node.JS

Requiere la versión 16.x de Node.JS o superior.

Requiere módulo ES de Node.JS

Dado que este paquete está escrito en módulo ES, cambie el siguiente código en su archivo package.json:

{
  "type": "module"
}

Uso

Uso General

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

logger.trace('¡Hola Mundo!')
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 TRACE MAIN - ¡Hola Mundo!

Cambiar Alcance

Para algunos casos, necesitamos categorizar registros. El alcance se usa con este propósito.

import Logger from '@sumor/logger'
const logger = new Logger({
  scope: 'DEMO'
})
logger.trace('¡Hola Mundo!')
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 TRACE DEMO - ¡Hola Mundo!

Identificador de Usuario

Para algunos casos, necesitamos identificar al usuario. El id se usa con este propósito.

import Logger from '@sumor/logger'
const logger = new Logger({
  id: 'USER001'
})
logger.trace('¡Hola Mundo!')
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 TRACE MAIN USER001 - ¡Hola Mundo!

Cambiar Nivel

La mayoría de las veces, solo necesitamos mostrar registros de cierto nivel. Luego podemos decidir si almacenarlo y mostrarlo o no.

import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('¡Hola Mundo!') // trace es el nivel más bajo, todos los registros se mostrarán
logger.debug('¡Hola Mundo!')
logger.info('¡Hola Mundo!')
logger.warn('¡Hola Mundo!')
logger.error('¡Hola Mundo!')
logger.fatal('¡Hola Mundo!') // fatal es el nivel más alto, solo se mostrarán los errores críticos

Cambiar Zona Horaria

import Logger from '@sumor/logger'
const logger1 = new Logger({
  offset: 2 * 60 // El desfase UTC+2 es de 2 horas
})
logger1.info('¡Hola Mundo!')
// Verás la siguiente salida:
// 2020-01-01 02:00:00.000 INFO MAIN - ¡Hola Mundo!

const logger2 = new Logger({
  offset: 8 * 60 // El desfase UTC+8 es de 8 horas
})
logger2.info('¡Hola Mundo!')
// Verás la siguiente salida:
// 2020-01-01 08:00:00.000 INFO MAIN - ¡Hola Mundo!

Código Predefinido

import Logger from '@sumor/logger'
const code = {
  trace: {
    HTTP_ACCESS: 'El usuario accede a través de HTTP y la dirección IP es {ip}'
  },
  debug: {
    USER_TOKEN_LOADED:
      'Se lee la información de inicio de sesión del usuario y el ID del usuario es {id}'
  },
  info: {
    USER_LOGIN: 'El usuario inicia sesión y el ID del usuario es {id}'
  },
  warn: {
    USER_LOGOUT: 'El usuario cierra sesión y el ID del usuario es {id}'
  },
  error: {
    USER_LOGIN_FAILED: 'El inicio de sesión del usuario falló y el ID del usuario es {id}'
  },
  fatal: {
    USER_LOGIN_BLOCKED: 'El inicio de sesión del usuario está bloqueado y el ID del usuario es {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: 'Usuario inicia sesión y el ID del usuario es {id}'
  }
}
const logger1 = new Logger({
  code,
  i18n
})

logger1.code('USER_LOGIN', { id: 'USER001' })
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 INFO MAIN - El usuario inicia sesión y el ID del usuario es USER001

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

logger2.code('USER_LOGIN', { id: 'USER001' })
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 INFO MAIN - El usuario inicia sesión y el ID del usuario es USER001

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

logger3.code('USER_LOGIN', { id: 'USER001' })
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 INFO MAIN - Usuario inicia sesión y el ID del usuario es USER001

Configuración de Idioma Global

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

const code = {
  info: {
    USER_LOGIN: 'El usuario inicia sesión y el ID del usuario es {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: 'Usuario inicia sesión y el ID del usuario es {id}'
  }
}
const logger = new Logger({
  code,
  i18n
})

logger.code('USER_LOGIN', { id: 'USER001' })
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 INFO MAIN - Usuario inicia sesión y el ID del usuario es USER001

Filtrar Nivel

Cuando desee filtrar registros por nivel, puede usar el siguiente código:

import Logger from '@sumor/logger'
const logger = new Logger({
  level: 'info'
})
logger.trace('¡Hola Mundo!') // trace es el nivel más bajo, no se mostrará
logger.debug('¡Hola Mundo!') // debug es inferior a info, no se mostrará
logger.info('¡Hola Mundo!') // info es igual a info, se mostrará
logger.warn('¡Hola Mundo!') // warn es superior a info, se mostrará
logger.error('¡Hola Mundo!') // error es superior a info, se mostrará
logger.fatal('¡Hola Mundo!') // fatal es el nivel más alto, se mostrará

Cuando use esta biblioteca a través de múltiples bibliotecas, puede usar el siguiente código:

import Logger from '@sumor/logger'
const logger = new Logger()
process.env.LOG_LEVEL = 'info'

logger.trace('¡Hola Mundo!') // trace es el nivel más bajo, no se mostrará
logger.debug('¡Hola Mundo!') // debug es inferior a info, no se mostrará
logger.info('¡Hola Mundo!') // info es igual a info, se mostrará
logger.warn('¡Hola Mundo!') // warn es superior a info, se mostrará
logger.error('¡Hola Mundo!') // error es superior a info, se mostrará

process.env.LOG_LEVEL = 'warn' // cambio en tiempo real del nivel de registro
logger.info('¡Hola Mundo!') // info es inferior a warn, no se mostrará