JL
ZH-TW
文件首頁
選單
指南

用戶端流程圖

定義整合 jsonlog 的用戶端預期頂層流程。

guide jsonlog

用戶端流程圖

目的:定義整合 jsonlog 的用戶端預期頂層流程。

主要流程

  1. auth.jsonlog.com 完成驗證啟動,取得帳戶範圍路由所需的 Bearer 權杖。
  2. 透過 POST /log 傳送日誌(公開或頻道限定),請求本文為 JSON。
  3. 透過 GET /ws 升級即時串流,可選擇 cidlevel 篩選。
  4. 在 HTTP 與 WebSocket 讀寫上,依帳戶聲明(acc)強制私有頻道存取控制。
  5. 透過 POST /query 探索持久 SSTable 檔案,並透過 GET /query/stats 檢視聚合統計。
  6. 透過 GET /healthGET /stats 監控服務可用性與寫入路徑狀態。

端點家族

  • 擷取:
    • POST /log
    • GET /log
  • 串流:
    • GET /ws(WebSocket 升級端點)
  • 查詢:
    • POST /query
    • GET /query/stats
  • 服務:
    • GET /health
    • GET /stats
  • 文件:
    • GET /openapi.json
    • GET /docs
    • GET /swagger

安全預期

  • JWT 簽章驗證預設使用 https://auth.jsonlog.com/.well-known/jwks.json?client_id=cid_jsonlog
  • /query 路由需要 Bearer 驗證,並以 JWT acc 做帳戶隔離。
  • 私有頻道存取要求 JWT acc 與頻道擁有帳戶一致。
  • 未授權私有頻道讀取回傳 404,避免頻道被探測。
  • 無驗證模式僅供本機開發,不應作為正式環境預設。