node-cleanlogs
v1.0.2
Published
Sistema de gerenciamento de logs para aplicações Node.js
Maintainers
Readme
Clean Logs
Sistema de gerenciamento de logs para aplicações Node.js - parte do ecossistema Clean Logs.
Instalação
npm install node-cleanlogsUso Básico
const CleanLogs = require('node-cleanlogs');
// Inicializar o cliente
const logger = new CleanLogs({
companyKey: 'SUA_CHAVE', // Chave de 6 caracteres
companyPass: 'SUA_SENHA' // Senha de 12 caracteres
});
// Enviar um log simples
async function enviarLog() {
try {
await logger.addLog({
channel: 'aplicacao', // Canal para onde o log será enviado
message: 'Aplicação iniciada com sucesso', // Mensagem do log
type: 'info', // Tipo/nível do log (opcional, padrão: 'info')
metadata: [ // Metadados (array de objetos, cada um com uma única propriedade)
{ 'Evento': 'Inicialização' },
{ 'Versão': '1.0.0' }
]
});
console.log('Log enviado com sucesso');
} catch (error) {
console.error('Erro ao enviar log:', error.message);
}
}
enviarLog();Recursos
- Envio de logs para diferentes canais
- Suporte a metadados para enriquecimento dos logs
- Níveis de log personalizáveis (info, warn, error, etc.)
- Retry automático em caso de falhas de conexão
- Validação de limites de tamanho para mensagens e metadados
API
Inicialização
const logger = new CleanLogs({
companyKey: 'SUA_CHAVE', // Obrigatório - 6 caracteres
companyPass: 'SUA_SENHA' // Obrigatório - 12 caracteres
});Métodos
addLog(options)
Envia um log para o servidor.
Parâmetros:
options(Objeto) - Configurações do logchannel(String) - Canal onde o log será registradomessage(String) - Mensagem do logtype(String, opcional) - Tipo/nível do log (padrão: 'info')metadata(Array, opcional) - Lista de objetos, onde cada objeto contém uma única propriedade (par chave-valor)
Retorno:
- Promessa que resolve com o resultado da operação ou rejeita com um erro
Formato Correto de Metadados
É importante usar o formato correto de metadados. Cada item de metadados deve ser um objeto com uma única propriedade:
metadata: [
{ 'Chave1': 'Valor1' },
{ 'Chave2': 'Valor2' },
{ 'Chave3': 'Valor3' }
]ATENÇÃO: Não use o formato abaixo, pois ele não é compatível com o Clean Logs:
// FORMATO INCORRETO
metadata: [
{ chave1: 'valor1', chave2: 'valor2' }
]Exemplos
Log com Metadados
await logger.addLog({
channel: 'usuarios',
message: 'Novo usuário registrado',
type: 'info',
metadata: [
{ 'UserID': '12345' },
{ 'Email': '[email protected]' },
{ 'Browser': 'Chrome' },
{ 'Platform': 'Windows' }
]
});Log de Erro
await logger.addLog({
channel: 'erros',
message: 'Falha na conexão com o banco de dados',
type: 'error',
metadata: [
{ 'ErrorCode': 'DB_CONNECTION_FAILED' },
{ 'AttemptCount': '3' },
{ 'DatabaseName': 'usuarios' }
]
});Helper para Criar Metadados
Se você preferir trabalhar com objetos normais e convertê-los para o formato do Clean Logs:
// Função helper para converter objetos em metadados
function createMetadata(data) {
const metadata = [];
for (const [key, value] of Object.entries(data)) {
const item = {};
item[key] = value;
metadata.push(item);
}
return metadata;
}
// Uso
const userData = {
UserID: '12345',
Email: '[email protected]',
Role: 'admin'
};
await logger.addLog({
channel: 'usuarios',
message: 'Permissões atualizadas',
type: 'info',
metadata: createMetadata(userData)
});Limites
- Tamanho máximo da mensagem: 1MB
- Número máximo de itens de metadados: 20
- Tamanho máximo de chave de metadados: 256 caracteres
- Tamanho máximo de valor de metadados: 1024 caracteres
Licença
MIT
