Peta Alur Klien

Peta Alur Klien

Tujuan: menentukan urutan tingkat atas yang diharapkan untuk klien yang mengintegrasikan jsonlog.

Alur Utama

1. Bootstrap auth ke auth.jsonlog.com dan dapatkan token Bearer untuk rute berbasis akun.
2. Kirim log melalui POST /log (publik atau per channel) dengan body JSON.
3. Stream log real-time melalui upgrade GET /ws dengan filter cid dan level opsional.
4. Terapkan akses channel privat berdasarkan claim akun (acc) untuk baca/tulis HTTP dan WebSocket.
5. Temukan file SSTable durable via POST /query dan periksa agregat via GET /query/stats.
6. Pantau kesiapan layanan dan status jalur tulis via GET /health dan GET /stats.

Keluarga Endpoint

• Ingesti:
  • POST /log
  • GET /log
• Streaming:
  • GET /ws (endpoint upgrade WebSocket)
• Query:
  • POST /query
  • GET /query/stats
• Layanan:
  • GET /health
  • GET /stats
• Dokumentasi:
  • GET /openapi.json
  • GET /docs
  • GET /swagger

Ekspektasi Keamanan

• Verifikasi tanda tangan JWT secara default menggunakan https://auth.jsonlog.com/.well-known/jwks.json?client_id=cid_jsonlog.
• Rute /query memerlukan auth Bearer dan menggunakan acc JWT untuk isolasi akun.
• Akses channel privat mengharuskan acc JWT cocok dengan akun pemilik channel.
• Pembacaan channel privat tanpa izin mengembalikan 404 untuk mencegah discovery channel.
• Penggunaan tanpa auth hanya untuk pengembangan lokal dan tidak boleh menjadi default produksi.