logger-library

Esta biblioteca propõe aplicar a padronização de logs encapsulando a biblioteca Winston.

Instalação

npm install logger

Uso

const { Logger } = require('logger');
const packageJson = require('./package.json');

//Através da instancia de erro sabemos a origem do log
const error = new Error();

//Configurações do ambiente
const envSettings = {
  service: packageJson.name,
  version: packageJson.version,
  environment: 'dev',
  shoppingid: 'abc',
};

//Qualquer informação pertinente ao log
const data = [{ foo: 'bar' }];

Logger(error, envSettings, data).debug('Hello World!');
//output: YYYY-MM-DD HH:mm:ss:ms [debug]: Hello World!

API

Logger(Error, envSettings, data)

Cria um logger para registrar logs em diferentes níveis.

Parâmetros

• Error: Instancia Error.
• envSettings: Configurações do ambiente. É um objeto que deve conter as seguintes propriedades:
  • service: Nome do serviço que está registrando o log.
  • version: Versão do serviço que está registrando o log.
  • environment: Ambiente em que o serviço está rodando (por exemplo: dev, staging, prod).
  • shoppingid: ID do Shopping que realizou a ação que está sendo registrada no log.
  • userid: (opcional) ID do usuário que realizou a ação que está sendo registrada no log.
  • data: (opcional) Array de objetos com informações adicionais que serão registradas no log.

Retorna

Um objeto logger que tem os seguintes métodos:

• error(message): Registra uma mensagem de erro.
• warn(message): Registra uma mensagem de aviso.
• info(message): Registra uma mensagem de informação.
• http(message): Registra uma mensagem HTTP.
• debug(message): Registra uma mensagem de debug. Licença MIT