Quando um app falha na mão de um usuário, você não vê a tela dele. O que sobra para investigar são os logs: registros escritos pelo sistema sobre o que aconteceu. Um log bem feito encurta a busca por um erro de horas para minutos. Um log mal feito atrapalha ou, pior, expõe dados.
O que vale registrar
- Erros e exceções, com a mensagem e o local onde ocorreram.
- Ações importantes: login realizado, pedido criado, pagamento confirmado, e-mail enviado.
- Falhas ao falar com serviços externos, como o meio de pagamento ou uma API.
- Mudanças relevantes de configuração.
- Marcas de tempo, para ordenar os eventos.
Inclua um identificador que ajude a ligar eventos do mesmo pedido ou usuário, como um número de pedido ou um código de requisição. Sem ele, em um sistema com muitos acessos, as linhas se misturam.
Níveis de log
Os níveis indicam a gravidade e permitem filtrar o que mostrar:
- Debug: detalhes para desenvolvimento, normalmente desligados em produção.
- Info: eventos normais, como o início de um processo.
- Warning: algo estranho que não impediu o funcionamento.
- Error: uma falha que impediu uma operação.
Use o nível certo. Se tudo vira erro, ninguém mais olha os alertas.
Escreva mensagens úteis
Compare estas duas:
- Falhou.
- Falha ao criar pedido 4821: o serviço de pagamento não respondeu em 10 segundos.
A segunda diz o quê, onde e por quê. Prefira mensagens com contexto e, se possível, em formato estruturado, como pares de campo e valor, que facilitam busca e filtros em ferramentas de monitoramento.
O que nunca gravar
Este é o ponto de maior risco. Evite registrar:
- Senhas, mesmo erradas.
- Tokens de acesso e chaves de API. Se uma chave aparecer em logs, trate como vazada. Veja o que fazer se uma chave vazou.
- Dados completos de cartão.
- Documentos e informações pessoais sem necessidade, como CPF, endereço e conteúdo de mensagens.
Se precisar identificar um usuário, use um código interno em vez do dado pessoal. Quando for inevitável registrar algo sensível, mascare parte do valor.
Cuidados com armazenamento
- Limite o acesso aos logs apenas a quem precisa.
- Defina por quanto tempo guardar e apague o restante, para não crescer sem fim e ocupar disco.
- Faça rotação de arquivos, para que um único log não fique gigante.
- Se os logs contêm dados pessoais, entram nas regras da LGPD. Busque orientação especializada para definir prazos e bases legais.
Como começar sem complicar
Em um projeto pequeno, comece registrando erros e três ou quatro eventos de negócio. Use a biblioteca de logs da sua linguagem em vez de imprimir mensagens soltas. Depois que o app crescer, considere uma ferramenta de monitoramento que reúna os registros e avise quando algo quebrar.