Criar registries de observabilidade: metrics_registry.yaml e span_names.yaml

[4lessandrodev]

Visão geral

Padronizar nomes de métricas e spans/traces para evitar fragmentação em dashboards e auditoria.

Contexto

Métricas e spans mudam rápido; registry evita que cada repo invente nomes diferentes. O core-contracts guarda o catálogo normativo; a emissão fica no repo observability.

Descrição

Criar observability/metrics_registry.yaml com:

• lista de métricas recomendadas (MVP):
  • http_requests_total
  • http_request_duration_ms
  • cache_hit_total
  • search_candidates_returned
  • pipeline_stage_duration_ms
• labels permitidos e exemplos.

Criar observability/span_names.yaml com:

• spans recomendados (MVP):
  • http.server
  • catalog.search
  • pipeline.stage.ingest|normalize|qa|export

Adicionar exemplos e instruções de uso em doc curto (pode ser docs/observability.md dentro do core-contracts).

Impacto

Evita divergência de métricas e melhora operação/monitoramento de forma consistente.

Referências

• https://github.com/OpenAudit-Brasil/openaudit-core-contracts/blob/main/README.md
• https://github.com/OpenAudit-Brasil/About/blob/main/ROADMAP.md
• https://github.com/OpenAudit-Brasil/About/blob/main/SECURITY.md

Definição de pronto

• Arquivos YAML criados
• Registry inclui nomes, descrição, labels e exemplos
• Referenciado no README do core-contracts como convenção oficial

Tags

• priority:medium
• type:feature
• area:observability
• good first issue