Monitoramento, logs e observabilidade: fundamentos, prática e diagnóstico
Este capítulo integra o modelo mental e a prática de monitoramento, logs e observabilidade em uma única jornada didática. O leitor começa pelo problema operacional, aprende o vocabulário — incluindo telemetria, log estruturado, métrica, trace, span — e localiza responsabilidades e fronteiras antes de comparar decisões. Em seguida aplica o conceito ao sistema de manutenção conectado ao ERP, executa a menor fatia verificável e provoca falhas de permissão, timeout, duplicata, concorrência ou dado inválido. O caderno operacional mostra como observar o resultado, diagnosticar a primeira divergência e produzir evidência reproduzível. Segurança, custo, critérios de aceite e perguntas de recuperação encerram a unidade sem separar teoria de operação.
Monitoramento, logs e observabilidade: modelo mental e decisões
O problema e por que importa
Observabilidade permite investigar estados internos a partir de sinais externos; monitoramento acompanha condições conhecidas. Logs, métricas e traces respondem perguntas diferentes e só ganham valor quando podem ser correlacionados à jornada do usuário.
Quando a OS 742 fica “sincronizando”, a pergunta é: em qual etapa o tempo foi gasto, qual tentativa afetou o ERP e o usuário recebeu um estado coerente? Um dashboard verde de CPU não responde isso.
Vocabulário antes das siglas
- telemetria: dados emitidos por um sistema para permitir observação e análise de seu comportamento.
- log estruturado: evento registrado com campos estáveis e pesquisáveis, não apenas texto livre.
- métrica: medida numérica agregável ao longo do tempo.
- trace: representação do caminho de uma operação através de componentes distribuídos.
- span: unidade temporizada de trabalho dentro de um trace, com relações e atributos.
- correlação: ligação entre sinais da mesma jornada por identificadores e contexto controlados.
- cardinalidade: quantidade de combinações distintas de valores em um atributo de telemetria.
- dashboard: visão organizada de sinais para responder a perguntas operacionais específicas.
- alerta: notificação acionável disparada por condição que exige decisão ou resposta.
- SLI: service level indicator; medida observada de um aspecto da qualidade do serviço.
- SLO: service level objective; objetivo para um SLI durante uma janela definida.
Trace explica uma jornada; métrica mostra tendência; log fornece detalhe de evento. Nenhum sinal deve carregar segredos, e alta cardinalidade sem propósito pode tornar a observação cara ou inutilizável.
Modelo mental
monitoramento responde perguntas previstas; observabilidade permite investigar perguntas novas a partir de bons sinais. A analogia ajuda a localizar responsabilidades; ela deixa de valer quando esconde concorrência, falhas parciais ou atores maliciosos. Software distribuído não tem uma única percepção de tempo nem sucesso: uma resposta pode se perder depois de um efeito ter ocorrido.
Ler o fluxo em texto
- 1. OS 742
- 2. Correlação
- 3. Spans por dependência
- 4. SLO violado
- 5. Alerta acionável
Fronteira e responsabilidade
Cada componente propaga um contexto de correlação confiável, emite eventos estruturados e mede operações relevantes. A camada de observação agrega sem alterar o comportamento do domínio. Identificadores de usuário ou OS são tratados conforme privacidade e cardinalidade.
Alertas devem apontar impacto, responsável e runbook. SLOs nascem de jornadas; error budget conecta confiabilidade a ritmo de mudança. Registrar tudo não é observabilidade: é custo e risco sem pergunta definida.
Decisão orientada por risco
| Pergunta de projeto | Decisão inicial | Evidência exigida |
|---|---|---|
| Que pergunta responder? | Começar pela jornada e hipótese | Dashboard conduz a uma decisão |
| Qual SLI usar? | Sucesso e latência percebidos pelo usuário | Janela e unidade estão explícitas |
| Quando alertar? | Quando ação humana pode reduzir impacto | Alerta tem owner e runbook |
| Quanto reter? | Por finalidade, custo e obrigação | Expurgo e acesso são auditados |
A alternativa mais complexa só é promovida quando essa evidência mostra que a solução atual não atende ao risco. A decisão registra também custo operacional, forma de reversão e responsável.
Caso real: manutenção conectada ao ERP
O eletricista conclui a OS 742. O sistema valida identidade, unidade, estado atual e evidências; persiste a mudança; registra auditoria; publica a integração; informa “sincronização pendente” se o ERP não responder. A decisão deste livro aparece ao inferir o estado interno do sistema por sinais correlacionados e acionáveis. O sucesso não é apenas HTTP 200: banco, usuário, fila, ERP e telemetria precisam convergir para um estado conhecido.
Falha orientadora
milhões de logs sem correlation ID e métrica por user_id explodem custo e cardinalidade. Trate a falha como cenário de projeto, não exceção improvável. O controle principal é OpenTelemetry, semantic conventions, redaction, sampling, SLOs e alertas por sintoma. Seu teste deve falhar antes do controle e passar depois dele.
Segurança, privacidade e custo
- Remova tokens, senhas e payloads pessoais antes da emissão, não depois da indexação.
- Controle acesso e retenção de telemetria como dados de produção.
- Proteja identificadores de correlação contra injeção e não confie em valores externos sem normalização.
- Monitore o próprio pipeline de telemetria para evitar silêncio durante incidentes.
O manual de Cybersecurity aprofunda threat modeling, identidade, proteção de dados, supply chain e resposta a incidentes; os controles acima são a aplicação específica nesta disciplina.
Erros frequentes e diagnóstico
- Tecnologia antes do problema: registre hipótese e atributo de qualidade que justificam a escolha.
- Caminho feliz apenas: injete timeout, duplicata, concorrência, permissão negada e dado inválido.
- Métrica de vaidade: acompanhe cobertura de trace, sinais correlacionados, cardinalidade, custo e alertas acionáveis e ligue o sinal a uma decisão.
- Automação sem condição de parada: limite tentativas e torne o estado pendente visível.
- Documentação sem prova: execute exemplos e conecte diagramas a arquivos, owners e testes.
Critérios de aceite
- Fronteira, dono, entradas, saídas e dependências estão diagramados.
- Caminho feliz e falha parcial possuem testes reproduzíveis.
- O controle “OpenTelemetry, semantic conventions, redaction, sampling, SLOs e alertas por sintoma” tem evidência observável.
- Segurança, privacidade, acessibilidade, custo e operação foram avaliados.
- A métrica “cobertura de trace, sinais correlacionados, cardinalidade, custo e alertas acionáveis” possui unidade, janela e responsável.
- Runbook informa diagnóstico, mitigação, recuperação e escalonamento.
Prática e recuperação ativa
- Desenhe a jornada da OS 742 e marque onde esta camada começa e termina.
- Explique a diferença entre ocultar uma ação e negar sua autorização no servidor.
- Injete a falha “milhões de logs sem correlation ID e métrica por user_id explodem custo e cardinalidade” e capture evidência antes/depois do controle.
- Transfira o raciocínio para um pedido de e-commerce: o que permanece e o que muda?
Entregável verificável: mapa de sinais da jornada, trace correlacionado, SLI/SLO com janela e alerta testado com runbook. A entrega só é aceita quando outra pessoa consegue repetir a verificação.
Fontes primárias e oficiais
Revisão editorial: 2 de agosto de 2026. Confirme versões antes de implementar configuração volátil.
- https://opentelemetry.io/docs/concepts/
- https://opentelemetry.io/docs/specs/otel/
- https://sre.google/sre-book/service-level-objectives/
Da compreensão à execução
O modelo anterior explica o que precisa permanecer verdadeiro. Agora o caderno transforma essa compreensão em um experimento. Antes de executar, escreva sua previsão; depois compare o observado com o esperado e registre a primeira fronteira onde o estado divergiu.
Objetivo, hipótese e ambiente
Objetivo: demonstrar inferir o estado interno do sistema por sinais correlacionados e acionáveis em uma fatia da jornada de manutenção. Hipótese: o controle “OpenTelemetry, semantic conventions, redaction, sampling, SLOs e alertas por sintoma” reduz a falha escolhida sem violar o contrato das camadas vizinhas.
Pré-requisitos: Git, terminal, TypeScript ou a tecnologia indicada no exemplo, ambiente local isolado e dados sintéticos. Duração orientativa: 90–180 minutos; depende de prática, não de leitura. Não use credenciais reais nem produção.
sequenceDiagram
actor E as Eletricista
participant W as Aplicativo
participant A as API de manutenção
participant D as Estado canônico
participant R as ERP
E->>W: conclui OS 742
W->>A: intenção + identidade + idempotency-key
A->>D: valida e persiste
A-->>W: estado confirmado ou pendente
A->>R: integração controlada
R-->>A: confirmação, rejeição ou timeoutPasso 1 — registre o contrato antes do código
Escreva pré-condição, pós-condição, erros esperados, timeout e política de repetição. Separe “aceito para processamento” de “confirmado pelo ERP”. Defina o que a pessoa verá durante incerteza. O contrato deve caber em uma tabela e ser revisado por negócio, desenvolvimento, segurança e operação.
| Situação | Resultado público | Estado interno | Próxima ação |
|---|---|---|---|
| Entrada válida | confirmado ou 202 pendente | registrado | processar/observar |
| Sem permissão | negação estável | nenhuma mutação | auditar |
| Duplicata | mesmo resultado lógico | um efeito | responder idempotente |
| Dependência lenta | timeout controlado | pendente conhecido | retry com limite |
| Dado incompatível | erro de contrato | quarentena | corrigir/reprocessar |
Passo 2 — implemente a menor fatia vertical
O trecho é didático e precisa ser adaptado ao runtime indicado. Ele ilustra a decisão central, não constitui aplicação completa.
span.setAttributes({
"service.name": "maintenance-api",
"work_order.id": order.id,
"erp.result": result.status
});Mantenha a mudança pequena: interface, regra, persistência, teste e sinal operacional no mesmo ticket. Evite construir “toda a infraestrutura” antes de uma jornada observável.
Passo 3 — prove o caminho feliz e o negativo
- Execute uma OS válida e capture resposta, estado persistido e correlation ID.
- Repita a mesma intenção; o efeito lógico deve continuar único.
- Remova a permissão; nenhum estado deve mudar.
- Force timeout do ERP; a UI deve mostrar estado honesto e a fila não pode crescer sem limite.
- Corrompa um campo do contrato; rejeite-o com erro útil, sem stack trace nem segredo.
O teste negativo é parte do produto. Sem ele, o controle pode existir apenas no diagrama.
Passo 4 — instrumente a decisão
Registre duração, resultado, dependência, versão do contrato e correlação. Não use nome, e-mail, token, payload completo nem user_id como dimensão ilimitada de métrica. Para este livro, acompanhe cobertura de trace, sinais correlacionados, cardinalidade, custo e alertas acionáveis. Defina SLI, janela, limiar e ação humana associada.
Exemplo de evento estruturado conceitual:
{
"event": "work_order.transition",
"order_id": "742",
"result": "pending_erp",
"contract_version": "v1",
"correlation_id": "demo-01",
"duration_ms": 184
}Passo 5 — injete falha e recupere
Falha-alvo: milhões de logs sem correlation ID e métrica por user_id explodem custo e cardinalidade.
- Detectar: qual sinal diferencia falha real de tráfego normal?
- Conter: como impedir propagação, repetição ilimitada ou perda de dados?
- Mitigar: qual recurso pode ser desativado ou degradado com segurança?
- Recuperar: como reprocessar sem duplicar efeito?
- Aprender: qual teste, alerta, ADR ou limite impedirá recorrência?
Use timeout curto no laboratório e retry limitado com atraso e jitter. Um retry não é recuperação quando a operação não é idempotente. Registre itens que exigem intervenção humana em fila consultável; não esconda exceções em log.
Segurança e abuso
Faça uma mini análise: ativo, ator, fronteira, ameaça, impacto, controle e teste. Teste acesso horizontal entre unidades, elevação de perfil, payload grande, repetição rápida, dado fora de ordem e indisponibilidade. O controle esperado é OpenTelemetry, semantic conventions, redaction, sampling, SLOs e alertas por sintoma. Valide no servidor e preserve evidência sem expor segredos.
Troubleshooting
| Sintoma | Hipótese | Verificação | Correção segura |
|---|---|---|---|
| Estado diverge do ERP | efeito parcial | correlação + outbox/inbox | reconciliar idempotentemente |
| Latência cresce | fila ou dependência saturada | p95/p99, lag, pool | backpressure e capacidade |
| Só um tenant falha | escopo, dado ou quota | dimensão de tenant controlada | corrigir política/dado |
| Retry aumenta erro | operação não idempotente | contar efeitos por chave | deduplicar e limitar |
| Dashboard “verde” | SLI não representa jornada | teste sintético E2E | medir resultado do usuário |
Critérios de aceite verificáveis
- Caminho feliz, entrada inválida, negação, duplicata e timeout foram executados.
- O segundo envio com a mesma chave não produz segundo efeito.
- Nenhum segredo ou dado pessoal aparece em saída, log ou fixture.
- A falha é detectada por sinal antes da reclamação do usuário.
- Existe estado explícito para pendência e procedimento de reconciliação.
- O resultado inclui teste, captura de telemetria, ADR e atualização do runbook.
Evidência, limpeza e solução comentada
Guarde: comandos, versões, saída dos testes, screenshot do fluxo, consulta de estado e gráfico do sinal. Remova ambiente e dados sintéticos; revogue qualquer credencial de laboratório. A solução adequada não é uma ferramenta específica: é a menor composição que satisfaz o contrato e demonstra recuperação.
Exercícios de transferência
- Troque ERP por gateway de pagamento. Quais garantias ficam mais rígidas?
- Troque OS por leitura de sensor offline. Onde ordenar e deduplicar?
- Reduza o RTO pela metade. Qual custo e complexidade aparecem?
- Explique em voz alta por que
monitoramento responde perguntas previstas; observabilidade permite investigar perguntas novas a partir de bons sinaisé útil e onde a analogia quebra.
Fontes
Consulte as fontes oficiais do capítulo conceitual e registre versão/data no relatório do laboratório. Para observabilidade, use OpenTelemetry; para segurança, use o manual canônico.
Comprove o que você aprendeu
Responda todas as questões. O gabarito comentado só aparece depois do envio.