Skip to main content

Library for generating HTML logs with support for colors, rotation and filters 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 py-html-logger

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

py_html_logger-0.1.1.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.

py_html_logger-0.1.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file py_html_logger-0.1.1.tar.gz.

File metadata

  • Download URL: py_html_logger-0.1.1.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 py_html_logger-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7b72282c54fdb1714ca41434568e508fd757061339ae9592cc8af09757ac06a8
MD5 bbaeb7c4eaad0eb5596de0b6f50a44a2
BLAKE2b-256 33cdcecc838a0fa000d34f0f516891e1e235ac0d349c4b8baf9cb67e6ef06565

See more details on using hashes here.

File details

Details for the file py_html_logger-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: py_html_logger-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for py_html_logger-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d8f6e8e35a2761b2c1bae2be31081577c602fd7af1372e57e6826a3a9a8f36e
MD5 69093f74958d56c4a76dcfda6cc0844a
BLAKE2b-256 f48c339d32e83632e3973f666c23ae3e7aece76eb544a1f3313bd6c7eb9358a6

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