Beacon

Observability API

Ver como Markdown

Observability API

Endpoints de health, métricas y alertas para operación continua.

reference • updated 2026-03-15

Objetivo

Proporcionar visibilidad operacional sobre salud de plataforma, rendimiento fiscal y condiciones de alerta para respuesta rápida.

Endpoints principales

EndpointUsoCadencia recomendada
GET /v1/healthdisponibilidad global de servicioschecks continuos cada 30s-60s
GET /v1/metrics/fiscalmétricas de emisión y conciliaciónrevisión horaria y dashboards
POST /v1/alertscreación/disparo de alertascuando se superan umbrales

Taxonomía mínima de métricas

  • Disponibilidad: ratio de éxito en endpoints críticos.
  • Latencia: p95/p99 para checkout, webhooks y emisión fiscal.
  • Backlog: eventos/documentos pendientes por organización.
  • Calidad: ratio de retries, clases de error y tiempo medio de recuperación.

Ejemplo de lectura de health

bash
curl -X GET https://api.beacon.pt/v1/health \
  -H "Authorization: Bearer <access_token>"
json
{
  "ok": true,
  "timestamp": "2026-03-15T10:15:00Z",
  "services": {
    "billing": "up",
    "webhooks": "up",
    "fiscal": "up"
  }
}

Política de alertas

  • Define umbrales por entorno (test, live) y severidad (P1/P2/P3).
  • Enruta alertas a responsables operativos explícitos.
  • Asocia cada alerta a runbook y criterio de cierre.

Buenas prácticas operativas

  • No silenciar alertas sin contexto de incidente.
  • Revisar semanalmente ruido vs. cobertura.
  • Correlacionar picos de alertas con ventanas de despliegue y cambios.