13 KiB
13 KiB
new-api-key-usage
NewAPI 网关下的 key 用量统计工具（产品名 NAKU）
定时用每个 sk-key 轮询网关日志接口，按 request_id 去重，攒全量日志到数据库；任意时间范围的用量查询，即一条本地聚合查询。
| 项目 | 内容 |
|---|---|
| 当前状态 | 实现推进中——设计文档主体定稿；后端 + 同步引擎 + 前端（管理面与成员视图）已落地；部署链已定（见 docs/design/部署方案.md）；Cloudflare Workers 抽取版待做 |
| 技术栈 | 全栈 TypeScript（选型见 docs/design/技术选型.md）：Bun + Hono + Drizzle + PostgreSQL · 前端 Vue 3 + antdv-next |
这是什么
面向 NewAPI 实例的独立计费辅助平台：订阅持有人创建多个 sk- API key 分发给多名使用者，平台把「谁用了多少」的事实记录清楚——用量、来源标注、支付参数、多维统计；不算「谁该付谁多少钱」（分摊是人和人之间的事）。
适用场景：同一份订阅额度由多人共享的小团队 / 成本分担群体。
- 名字直述用途：NewAPI 网关下按 key 查询用量（key usage）；产品展示名 NAKU
- 仓库名 / 包名统一小写 kebab-case
背景与约束
- 典型场景：NewAPI（Go + GORM 开源 LLM 网关）实例提供订阅服务，多名使用者通过分发 API key 共享订阅额度——非商业，纯成本分担
- 平台持有方通常只是实例的普通用户：只有 sk-key，没有实例管理员账号
- 一切数据获取只能走 key 级接口（账号级接口用 sk-key 访问会 401）——这是整个数据链路的设计前提
- 部署形态为双形态并行：完整前后端跑在自有或托管服务器上（见
docs/design/部署方案.md）；Cloudflare Workers 抽取版部署在自己掌控的账号里（见docs/design/需求清单.mdR13）
双形态并行的动因：服务器部署形态下，每次迭代都要经服务器管理员手工升级；Workers 形态把迭代部署权收回自己手里。完整前后端先行，抽取版延后至功能全集实现后。
核心能力
| # | 能力 | 说明 |
|---|---|---|
| 1 | key 用量查询 | 按时间范围查模型请求日志与用量；管理端全员视角，成员端各自视角 |
| 2 | key 登记 | 管理通道手动登记：入库并加入轮询；生命周期为手动启停（引擎只读 status） |
| 3 | 支付事实登记 | 订阅权益与充值入账分表登记；billing_domain 标账本域，成员同域可见 |
| 4 | 多维统计 | 按成员 / key / 计费来源 / 模型的任意时段聚合 |
完整需求范围（含刻意不做的部分）见 docs/design/需求清单.md。
架构的根本动因：为什么必须攒数据
这不是优化选项，是上游接口的物理约束决定的唯一路径（不随部署形态改变）：
- sk-key 可用的接口（
/api/usage/token、/api/log/token等）返回的都是累计值或最近 1000 条，没有任何接口支持时间范围过滤 - 真正适合算「当月用量」的接口（
/api/log/self/stat，支持时间范围 + quota 汇总）需要账号登录态，sk-key 访问 401——这是「按时间段统计用量」无法纯客户端实现的核心障碍 /api/log/token硬上限 1000 条、不支持任何参数（分页 / limit / 时间过滤全被忽略）
→ 结论：轮询同步 + request_id 去重入库 + 数据库。部署形态可以变，攒库架构不变。 上游接口完整实证（含源码出处）见 docs/references/NewAPI-接口范围.md。
技术栈与结构
全栈 TypeScript，monorepo（Bun workspaces）：
apps/
server/ # 后端：Hono + Drizzle/pg + Scalar 在线文档
engine/ # 同步引擎：独立进程，轮询去重入库
web/ # 前端：Vue 3 + antdv-next + Vite
packages/
core/ # 业务核心：去重、折算、加密、上游客户端、DTO
db/ # 数据访问层：Drizzle schema + 仓储
数据模型：api_keys · usage_logs · subscriptions · topups · qpu_history + members · users · sessions。
快速开始
前置：Bun、一个可用的 PostgreSQL（本机已有或别处均可）。
bun install
cp .env.example .env # DATABASE_URL 指向你已有的 PostgreSQL
bun run db:push # 开发期推送 schema（启动不自动迁）
bun run dev:server # 后端（默认 18456）
bun run dev:engine # 同步引擎（另开终端）
bun run dev:web # 前端 Vite（5175）
在线 API 文档：http://127.0.0.1:18456/api/docs。
更多命令与协作约定见 AGENTS.md。
部署
方案详文见 docs/design/部署方案.md。形态一句话：本地打产物包 → 覆盖服务器 release/ → 一条 compose 命令 → 看容器。
本地打包
bun run naku pack
# 交互选：目标平台 · 打包内容 · 是否 tar.gz
# 产出 release/：dist · naku-server · naku-engine · naku-migrate · drizzle/
# 非交互（CI / 一键）：
bun run pack:release
# 或 bun run naku pack --yes --target=bun-linux-arm64 --only=dist,naku-server
服务器
首次安装：把 docker-compose.yml · Dockerfile · .dockerignore · Caddyfile · entrypoint-*.sh 放到约定目录（如 /opt/naku/），再放 release/，填写 .env（chmod 600）。日常更新只覆盖 release/。
cd /opt/naku
docker compose up -d --build
docker compose ps # migrate 应为 exited(0)，其余 running/healthy
- 页面：
http://<服务器>/（若改了HTTP_PORT则加端口）；接口文档：http://<服务器>/api/docs - 迁移：由
migrate一次性服务在启动时幂等执行（journal），重复执行不会多灌 - 端口：默认 80/443；宿主机被占用时在
.env设HTTP_PORT/HTTPS_PORT，再执行固定命令 - HTTPS：
Caddyfile站点行改成域名，.env设COOKIE_SECURE=true，再执行固定命令
注意
.env不进产物包、不进 git；含SK_KEY_ENCRYPTION_SECRET，须与数据库同等备份COOKIE_SECURE必须与访问方式匹配：HTTP +true会「登录后立刻 401」DATABASE_URL密码含@:/等字符时做 URL 编码
文档地图
| 文档 | 什么时候读 | 状态 |
|---|---|---|
docs/design/需求清单.md |
需求权威索引与裁决档案——R1–R16 定案；含支付拆表与成员档案/空壳删除裁决 | 定稿（2026-10-10） |
docs/design/技术选型.md |
技术栈裁决：全栈 TS；Bun + Hono + Drizzle/pg；前端 Vue 3 + antdv-next；分层落地与回退 | 定稿（2026-10-02） |
docs/design/部署方案.md |
母体交付与更新：产物包、服务器目录、容器编排、迁移时机、安全约定 | 已实现（定稿 2026-10-12） |
docs/design/api_keys表字段设计.md |
key 登记、生命周期与成员归属 | 定稿（2026-10-01） |
docs/design/usage_logs表字段设计.md |
日志明细、来源提列、去重与写入策略 | 同上 |
docs/design/payments建模评估.md |
支付建模复盘：订阅权益 vs 充值入账两分；拆表已采纳 | 定稿（2026-10-09） |
docs/design/subscriptions表字段设计.md |
订阅权益：期间 + 额度预算 + 可选付款事实；subscription_id 直连日志 |
定稿（2026-10-12） |
docs/design/topups表字段设计.md |
充值入账事件：paid_at 主轴；不挂订阅 |
定稿（2026-10-12） |
docs/design/qpu_history表字段设计.md |
换算参数时间线（自动采样、只读） | 定稿（2026-10-01） |
docs/design/members表字段设计.md |
成员实体——key 归属、身份与统计锚点；档案可改、空壳可删 | 定稿（2026-10-10） |
docs/design/users表字段设计.md |
管理员（单行）——登录体系的身份落点 | 同上 |
docs/design/sessions表字段设计.md |
管理面会话——cookie 令牌的服务端对应物 | 同上 |
docs/design/交互设计-总览与共性.md |
交互总纲：访问拓扑、导航、跨页组件、状态与数值呈现约定 | 定稿（2026-10-01） |
docs/design/交互设计-登录与会话.md |
登录页、引导页、改密、成员登录壳 | 同上 |
docs/design/交互设计-全员总览.md |
管理面首页：健康带 + 按成员 / key 汇总 | 同上 |
docs/design/交互设计-调用日志.md |
调用日志：筛选、汇总条、来源徽章支付弹窗、明细表与跳转链 | 定稿（2026-10-08；模型筛选与汇总条、徽章弹窗修订） |
docs/design/实现方案-日志模型筛选与汇总条.md |
日志页模型筛选 + 条数/消费用量汇总条：API、数据层、前端改造与验收 | 已实现（2026-10-13） |
docs/design/交互设计-key管理.md |
登记（sk-key 唯一界面露面）、启停、归属、死亡显形 | 定稿（2026-10-01） |
docs/design/交互设计-支付记录.md |
支付记录（两 Tab）：订阅权益 / 充值入账登记、核对提示、ID/交易号筛选 | 定稿（2026-10-12；补筛选） |
docs/design/交互设计-成员管理.md |
开户、档案修改、令牌签发/重发、启停、空壳删除 | 定稿（2026-10-10） |
docs/design/交互设计-审计日志.md |
管理操作留痕时间线 | 定稿（2026-10-10） |
docs/design/交互设计-成员视图.md |
成员视图三页（总览 / 调用日志 / 支付参数）；订阅徽章展开 + 调用详情 | 定稿（2026-10-09） |
docs/design/API契约-公共约定.md |
API 总纲：路由隔离与鉴权两档、错误信封、时间 / 数值 / 分页 / 命名 | 定稿（2026-10-10） |
docs/design/API契约-管理面.md |
管理面 18 端点 | 定稿（2026-10-12） |
docs/design/API契约-成员视图.md |
成员视图 3 端点：/me · /overview · /logs |
定稿（2026-10-12） |
docs/design/同步引擎设计.md |
独立 apps/engine：轮次、失败只记录、engine_status 快照 |
已实现（定稿 2026-10-05） |
docs/references/NewAPI-接口范围.md |
上游可用接口参考：鉴权档位、字段语义、实测行为、源码出处（唯一上游参考） | 事实依据 |
- 命名与分区：目录用英文、文档名用中文；
docs/design/（方案与决策）·docs/references/（平台可用接口参考——实证事实，不做设计决策） - 生命周期：状态流转（草案 → 讨论中 → 待审阅 → 定稿(日期) → 已实现）；定稿后不搬家、只改状态；被取代时删除（git 历史即考古）
- AI 协作物料：
AGENTS.md（协作约定）与.agents/skills/（技能包）随仓库分发——参与开发的 Agent 从这里读取项目约定，人工贡献者亦可参考
关键事实清单（实测 / 源码确认，设计时不得违反）
出处均见
docs/references/NewAPI-接口范围.md，此处仅索引。
QuotaPerUnit = 500000：quota ÷ 500000 = 额度美元——它不是实付金额；折算到实付金额还需乘「购买汇率」（由运营方定价、可变）- 去重必须用
request_id：/api/log/token返回的id是每次从 1 重编的展示序号，绝不能用于去重 created_at是 UTC Unix 秒，本地时间输入需转换- 1000 条硬上限：窗口只保留最近 1000 条——当前日志速率下约等于 3 天；同步停摆超过窗口会永久丢数据
TokenAuthReadOnly：用量/日志接口用宽松鉴权，key 过期 / 额度耗尽仍可查询；显式禁用会被 401 拒绝DisplayTokenStatEnabled已开启：billing 接口返回 token 级额度
License
MIT © 2026 skycurtain
NAKU 是 NewAPI 的独立客户端，仅通过 HTTP API 交互，不包含其源码；与上游许可证相互独立。上游 NewAPI 为 AGPL-3.0，本项目不受其传染，亦不衍生自它。