Guia de Projeto .NET API

Instrumentação e rollout completos para APIs ASP.NET

Use este guia para APIs ASP.NET onde confiabilidade depende de visibilidade de controllers, serviços e dependências externas.

Escopo de Arquitetura

  • Middleware HTTP e pipeline de endpoints.
  • Camadas de serviço e repositório.
  • Clientes outbound HTTP/DB/mensageria.

Setup Recomendado

  1. Inicialize SDK no startup do host.
  2. Instrumente fronteiras do middleware.
  3. Capture exceções estruturadas.
  4. Instrumente dependências outbound com spans.

Contrato Mínimo de Dados

  • Tags estáveis service, env, version.
  • Nomes de endpoint/operação consistentes.
  • Metadata de deploy via CI/CD.

Lista de Verificação

  • Telemetria de requisição com status/latência.
  • Exceções vinculadas a traces.
  • Shutdown do host faz flush da fila pendente.

Fortalecimento de Produção

  1. Flush no token de parada do host.
  2. Retry limitado e monitorado.
  3. Revalidação após upgrade de runtime/pacotes.

Solução de Problemas

  • Telemetria ausente após mudanças de startup: valide caminho de init.
  • Spans outbound ausentes: envolva HttpClient/DB.
  • Picos de volume: revise pontos de emissão e sampling.

Nesta página