logger

Uma Ferramenta Sumor Cloud.
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.

Instalação

npm i @sumor/logger --save

Pré-requisitos

Versão do Node.JS

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

Requer módulo ES do Node.JS

Como este pacote é escrito em módulo ES, por favor, altere o seguinte código no 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

Para alguns casos, precisamos categorizar logs. scope é usado para esse 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

Para alguns casos, precisamos identificar o usuário. id é usado para esse 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, só precisamos exibir logs de um certo nível. Então podemos decidir se armazenar e exibi-los 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 // Fuso horário UTC+2 é 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 // Fuso horário UTC+8 é de 8 horas
})
logger2.info('Olá Mundo!')
// Você verá a seguinte saída:
// 2020-01-01 08:00:00.000 INFO MAIN - Olá Mundo!

Código Pré-definido

import Logger from '@sumor/logger'
const code = {
  trace: {
    HTTP_ACCESS: 'O usuário acessou via HTTP e o endereço IP é {ip}'
  },
  debug: {
    USER_TOKEN_LOADED: 'As informações de login do usuário são lidas e o ID do usuário é {id}'
  },
  info: {
    USER_LOGIN: 'O usuário fez login e o ID do usuário é {id}'
  },
  warn: {
    USER_LOGOUT: 'O usuário fez logout e o ID do usuário é {id}'
  },
  error: {
    USER_LOGIN_FAILED: 'Falha no login do usuário e o ID do usuário é {id}'
  },
  fatal: {
    USER_LOGIN_BLOCKED: 'O login do usuário foi bloqueado e o ID do usuário é {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: 'Usuário fez login com o ID {id}'
  }
}
const logger1 = new Logger({
  code,
  i18n
})

logger1.code('USER_LOGIN', { id: 'USER001' })
// Você verá a seguinte saída:
// 2020-01-01 00:00:00.000 INFO MAIN - O usuário fez login e o ID do usuário é USER001

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

logger2.code('USER_LOGIN', { id: 'USER001' })
// Você verá a seguinte saída:
// 2020-01-01 00:00:00.000 INFO MAIN - O usuário fez login e o ID do usuário é USER001

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

logger3.code('USER_LOGIN', { id: 'USER001' })
// Você verá a seguinte saída:
// 2020-01-01 00:00:00.000 INFO MAIN - Usuário fez login com o ID USER001

Configuração de Idioma Global

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

const code = {
  info: {
    USER_LOGIN: 'O usuário fez login e o ID do usuário é {id}'
  }
}
const i18n = {
  zh: {
    USER_LOGIN: 'Usuário fez login com o ID {id}'
  }
}
const logger = new Logger({
  code,
  i18n
})

logger.code('USER_LOGIN', { id: 'USER001' })
// Você verá a seguinte saída:
// 2020-01-01 00:00:00.000 INFO MAIN - Usuário fez login com o ID USER001

Filtrar Nível

Quando você deseja filtrar logs por nível, você pode usar o seguinte código:

import Logger from '@sumor/logger'
const logger = new Logger({
  level: 'info'
})
logger.trace('Olá Mundo!') // trace é o mais baixo nível, não será exibido
logger.debug('Olá Mundo!') // debug é menor que info, não será exibido
logger.info('Olá Mundo!') // info é igual a info, será exibido
logger.warn('Olá Mundo!') // warn é maior que info, será exibido
logger.error('Olá Mundo!') // error é maior que info, será exibido
logger.fatal('Olá Mundo!') // fatal é o nível mais alto, será exibido

Quando você usa esta biblioteca com várias bibliotecas, você pode usar o seguinte código:

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

logger.trace('Olá Mundo!') // trace é o mais baixo nível, não será exibido
logger.debug('Olá Mundo!') // debug é menor que info, não será exibido
logger.info('Olá Mundo!') // info é igual a info, será exibido
logger.warn('Olá Mundo!') // warn é maior que info, será exibido
logger.error('Olá Mundo!') // error é maior que info, será exibido

process.env.LOG_LEVEL = 'warn' // alterar o nível de log em tempo real
logger.info('Olá Mundo!') // info é menor que warn, não será exibido