API Pública¶
Referência rápida do que é exportado por import jaylog.
configure(settings)¶
Inicializa o jaylog. Recebe uma JaylogSettings ou uma lista de JaylogSettings (para múltiplos loggers nomeados). Deve ser chamada antes de get_logger().
get_logger(name=None)¶
Retorna o logger registrado por configure(). Sem argumento, retorna o primeiro logger registrado.
shutdown()¶
Encerra os handlers, os reporters de ambiente, o coletor de métricas de recursos (que envia uma última amostra) e o heartbeat (que envia o último beat pendente), aguardando o flush dos logs pendentes. Útil para garantir que tudo foi gravado/enviado antes do processo terminar.
heartbeat(service=None)¶
Avisa o backend de que o loop do serviço está progredindo, mesmo sem emitir logs. Chame dentro do loop; é barata e nunca levanta. Sem argumento vale para o primeiro logger registrado; com service="BILLING", para aquele app_name. Veja Heartbeat de Serviço.
JaylogSettings¶
Modelo de configuração baseado em pydantic-settings. Todos os campos podem vir de variáveis de ambiente com prefixo JAYLOG_ (veja Variáveis de Ambiente), de um arquivo .env (veja Arquivos .env), ou serem passados diretamente no construtor.
Métodos relevantes:
reload_secrets()— recarrega os campos sensíveis a partir desecrets_dir(veja Secrets em Produção).reconfigure(**overrides)— recria a configuração aplicando apenas os overrides informados (veja Reconfigurando sem Repetir Argumentos).
Campos de diagnóstico:
debug: bool = False— habilita os diagnósticos internos do jaylog;debug_handlers: str = "console"— lista separada por vírgulas com os destinosconsole,filee/ouhttp;effective_debug_handlers— propriedade somente leitura com os destinos normalizados.
Quando configure() recebe múltiplas configurações, o diagnóstico é habilitado
se ao menos uma delas tiver debug=True; os destinos informados pelas
configurações habilitadas são combinados para o processo. Consulte
Diagnóstico Técnico.
__version__ e PROTOCOL_VERSION¶
__version__: versão instalada do pacote.PROTOCOL_VERSION: versão do protocolo de comunicação com o backend de logs (enviada no headerx-jaylog-protocol).