npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

node-cleanlogs

v1.0.2

Published

Sistema de gerenciamento de logs para aplicações Node.js

Readme

Clean Logs

NPM Version

Sistema de gerenciamento de logs para aplicações Node.js - parte do ecossistema Clean Logs.

Instalação

npm install node-cleanlogs

Uso 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 log
    • channel (String) - Canal onde o log será registrado
    • message (String) - Mensagem do log
    • type (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