Tabla de contenidos

Resumen Comprobaciones de estado Métricas y monitorización Configuración de alertas Registro de solicitudes Trazado distribuido Monitorización de SLA Paneles Herramientas de monitorización Mejores prácticas

Documentación de la API

Monitorización, métricas y comprobaciones de estado de la API

Monitoriza Smart Money API con comprobaciones de estado completas, métricas de rendimiento y alertas. Controla el tiempo de actividad, latencia, tasas de error y cumplimiento del SLA.

Publicado el 21 de marzo de 2026 • 13 min de lectura • Operaciones

Resumen de monitorización

Smart Money API ofrece capacidades completas de monitorización para rastrear el estado del servicio, rendimiento y fiabilidad. Implementa estas estrategias de monitorización para detectar problemas temprano y mantener un alto tiempo de actividad.

Tres niveles de monitorización:

Comprobaciones de estado — Disponibilidad del endpoint y funcionalidad básica
Métricas — Datos de rendimiento (latencia, rendimiento, tasas de error)
Registro — Detalles de solicitud/respuesta para depuración y auditoría

Métricas objetivo: 99.9% tiempo de actividad, <100ms latencia p95, <0.1% tasa de error, <5 segundos tiempo medio de detección.

Comprobaciones de estado

Endpoint de estado de la API

Comprobación de estado
// Comprobación simple de actividad (no requiere autenticación)
GET /health
// Respuesta
HTTP/1.1 200 OK
{
 "status": "healthy",
 "timestamp": 1709980800000,
 "uptime": 99.95
}

Estado de salud detallado

Estado detallado
// Estado detallado con salud de componentes
GET /v1/status
  -H "Authorization: Bearer token"
{
 "status": "operational",
 "components": {
 "api": "healthy",
 "database": "healthy",
 "cache": "healthy",
 "exchanges": "healthy"
  },
 "metrics": {
 "p95_latency_ms": 85,
 "error_rate": 0.0012,
 "uptime_percent": 99.95
  }
}

Obtén tu clave API en 30 segundos

¿Listo para construir? Obtén una clave API gratuita (200 llamadas/día, sin tarjeta) y comienza a obtener datos en vivo de ballenas, financiación y cadena de bloques.

Obtén tu clave API →

Métricas y monitorización

Métricas clave a seguir

Métrica	Objetivo	Umbral de alerta
Tiempo de actividad	99.9%	<99.5%
Latencia P95	<100ms	>500ms
Tasa de error	<0.1%	>1%
Solicitudes/seg	Varía	Acercándose al límite
Tasa de acierto de caché	>70%	<50%

Endpoint de métricas de la API

Consulta de métricas
// Obtén métricas de la API para monitorización
GET /v1/metrics?period=1h
  -H "Authorization: Bearer token"
// Devuelve métricas en formato Prometheus
# HELP api_requests_total Total de solicitudes API
# TYPE api_requests_total counter
api_requests_total{method="GET",status="200"} 4502
api_requests_total{method="GET",status="429"} 12

Configuración de alertas

Alertas por webhook

Crear alerta
POST /v1/alerts
  -H "Authorization: Bearer token"
  -d '{
 "name": "Alta tasa de error",
 "condition": "error_rate > 0.01",
 "webhook_url": "https://hooks.slack.com/...",
 "severity": "alta"
  }'

Tipos de alerta

Alerta de tiempo de actividad — API no disponible durante más de 5 minutos
Alerta de latencia — La latencia P95 supera el umbral
Alerta de tasa de error — Tasa de error superior al 1%
Alerta de límite de tasa — Acercándose al límite de tasa
Alerta de frescura de datos — Datos más antiguos que el umbral

Registro de solicitudes

Niveles de registro

Ejemplo de registro
// Entrada típica de registro de solicitud API
{
 "timestamp": "2026-03-21T14:00:00Z",
 "request_id": "req_abc123def456",
 método: GET,
 ruta: /v1/whales/btc,
 estado: 200,
 duración_ms: 45,
 ID de usuario: acct_12345
}

Registro Estructurado

Todos los registros son JSON estructurados para facilitar el análisis:

Marca de tiempo en formato ISO 8601
ID de solicitud para trazabilidad
Método HTTP y ruta
Estado de respuesta y latencia
ID de usuario y huella de clave API
Mensajes de error si aplican

Trazabilidad Distribuida

Seguimiento de ID de Solicitud

Encabezados de Trazabilidad
// Todas las solicitudes incluyen encabezados de trazabilidad
curl -H "X-Request-ID: req-abc123" \
  https://api.smartmoneyapi.com/v1/whales
// La respuesta incluye el mismo ID
X-Request-ID: req-abc123
X-Response-Time: 45ms
X-Server: api-prod-01

Propagación de Contexto de Traza

Usa el estándar W3C Trace Context para sistemas distribuidos:

W3C Trace Context
// La solicitud incluye contexto de traza
traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
tracestate: dd=s:0
// ID de Traza: 4bf92f3577b34da6a3ce929d0e0e4736
// ID de Span: 00f067aa0ba902b7
// Muestreado: true (01)

Monitoreo de SLA

Objetivos de Nivel de Servicio

Plan	SLA de Tiempo de Actividad	Tiempo de Respuesta	Soporte
Gratis	99%	Mejor esfuerzo	Comunidad
Trader	99.5%	<200ms p95	Correo electrónico
Pro	99.95%	<100ms p95	Prioritario
Empresa	99.99%	<50ms p95	Dedicado

Créditos de SLA

Si el tiempo de actividad cae por debajo del SLA, recibe créditos de servicio:

99.0% - 99.5%: 10% de crédito mensual
95.0% - 99.0%: 25% de crédito mensual
< 95.0%: 100% de crédito mensual

Paneles de Monitoreo

Panel Integrado

Accede al panel de rendimiento en: https://status.smartmoney.io

Configuración de Panel Personalizado

Consulta de Prometheus
// Consulta la tasa de solicitudes API
rate(api_requests_total[5m])
// Consulta la tasa de errores
rate(api_requests_total{status=~"5.."}[5m])
// Consulta el percentil de latencia
histogram_quantile(0.95, api_request_duration_ms)

Integración de Herramientas de Monitoreo

Plataformas Soportadas

Herramienta	Integración	Características
Prometheus	Endpoint /metrics nativo	Extracción de métricas
Grafana	Plugin de fuente de datos	Paneles personalizados
Datadog	Integración API	Trazabilidad APM
New Relic	Integración de agente	Observabilidad completa
PagerDuty	Alertas por webhook	Gestión de incidentes

Mejores Prácticas de Monitoreo

1. Monitorea Métricas Clave

Enfócate en métricas que impacten directamente tu negocio: tiempo de actividad, latencia, tasa de errores.

2. Configura Alertas Apropiadas

Alerta sobre síntomas, no solo umbrales. Dirige alertas por severidad.

3. Usa IDs de Solicitud

Siempre correlaciona solicitudes con IDs únicos para trazabilidad de extremo a extremo.

4. Implementa Trazabilidad Distribuida

Usa W3C Trace Context para visibilidad en microservicios.

5. Pruebas Regulares de Alertas

Prueba canales de alerta mensualmente para asegurar que la escalada funcione.

6. Documenta Respuesta a Alertas

Crea manuales para alertas comunes con pasos de resolución.

Garantiza 99.9% de Tiempo de Actividad

Monitorea Smart Money API con verificaciones de salud, métricas y alertas. Cumple con el SLA usando herramientas de observabilidad integradas.

Comienza

Los planes Pro y Empresa incluyen soporte dedicado y monitoreo de SLA.