elevaty-logger-lib
v1.0.1
Published
A library to format and send logs following a specific pattern for the SQS queues of elevaty applications, as defined by the system architecture.
Downloads
96
Readme
Elevaty Logger
elevaty-logger é uma biblioteca para facilitar o envio de logs para o Amazon Simple Queue Service (SQS) e registros no terminal. Com uma interface simples, você pode validar e enviar logs de forma eficiente.
Instalação
Instale a biblioteca usando npm:
npm install elevaty-logger
Como usar
Importar a Classe: Importe a classe LogSender do pacote.
Chamar o método configure: Use o método configure para configurar o LogSender com as credenciais da AWS e a URL da fila SQS.
Enviar um Log: Use o método sendLog para enviar um log para o SQS.
Exemplo com import ES6
import { logSender } from 'elevaty-logger';
logSender.configure({
region: REGION,
queueUrl: QUEUE_URL,
accessKeyId: AWS_ACCESS_KEY_ID,
secretAccessKey: AWS_SECRET_ACCESS_KEY,
application: 'your-application-name',
});
// Em qualquer parte de sua applicação você pode enviar um log
const meuLog = {
level: 'info',
application: 'minhaAplicacao',
merchant: '123',
// outros campos do log...
};
logSender.sendLog(meuLog)
Exemplo com require CommonJS
const { logSender } = require('elevaty-logger');
logSender.configure({
region: REGION,
queueUrl: QUEUE_URL,
accessKeyId: AWS_ACCESS_KEY_ID,
secretAccessKey: AWS_SECRET_ACCESS_KEY,
application: 'your-application-name',
});
// Em qualquer parte de sua applicação você pode enviar um log
const meuLog = {
level: 'info',
application: 'minhaAplicacao',
merchant: '123',
// outros campos do log...
};
logSender.sendLog(meuLog)
Se desejar ver os dados de retorno:
const result = await logSender.sendLog(meuLog)
console.log(result)
Utilizando than e catch:
logSender.sendLog(meuLog)
.then(result => console.log(result))
.catch(error => console.log(error))
Estrutura do Log
Os logs devem seguir a estrutura abaixo:
- level: (obrigatório) Nível do log (e.g., 'info', 'error').
- application: (obrigatório) Nome da aplicação.
- Outros campos opcionais.
Testes
Para rodar os testes, execute o comando abaixo:
npm run test