Guia de Projeto NestJS

Abordagem completa de instrumentação para APIs e microsserviços NestJS

Use este guia para backends NestJS onde ciclo de requisição, DI e fronteiras de módulo precisam ser observáveis.

Escopo de Arquitetura

  • Controllers HTTP e cadeia de middleware.
  • Chamadas entre serviços/providers.
  • Operações outbound (HTTP/DB/fila).

Setup Recomendado

  1. Inicialize SDK antes do app escutar porta.
  2. Instrumente ciclo de requisição (entrada -> handler -> resposta).
  3. Capture erros estruturados em filtros globais.
  4. Adicione spans em DB e chamadas externas.

Contrato Mínimo de Dados

  • Nome de serviço estável por domínio de app.
  • Tags de ambiente e versão em todos os eventos.
  • Propagação de correlation ID em operações assíncronas.

Lista de Verificação

  • Erros 4xx/5xx com contexto de trace.
  • Endpoints lentos com spans úteis.
  • Startup/shutdown com flush correto.

Fortalecimento de Produção

  1. Limite queue/retry.
  2. Alerta para falha de ingestão.
  3. Revalidação após refactor de módulos.
  4. Runbook de rotação de chave documentado.

Solução de Problemas

  • Sem eventos após deploy: valide caminho de bootstrap.
  • Spans ausentes em async handlers: confirme propagação de contexto.
  • Ruído alto: reduza eventos de baixo valor.

Nesta página