logger

Uma Sumor Cloud Tool.
Documentação Adicional

Este é um logger leve para Node.JS. Ele pode exibir logs em diferentes níveis e você pode personalizar o escopo, id e fuso horário.

CI Test Coverage Audit

Instalação

npm i @sumor/logger --save

Pré-requisitos

Versão Node.JS

Requer Node.JS versão 16.x ou superior

Necessita de Módulo ES Node.JS

Como este pacote está escrito como um módulo ES, por favor altere o seguinte código em seu arquivo package.json:

{
  "type": "module"
}

Uso

Uso Geral

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

logger.trace('Olá Mundo!')
// Você verá a seguinte saída:
// 2020-01-01 00:00:00.000 TRACE MAIN - Olá Mundo!

Alterar Escopo

Em alguns casos precisamos categorizar logs. scope é utilizado para este propósito.

import Logger from '@sumor/logger'
const logger = new Logger({
  scope: 'DEMO'
})
logger.trace('Olá Mundo!')
// Você verá a seguinte saída:
// 2020-01-01 00:00:00.000 TRACE DEMO - Olá Mundo!

Identificar Usuário

Em alguns casos precisamos identificar o usuário. id é utilizado para este propósito.

import Logger from '@sumor/logger'
const logger = new Logger({
  id: 'USER001'
})
logger.trace('Olá Mundo!')
// Você verá a seguinte saída:
// 2020-01-01 00:00:00.000 TRACE MAIN USER001 - Olá Mundo!

Alterar Nível

Na maioria das vezes, precisamos apenas exibir logs de um determinado nível. Então podemos decidir se armazenar e exibir ou não.

import Logger from '@sumor/logger'
const logger = new Logger()
logger.trace('Olá Mundo!') // trace é o nível mais baixo, todos os logs serão exibidos
logger.debug('Olá Mundo!')
logger.info('Olá Mundo!')
logger.warn('Olá Mundo!')
logger.error('Olá Mundo!')
logger.fatal('Olá Mundo!') // fatal é o nível mais alto, apenas erros críticos serão exibidos

Alterar Fuso Horário

import Logger from '@sumor/logger'
const logger1 = new Logger({
  offset: 2 * 60 // UTC+2 offset é de 2 horas
})
logger1.info('Olá Mundo!')
// Você verá a seguinte saída:
// 2020-01-01 02:00:00.000 INFO MAIN - Olá Mundo!

const logger2 = new Logger({
  offset: 8 * 60 // UTC+8 offset é de 8 horas
})
logger2.info('Olá Mundo!')
// Você verá a seguinte saída:
// 2020-01-01 08:00:00.000 INFO MAIN - Olá Mundo!