logger

Una herramienta de Sumor Cloud.
Más Documentación

Este es un registro ligero para Node.JS. Puede mostrar logs en diferentes niveles, y puedes personalizar el ámbito, id y zona horaria.

CI Test Coverage Audit

Instalación

npm i @sumor/logger --save

Requisitos Previos

Versión de Node.JS

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

Requerir módulo ES de Node.JS

Dado que este paquete está escrito en módulo ES, por favor 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 Ámbito

Para algunos casos, necesitamos categorizar registros. scope se utiliza para 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!

Identificar Usuario

Para algunos casos, necesitamos identificar al usuario. id se utiliza para 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 parte del tiempo, solo necesitamos mostrar logs de un 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 logs 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 errores críticos

Cambiar Zona Horaria

import Logger from '@sumor/logger'
const logger1 = new Logger({
  offset: 2 * 60 // La zona horaria UTC+2 tiene un desplazamiento 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 // La zona horaria UTC+8 tiene un desplazamiento de 8 horas
})
logger2.info('¡Hola Mundo!')
// Verás la siguiente salida:
// 2020-01-01 08:00:00.000 INFO MAIN - ¡Hola Mundo!