Skip to main content

Biblioteca para geração de logs em HTML com suporte a cores, rotação e filtros via JavaScript.

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

HTML Logger

Uma biblioteca Python para geração de logs em HTML com suporte a cores, rotação de arquivos e filtros via JavaScript.

Características

  • ✅ Logs coloridos em formato HTML
  • ✅ Rotaão automática de arquivos
  • ✅ Interface limpa com filtros JavaScript integrados
  • ✅ Thread-safe e de alta performance
  • ✅ Suporte a exceções com traceback completo
  • ✅ Configuração flexível de tamanho e quantidade de arquivos

Instalação

pip install html-logging-tool

Uso Básico

from htmllogger import log, error, report_exception

# Mensagens simples
log("Mensagem informativa normal")
log("Mensagem em azul", color="blue")

# Mensagens de erro
error("Esta é uma mensagem de erro")

# Registrar exceções
try:
    # Seu código aqui
    raise ValueError("Erro exemplo")
except Exception as e:
    report_exception(e)

Configuração

from htmllogger import config

# Personalize as configurações do logger
config(
    max_files=15,           # Número máximo de arquivos de log
    max_size=5000000,       # Tamanho máximo por arquivo (5MB)
    main_filename="log.html", # Nome do arquivo principal
    log_dir="logs"          # Diretório para os logs
)

Estrutura de Arquivos

Os logs são armazenados no diretório especificado (padrão: logs/) com a seguinte estrutura:

logs/
└── log.html (arquivo atual)
└── 2023-10-05_12-30-45_log.html (arquivo rotacionado)
└── 2023-10-05_10-15-32_log.html (arquivo rotacionado)

Filtros JavaScript Integrados

Os arquivos HTML gerados incluem recursos de filtro para facilitar a análise:

  • Filtro por texto
  • Filtro por nível (cor)
  • Filtro por período

Exemplo Completo

from htmllogger import log, error, report_exception, config

# Configurar o logger
config(
    max_files=10,
    max_size=2000000,  # 2MB
    log_dir="my_logs"
)

# Registrar diferentes tipos de mensagens
log("Iniciando aplicação", color="green")
log("Processando dados...", color="blue")

for i in range(100):
    log(f"Processando item {i}")

try:
    # Código que pode gerar erro
    resultado = 10 / 0
except Exception as e:
    error("Divisão por zero detectada")
    report_exception(e)

log("Aplicação finalizada", color="green")

API Reference

log(message, color="white")

Registra uma mensagem com a cor especificada.

error(message)

Registra uma mensagem de erro (em vermelho).

report_exception(exc, timeout=None)

Registra uma exceção com seu traceback completo.

config(**kwargs)

Configura as opções do logger:

  • max_files: Número máximo de arquivos a manter
  • max_size: Tamanho máximo em bytes por arquivo
  • main_filename: Nome do arquivo de log principal
  • log_dir: Diretório onde os logs serão armazenados

Desenvolvimento

Para contribuir com o projeto:

  1. Faça um fork do repositório
  2. Crie uma branch para sua feature (git checkout -b feature/AmazingFeature)
  3. Commit suas mudanças (git commit -m 'Add some AmazingFeature')
  4. Push para a branch (git push origin feature/AmazingFeature)
  5. Abra um Pull Request

Suporte

Se você encontrar problemas ou tiver dúvidas:

  1. Consulte a documentação
  2. Abra uma issue
  3. Entre em contato: rphspires@gmail.com

Licença

Este projeto está licenciado sob a licença MIT - veja o arquivo LICENSE para detalhes.

Agradecimentos

  • Desenvolvido por Raphael Pires
  • Inspirado pela necessidade de logs visualmente ricos para debugging
  • Contribuições são bem-vindas!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

html_logging_tool-0.1.2.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

html_logging_tool-0.1.2-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file html_logging_tool-0.1.2.tar.gz.

File metadata

  • Download URL: html_logging_tool-0.1.2.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for html_logging_tool-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2dfcea56a9f6dcf880ccc5e9e3741d5b04a2d59c5bcb566e6b822d9dc037be29
MD5 f230726006815d812ce8b413e58a5d99
BLAKE2b-256 a814441641250287a203cdbbc3de2c78a670299af863758e09a777fad14e878e

See more details on using hashes here.

File details

Details for the file html_logging_tool-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for html_logging_tool-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3de5805c5e976a2295578756e08b5e6fb7c4b9eb4a982b5b087fccfd0a2eabe8
MD5 1e0cd6b58f26c1f7d7b4d431c121ea58
BLAKE2b-256 7b836e6a796d0639deea85e10b84ec7c16c270fa34538f447f66d03ec86b0c05

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page