Pular para o conteúdo principal

Status: Approved · v2 · SPEC-ARCH-OBS-001

depends_on: SPEC-API-OVERVIEW-001

used_by: IS-ZERO-00.3, IS-MVP-09.4, IS-MVP-15.1

Observabilidade e monitoramento

Diagnóstico do MVP com request IDs, logs úteis e privacidade, sem plataforma enterprise prematura.

Estratégia​

MVP​

  • Logs JSON estruturados no backend com level, service, requestId, route, duration e error code.
  • Error boundaries/web-mobile captuream falhas e mostram fallback profissional.
  • Health endpoint /api/v1/health.
  • Métricas mínimas: request count/error/duration e eventos de produto definidos nas UX specs.
  • Sentry/serviço externo é adapter configurável, não obrigatório localmente.

Privacidade​

Nunca logar senha, access/refresh token, Pix code completo, documento, payload privado, telefone/e-mail sem mascaramento ou asset signed URL.

Auditoria x log​

Audit log é dado de produto persistente e consultável por permission. Log técnico é operacional, retido conforme ambiente e não serve como prova de ação ao usuário.

Alertas iniciais​

API indisponível, taxa de erro elevada, falha persistente em webhook/jobs críticos. Evitar alert fatigue.

Critérios de aceite​

  • RequestId em logs e responses.
  • Stack não chega ao cliente.
  • Eventos críticos identificáveis.
  • Segredos mascarados.
  • Healthcheck pronto para deploy.