JL
ZH-CN
文档首页
菜单
指南

客户端流程图

定义接入 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,避免频道被探测。
  • 无认证模式仅用于本地开发,不应作为生产默认配置。