Guias práticos

Registre erros sem expor dados confidenciais

Os logs devem ajudar a explicar e resolver uma situação. Gravar cada detalhe da solicitação cria volume e pode copiar informações que não devem deixar seu fluxo de trabalho original.

Veja o método

Logs úteis e limitados

Comece com as perguntas que os logs devem responder

Liste as perguntas operacionais: um formulário está falhando, um processo é interrompido, um backup foi testado? Defina o evento, o componente, o tempo e um identificador de correlação apropriado. Evite mensagens que coletem texto sem ajudar a identificar uma ação.

Prepare exemplos sintéticos de sucesso, recusa e fracasso. Uma recusa esperada deve ser distinguível de uma interrupção. Os nomes e níveis de eventos devem ajudar o proprietário a decidir se quer investigar ou monitorar uma tendência.

Minimize as informações registradas

OWASP discute dados que devem ser excluídos dos logs, incluindo senhas, tokens de acesso e informações confidenciais. Revise as mensagens produzidas pelo seu código, bem como plugins, proxies e serviços de monitoramento.

Use uma lista de permissões de campos em vez de copiar uma solicitação inteira. Um identificador de diagnóstico pode ser suficiente onde uma mensagem de consulta completa seria excessiva. Teste com marcadores sintéticos e, em seguida, as saídas de busca por esses marcadores para detectar a coleção não intencional.

Gerenciar acesso, retenção e volume

Documente quem pode ler logs e por quê. Confirme se eles não são veiculados em um endereço público ou que são disponibilizados por meio de ferramentas de compartilhamento. Uma exportação de diagnóstico precisa da mesma revisão de acesso que o armazenamento primário.

Escolha a retenção de acordo com a necessidade real e o contexto aplicável, em vez de copiar a duração de outro serviço. Organize a rotação, os limites de volume e a exclusão. Uma falha repetida não deve preencher um disco por meio de log ilimitado.

Teste o caminho do sinal para a ação

Acionar uma falha controlada em um ambiente de teste. Verifique o log, a entrega de alertas, o destinatário e o procedimento de resposta. Um alerta enviado a uma caixa de entrada que ninguém verifica não forma um processo operacional.

Agrupe as repetições e siga os sinais que apoiam as decisões. Após um incidente, revise o que estava faltando e o que estava desnecessariamente exposto. Uma entrega útil conecta um evento com dados mínimos, um proprietário e uma ação.

Documentação principal: OWASP — Folha de dicas de log.

Documentos de referência

Conteúdo atualizado em 1º de outubro de 2026

Matriz de validação funcional para se adaptar ao projeto

Esses controles propostos usam casos fictícios. Decida qual comportamento é esperado com a equipe, anote o resultado e atribua discrepâncias não resolvidas antes da publicação.

Casos de teste, resultados esperados e evidências úteis
CasoResultado esperadoProva para guardar
Erro funcional conhecidoO evento explica o resultado e identifica a solicitação sintética.Evento, tempo e identificador de correlação nas etapas de processamento relevantes.
Marcador sensível sintéticoO marcador está ausente dos campos que devem excluí-lo.Pesquisa em todos os destinos de log de teste, incluindo cópias encaminhadas e arquivadas.
Texto contendo uma nova linhaO campo não pode fabricar um evento extra aparentemente válido.Valor recebido e o formulário realmente registrado no destino.
Logs indisponíveisO comportamento do aplicativo é entendido e a perda de observabilidade pode ser detectada.O resultado do aplicativo e as observações feitas durante a coleta de logs são interrompidas.

Perguntas frequentes

O texto de consulta deve ser registrado para diagnóstico?

não automaticamente. Identifique os campos mínimos de diagnóstico e teste primeiro com os dados sintéticos. Uma consulta completa pode ser desnecessária para analisar um status técnico.

Uma ferramenta de monitoramento substitui um proprietário?

Não. Ele coleta ou envia um sinal, mas alguém ainda precisa examiná-lo usando um procedimento acordado. Teste toda a rede com um incidente controlado e verifique o resultado esperado.