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
| Endpoint | Uso | Cadencia recomendada |
|---|---|---|
GET /v1/health | disponibilidad global de servicios | checks continuos cada 30s-60s |
GET /v1/metrics/fiscal | métricas de emisión y conciliación | revisión horaria y dashboards |
POST /v1/alerts | creación/disparo de alertas | cuando 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
curl -X GET https://api.beacon.pt/v1/health \
-H "Authorization: Bearer <access_token>"
{
"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.