Carte Des Flux Client

Carte Des Flux Client

Objectif : définir la séquence de haut niveau attendue pour les clients qui intègrent jsonlog.

Flux Principaux

1. Amorcer l’auth auprès de auth.jsonlog.com et obtenir un token Bearer pour les routes isolées par compte.
2. Envoyer les logs via POST /log (public ou spécifique à un canal) avec un corps JSON.
3. Consommer les logs en temps réel via l’upgrade GET /ws avec filtres cid et level optionnels.
4. Appliquer l’accès aux canaux privés par claim de compte (acc) pour les lectures/écritures HTTP et WebSocket.
5. Découvrir les fichiers SSTable durables via POST /query et consulter les agrégats via GET /query/stats.
6. Surveiller la disponibilité du service et l’état du chemin d’écriture via GET /health et GET /stats.

Familles D’Endpoints

• Ingestion :
  • POST /log
  • GET /log
• Streaming :
  • GET /ws (endpoint d’upgrade WebSocket)
• Requête :
  • POST /query
  • GET /query/stats
• Service :
  • GET /health
  • GET /stats
• Documentation :
  • GET /openapi.json
  • GET /docs
  • GET /swagger

Exigences De Sécurité

• La vérification de signature JWT utilise par défaut https://auth.jsonlog.com/.well-known/jwks.json?client_id=cid_jsonlog.
• Les routes /query exigent une auth Bearer et utilisent acc du JWT pour l’isolation par compte.
• L’accès aux canaux privés exige que acc du JWT corresponde au compte propriétaire du canal.
• Les lectures non autorisées de canaux privés renvoient 404 pour éviter la découverte de canaux.
• L’usage sans auth est réservé au développement local et ne doit pas être la valeur par défaut en production.