Table des matières

Aperçu Contrôles de santé Métriques et surveillance Configuration des alertes Journalisation des requêtes Traçage distribué Surveillance du SLA Tableaux de bord Outils de surveillance Bonnes pratiques

Documentation de l'API

Surveillance, métriques et contrôles de santé de l'API

Surveillez Smart Money API avec des contrôles de santé complets, des métriques de performance et des alertes. Suivez la disponibilité, la latence, les taux d'erreur et la conformité SLA.

Publié le 21 mars 2026 • 13 min de lecture • Opérations

Aperçu de la surveillance

Smart Money API offre des capacités de surveillance complètes pour suivre la santé, les performances et la fiabilité du service. Mettez en œuvre ces stratégies de surveillance pour détecter les problèmes rapidement et maintenir une haute disponibilité.

Trois niveaux de surveillance :

Contrôles de santé — Disponibilité des endpoints et fonctionnalité de base
Métriques — Données de performance (latence, débit, taux d'erreur)
Journalisation — Détails des requêtes/réponses pour le débogage et l'audit

Métriques cibles : 99.9% de disponibilité, <100ms de latence p95, <0.1% de taux d'erreur, <5 secondes de temps moyen de détection.

Contrôles de santé

Endpoint de santé de l'API

Contrôle de santé
// Vérification simple de vivacité (aucune authentification requise)
GET /health
// Réponse
HTTP/1.1 200 OK
{
 "status": "healthy",
 "timestamp": 1709980800000,
 "uptime": 99.95
}

État de santé détaillé

Santé détaillée
// Statut détaillé avec santé des composants
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
  }
}

Obtenez votre clé API en 30 secondes

Prêt à construire ? Obtenez une clé API gratuite (200 appels/jour, sans carte) et commencez à récupérer des données en direct sur les baleines, les financements et les données on-chain.

Obtenez votre clé API →

Métriques et surveillance

Métriques clés à suivre

Métrique	Cible	Seuil d'alerte
Disponibilité	99.9%	<99.5%
Latence P95	<100ms	>500ms
Taux d'erreur	<0.1%	>1%
Requêtes/sec	Variable	Approche de la limite
Taux de succès du cache	>70%	<50%

Endpoint de métriques de l'API

Requête de métriques
// Obtenez les métriques de l'API pour la surveillance
GET /v1/metrics?period=1h
  -H "Authorization: Bearer token"
// Retourne les métriques au format Prometheus
# HELP api_requests_total Total des requêtes API
# TYPE api_requests_total counter
api_requests_total{method="GET",status="200"} 4502
api_requests_total{method="GET",status="429"} 12

Configuration des alertes

Alertes par webhook

Créer une alerte
POST /v1/alerts
  -H "Authorization: Bearer token"
  -d '{
 "name": "Taux d'erreur élevé",
 "condition": "error_rate > 0.01",
 "webhook_url": "https://hooks.slack.com/...",
 "severity": "high"
  }'

Types d'alertes

Alerte de disponibilité — API indisponible pendant plus de 5 minutes
Alerte de latence — La latence P95 dépasse le seuil
Alerte de taux d'erreur — Taux d'erreur supérieur à 1%
Alerte de limite de taux — Approche de la limite de taux
Alerte de fraîcheur des données — Données plus anciennes que le seuil

Journalisation des requêtes

Niveaux de journalisation

Exemple de journal
// Entrée typique de journal de requête API
{
 "timestamp": "2026-03-21T14:00:00Z",
 "request_id": "req_abc123def456",
 méthode: GET,
 chemin: /v1/whales/btc,
 statut: 200,
 durée_ms: 45,
 id_utilisateur: acct_12345
}

Journalisation Structurée

Tous les journaux sont au format JSON structuré pour une analyse facile :

Horodatage au format ISO 8601
ID de requête pour le traçage
Méthode HTTP et chemin
Statut de réponse et latence
ID utilisateur et empreinte de clé API
Messages d'erreur le cas échéant

Traçage Distribué

Suivi d'ID de Requête

En-têtes de Traçage
// Toutes les requêtes incluent des en-têtes de traçage
curl -H "X-Request-ID: req-abc123" \
  https://api.smartmoneyapi.com/v1/whales
// La réponse inclut le même ID
X-Request-ID: req-abc123
X-Response-Time: 45ms
X-Server: api-prod-01

Propagation du Contexte de Trace

Utilisez la norme W3C Trace Context pour les systèmes distribués :

W3C Trace Context
// La requête inclut le contexte de trace
traceparent: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
tracestate: dd=s:0
// ID de Trace : 4bf92f3577b34da6a3ce929d0e0e4736
// ID de Span : 00f067aa0ba902b7
// Échantillonné : true (01)

Surveillance des SLA

Objectifs de Niveau de Service

Plan	SLA de Disponibilité	Temps de Réponse	Support
Gratuit	99%	Meilleurs efforts	Communauté
Trader	99.5%	<200ms p95	Email
Pro	99.95%	<100ms p95	Prioritaire
Entreprise	99.99%	<50ms p95	Dédié

Crédits SLA

Si la disponibilité est inférieure au SLA, recevez des crédits de service :

99.0% - 99.5%: 10% de crédit mensuel
95.0% - 99.0%: 25% de crédit mensuel
< 95.0%: 100% de crédit mensuel

Tableaux de Bord de Surveillance

Tableau de Bord Intégré

Accédez au tableau de bord de performance à : https://status.smartmoney.io

Configuration de Tableau de Bord Personnalisé

Requête Prometheus
// Taux de requêtes API
rate(api_requests_total[5m])
// Taux d'erreurs
rate(api_requests_total{status=~"5.."}[5m])
// Percentile de latence
histogram_quantile(0.95, api_request_duration_ms)

Intégration d'Outils de Surveillance

Plateformes Prises en Charge

Outil	Intégration	Fonctionnalités
Prometheus	Point de terminaison /metrics natif	Collecte de métriques
Grafana	Plugin de source de données	Tableaux de bord personnalisés
Datadog	Intégration API	Traçage APM
New Relic	Intégration d'agent	Observabilité complète
PagerDuty	Alertes par webhook	Gestion des incidents

Bonnes Pratiques de Surveillance

1. Surveillez les Métriques Clés

Concentrez-vous sur les métriques impactant directement votre activité : disponibilité, latence, taux d'erreur.

2. Définissez des Alertes Appropriées

Alertez sur les symptômes, pas juste les seuils. Routez les alertes par gravité.

3. Utilisez des ID de Requête

Corrélez toujours les requêtes avec des ID uniques pour un traçage de bout en bout.

4. Implémentez le Traçage Distribué

Utilisez W3C Trace Context pour une visibilité sur les microservices.

5. Tests Réguliers d'Alerte

Testez les canaux d'alerte mensuellement pour vérifier l'escalade.

6. Documentez la Réponse aux Alertes

Créez des guides pour les alertes courantes avec étapes de résolution.

Assurez 99,9% de Disponibilité

Surveillez Smart Money API avec des contrôles de santé, métriques et alertes complets. Respectez les SLA grâce aux outils d'observabilité intégrés.

Commencer

Les plans Pro et Entreprise incluent un support dédié et une surveillance SLA.