O que é um log
Log é um registro produzido por um sistema sobre algo que aconteceu durante sua execução. Ele pode informar que uma tarefa começou, uma chamada foi recusada ou um arquivo foi gerado, com campos que ajudam a interpretar aquela ocorrência.
Uma mensagem isolada mostra apenas o que o componente registrou. Você precisa relacioná-la à tarefa investigada e às outras informações disponíveis, pois o registro de uma falha pode descrever sua consequência sem explicar a causa original.
Mensagem, horário e identificação
O horário situa o evento, enquanto o nome do serviço e o identificador da operação ajudam a encontrá-lo entre muitas execuções. Um nível como INFO ou ERROR indica a classificação usada pela aplicação, cuja convenção precisa ser conhecida.
Um formato estruturado permite filtrar campos como job_id, tentativa e resultado separadamente. Ao procurar o mesmo job_id, você pode distinguir a primeira tentativa que falhou da segunda que terminou, mesmo que as mensagens tenham sido registradas em horários próximos. Esses nomes são exemplos de campos que a aplicação pode definir.
A ordem de chegada pode diferir da ocorrência
Mensagens de serviços diferentes podem chegar ao coletor com atraso. Relógios desalinhados e fusos mal interpretados também podem produzir uma sequência aparente que não corresponde ao percurso real.
Confira se o campo exibido representa o horário do evento ou o da coleta. Use identificadores e relações entre chamadas para complementar a leitura temporal, especialmente quando vários componentes participam da mesma tarefa.
Emitir, coletar e preservar
Uma aplicação pode escrever na saída do processo, enquanto o ambiente encaminha o conteúdo para armazenamento e busca. A mensagem aparecer no terminal não comprova que ela chegou ao serviço central nem que continuará disponível depois de alguns dias.
Filtros de nível, falhas no encaminhamento e políticas de retenção alteram o que você consegue consultar. Ao investigar um intervalo sem registros, confira essas etapas antes de concluir que a aplicação não executou trabalho algum.
Registre o necessário para investigar
Um identificador da tarefa pode permitir localizar a falha sem registrar senhas, tokens ou todo o conteúdo enviado. Campos sensíveis precisam ser omitidos ou tratados de acordo com a finalidade do registro e com as permissões de consulta.
Gravar mais mensagens também consome armazenamento e pode dificultar a leitura. Escolha eventos que diferenciem etapas e resultados, preservando os campos necessários para associar uma tentativa à operação correspondente.
Como conferir a utilidade dos registros
Execute uma tarefa controlada e procure suas mensagens no destino usado para investigação. Confira se consegue localizar o início, interpretar o resultado e distinguir uma nova tentativa, inclusive quando simula uma falha.
O trace distribuído pode complementar essa leitura com tempos e relações entre componentes. Para investigar logs de uma aplicação com orientação técnica ao vivo, o Desenvolvimento Colaborativo da Dev Side Studio pode atender uma demanda delimitada do projeto.
Dúvidas frequentes
Perguntas frequentes sobre Log
- Todo log precisa estar em um arquivo?
- Não. A aplicação pode escrever em uma saída capturada pelo ambiente e encaminhada a outro serviço. O arquivo é uma forma de armazenamento, não a definição do log.
- Uma linha com ERROR identifica a causa original?
- Não necessariamente. Ela pode registrar apenas a consequência observada naquele componente. A investigação precisa relacionar a mensagem à operação e aos eventos anteriores.
- Posso gravar o corpo completo de toda chamada?
- Isso pode expor credenciais e informações pessoais, além de aumentar o armazenamento. Selecione os campos necessários à investigação e confira o tratamento aplicado antes do envio ao coletor.
- A ausência de log comprova que a tarefa não foi executada?
- Não. A etapa pode não ter sido instrumentada, o nível pode estar filtrado ou a coleta pode ter falhado. A retenção também pode ter removido registros antigos.
Para continuar
Recursos relacionados
Documentação
The Twelve-Factor App: logs
Registros como fluxo de eventos e separação entre emissão e armazenamento.
Abrir recursoDocumentação
OpenTelemetry: correlação entre sinais
Associação de logs ao percurso de uma operação.
Abrir recursoAplicação na formação
Formação DevOps
Logs registram ocorrências do sistema e permitem investigar o que aconteceu durante sua execução.
Conhecer a formação
Fontes consultadas
Referências deste verbete
Este verbete ajudou você?
Obrigado pela resposta. Ela fica salva apenas neste navegador.