Una Sumor Cloud Herramienta.
Más Documentación
Este es un registrador liviano para Node.JS. Puede generar registros en diferentes niveles, y puedes personalizar el ámbito, id y zona horaria.
npm i @sumor/logger --save
Requiere la versión de Node.JS 16.x o superior
Como este paquete está escrito en módulo ES,
por favor cambie el siguiente código en tu archivo package.json
:
{
"type": "module"
}
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 PRINCIPAL - ¡Hola Mundo!
Para algunos casos, necesitamos categorizar los registros. ámbito
se usa para este propósito.
import Logger from '@sumor/logger'
const logger = new Logger({
scope: 'EJEMPLO'
})
logger.trace('¡Hola Mundo!')
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 TRACE EJEMPLO - ¡Hola Mundo!
Para algunos casos, necesitamos identificar al usuario. id
se usa para este propósito.
import Logger from '@sumor/logger'
const logger = new Logger({
id: 'USUARIO001'
})
logger.trace('¡Hola Mundo!')
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 TRACE PRINCIPAL USUARIO001 - ¡Hola Mundo!
La mayoría de las veces, solo necesitamos generar registros 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 registros se generará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 los errores críticos se generarán
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 PRINCIPAL - ¡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 PRINCIPAL - ¡Hola Mundo!
import Logger from '@sumor/logger'
const code = {
trace: {
HTTP_ACCESS: 'El usuario accede mediante 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 su ID de usuario es {id}'
},
warn: {
USER_LOGOUT: 'El usuario cierra sesión y su ID de usuario es {id}'
},
error: {
USER_LOGIN_FAILED: 'Error en el inicio de sesión del usuario y el ID de usuario es {id}'
},
fatal: {
USER_LOGIN_BLOCKED: 'Se bloquea el inicio de sesión del usuario y el ID de usuario es {id}'
}
}
const i18n = {
zh: {
USER_LOGIN: 'El usuario inicia sesión y su ID de usuario es {id}'
}
}
const logger1 = new Logger({
code,
i18n
})
logger1.code('USER_LOGIN', { id: 'USUARIO001' })
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 INFO PRINCIPAL - El usuario inicia sesión y su ID de usuario es USUARIO001
const logger2 = new Logger({
code,
i18n,
language: 'zh-US'
})
logger2.code('USER_LOGIN', { id: 'USUARIO001' })
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 INFO PRINCIPAL - El usuario inicia sesión y su ID de usuario es USUARIO001
const logger3 = new Logger({
code,
i18n,
language: 'zh-CN'
})
logger3.code('USER_LOGIN', { id: 'USUARIO001' })
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 INFO PRINCIPAL - El usuario inicia sesión y su ID de usuario es USUARIO001
process.env.LANGUAGE = 'zh-CN'
import Logger from '@sumor/logger'
const code = {
info: {
USER_LOGIN: 'El usuario inicia sesión y su ID de usuario es {id}'
}
}
const i18n = {
zh: {
USER_LOGIN: 'El usuario inicia sesión y su ID de usuario es {id}'
}
}
const logger = new Logger({
code,
i18n
})
logger.code('USER_LOGIN', { id: 'USUARIO001' })
// Verás la siguiente salida:
// 2020-01-01 00:00:00.000 INFO PRINCIPAL - El usuario inicia sesión y su ID de usuario es USUARIO001
Cuando quieras filtrar los registros por nivel, puedes 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 generará
logger.debug('¡Hola Mundo!') // debug es menor que info, no se generará
logger.info('¡Hola Mundo!') // info es igual a info, se generará
logger.warn('¡Hola Mundo!') // warn es mayor que info, se generará
logger.error('¡Hola Mundo!') // error es mayor que info, se generará
logger.fatal('¡Hola Mundo!') // fatal es el nivel más alto, se generará
Cuando uses esta biblioteca en varias bibliotecas, puedes 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 generarán
logger.debug('¡Hola Mundo!') // debug es menor que info, no se generará
logger.info('¡Hola Mundo!') // info es igual a info, se generarán
logger.warn('¡Hola Mundo!') // warn es mayor que info, se generarán
logger.error('¡Hola Mundo!') // error es mayor que info, se generarán
process.env.LOG_LEVEL = 'warn' // cambiar el nivel de registro en tiempo real
logger.info('¡Hola Mundo!') // info es menor que warn, no se generará