jaylog

Biblioteca de logging para Python com rotação de arquivos e envio HTTP para um endpoint remoto.

Instalação

pip install -U --no-cache-dir jaylog

Variáveis de ambiente

As variáveis usam o prefixo JAYLOG_. Podem ser definidas no ambiente do sistema ou em um arquivo .env / .env.logging na raiz do projeto.

Como usar?

[!IMPORTANT] A partir da versão 0.2.2, configure() deve ser chamado antes de get_logger(). Chamar get_logger() sem configuração prévia lança uma exceção.

Existem alguns cenários diferentes onde a utilização desse lib pode mudar, abaixo estão os cenários mapeados e como realizar configuração para cada um.

Arquivo único

.env.logging

JAYLOG_APP_NAME=meu-bot
JAYLOG_LOG_DIR=C:\logs

main.py

from jaylog import JaylogSettings, configure, get_logger

configure(JaylogSettings())

logger = get_logger()

logger.info("Arquivo Único")

Apenas console (sem arquivo de log)

Basta omitir JAYLOG_LOG_DIR. O handler de console fica ativo por padrão.

.env.logging

JAYLOG_APP_NAME=meu-bot

main.py

from jaylog import JaylogSettings, configure, get_logger

configure(JaylogSettings())

logger = get_logger()

logger.info("Saída apenas no console")

Múltiplos Arquivos

.env.logging

JAYLOG_APP_NAME=meu-bot
JAYLOG_LOG_DIR=C:\logs

main.py

from jaylog import JaylogSettings, get_logger, configure
from parse import parse_csv

configure(JaylogSettings())

logger = get_logger()

logger.info("Múltiplos Arquivos - main.py")
parse_csv()

parse.py

from jaylog import get_logger

logger = get_logger()

def parse_csv():
    logger.info("Múltiplos Arquivos - parse.py")

Múltiplos loggers nomeados

Quando o projeto possui serviços distintos, passe uma lista para configure(). Cada entrada usa seu próprio app_name e grava em arquivos separados. O campo [service] é exibido automaticamente no formato do log quando há mais de um logger registrado.

.env.logging

JAYLOG_LOG_DIR=C:\logs

main.py

from jaylog import JaylogSettings, configure, get_logger

settings_order   = JaylogSettings(app_name="ORDER-PROCESSOR")
settings_billing = JaylogSettings(app_name="BILLING")

configure([settings_order, settings_billing])

logger         = get_logger("ORDER-PROCESSOR")  # ou get_logger() — retorna o primeiro registrado
billing_logger = get_logger("BILLING")

logger.info("Pedido recebido")
billing_logger.info("Fatura emitida")

Alterando Caminho padrão do .env

development.env

JAYLOG_APP_NAME=meu-bot
JAYLOG_LOG_DIR=C:\logs

main.py

from jaylog import JaylogSettings, configure, get_logger

configure(JaylogSettings(_env_file='development.env'))
logger = get_logger()

logger.info("Alterando Caminho padrão do .env")

Preparando para produção

[!IMPORTANT] HTTP_ENDPOINT e HTTP_API_KEY (opcionais) 📢

• A configuração HTTP_ENDPOINT e HTTP_API_KEY não precisa ser feita em ambiente local ou de desenvolvimento
• Se apenas uma das duas variáveis HTTP_ENDPOINT ou HTTP_API_KEYS for definida, o envio HTTP é ignorado.
• Caso a aplicação execute em um ambiente que usa um proxy ntlm, defina JAYLOG_LOG_HTTP_PROXY

[!TIP] Em produção é recomendado usar um diretório específico para suas secrets, para que você possa reutilizar entre diferentes aplicações.

Cenário 1 (secrets definido hardcode no código):

prodution.env

JAYLOG_APP_NAME=meu-bot
JAYLOG_LOG_DIR=C:\logs

$ pwd
/foo/bar/secrets

$ ls -la
JAYLOG_LOG_HTTP_ENDPOIN
JAYLOG_LOG_HTTP_API_KEY
JAYLOG_LOG_HTTP_PROXY

main.py

from jaylog import JaylogSettings, configure, get_logger

configure(JaylogSettings(
    _env_file='prodution.env',
    _secrets_dir='/foo/bar/secrets/'
))
logger = get_logger()

logger.info("Mensagem de log")

Cenário 2 (secrets definido no .env):

prodution.env

JAYLOG_APP_NAME=meu-bot
JAYLOG_LOG_DIR=C:\logs
JAYLOG_SECRETS_DIR=/foo/bar/secrets

main.py

from jaylog import JaylogSettings, configure, get_logger

# nesse caso é necessário usar a função de classe `reload_secrets`
# pois o diretorio dos secrets foi passado via variável de ambiente
configure(JaylogSettings(_env_file='prodution.env').reload_secrets())
logger = get_logger()

logger.info("Mensagem de log")