Começar pelo trabalho do usuário
Logs úteis explicam eventos com o mínimo prático de informação. Comece pela pergunta operacional: qual operação falhou, em que etapa, versão e resultado externo? Guardar a requisição inteira pode transformar diagnóstico em cópia descontrolada de dados do cliente.
Manter um escopo útil
Prefira eventos estruturados, horários, identificadores de requisição e códigos não sensíveis. Mantenha conteúdo pessoal no sistema autorizado. A OWASP discute exclusão de dados sensíveis e proteção dos logs. Defina retenção, acesso e remoção de campos antes de uma emergência.
Um cenário para ensaiar
Imagine uma integração recusando atualização de cliente. Registre integração, identificador da operação, tentativa e categoria de erro. O operador consulta o registro autorizado separadamente. Teste também mensagem do fornecedor com e-mail ou token: limpar seus campos não limpa o texto externo. Confira o log armazenado, não só a entrada da função.
Não transferir o problema
Não coloque segredos em URLs que proxies ou ferramentas analíticas possam registrar. Identificador com hash não é automaticamente anônimo. Debug não deve aumentar coleta silenciosamente. Separe auditoria de segurança e diagnóstico se precisarem de acessos ou prazos diferentes. O erro de contingência também não pode expor valores sensíveis.
Definir o evento antes de precisar dele
Para a atualização falha, defina nome, horário, operação, versão, tentativa e categoria limitada. Separe correlação necessária de conveniência. Campos explicitamente permitidos são melhores que serializar objeto arbitrário que pode ganhar dados depois. O evento continua útil mesmo quando a mensagem ao cliente é mais geral.
Siga o caminho completo até o armazenamento. Proxies, middleware, rastreadores, workers e bibliotecas também registram. Confira URL, cabeçalhos, exceções e respostas aninhadas. Use marcadores fictícios parecidos com e-mail, token e mensagem e procure-os em todos os destinos. Testar remoção não prova que outro componente não gravou o original antes.
Planeje acesso e exclusão. Defina quem pesquisa, exporta e muda retenção; coleta temporária deve expirar. Para consultar original, use autorização do sistema de negócio, sem ampliar logs para todos. Inclua exportações e notas copiadas no escopo de exclusão. Confira utilidade após saneamento: erro genérico demais pede contexto seguro estruturado, não restauração da carga pessoal inteira. Guarde exemplos saneados para testes futuros.
Matriz de revisão de logs
| Teste | Evidência a examinar |
|---|---|
| Erro do fornecedor contém token | Aplicação e saídas posteriores o omitem, mantendo categoria útil. |
| URL contém entrada sensível | Proxy e middleware não vazam o valor mesmo com campos próprios limpos. |
| Debug temporário expira | Coleta volta ao escopo normal sem depender de alguém lembrar da limpeza. |
| Diagnóstico autorizado pede contexto | Evento se correlaciona ao sistema de negócio sob permissões existentes, sem conteúdo pessoal em massa. |
Avaliar o resultado
Que pergunta justifica cada campo? Quem lê e exporta? Quando as cópias são apagadas? Leve erros saneados à revisão e demonstre investigação real sem entregar a mensagem completa do cliente.
Fontes e outras leituras
Recuperação e manutenção
Um próximo capítulo pensado para o software existente.
Converse sobre este serviço