From 16cf68d132c69efa4471d562f3ff84dc7655f3c0 Mon Sep 17 00:00:00 2001 From: admin Date: Mon, 14 Sep 2026 19:32:17 +0800 Subject: [PATCH] =?UTF-8?q?feat(stats):=20=E8=BF=90=E8=A1=8C=E6=9C=9F?= =?UTF-8?q?=E7=BB=9F=E8=AE=A1=E8=90=BD=E7=9B=98/=E6=81=A2=E5=A4=8D=20+=20?= =?UTF-8?q?=E5=AE=A1=E8=AE=A1=E5=8F=A3=E5=BE=84=E6=94=B6=E5=8F=A3=20(1.0.1?= =?UTF-8?q?8)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 起因:发版后管理台「用量」与「趋势」从 0 重新长起来。根因是统计类键 (ust:/ums:/utt:/utms:/ud:/udu:/uds:/uda:/uex:/uh:)只活在共享内存, 进程退出即消失;而上游/账号/域名/用户都有 data/*.json 所以不丢。 统计落盘(新 stats_persist.rs): - 快照 data/llm-stats.json(与 users.json 同级),原子写 .tmp. + rename - 两个落盘点互补:worker 退出钩子 exit_process(发版/docker stop,零丢失) + 记账后按间隔节流落盘(默认 60s,覆盖 SIGKILL/OOM/断电) - 启动 init_process 恢复,put-if-absent → 多 worker 幂等、不覆盖新数据 - 白名单 10 个统计前缀;刻意排除配置类/ukb:/内核态(各有数据文件或重启清零更安全) - 恢复结果发布 shm spr:last(不再放进程内静态量,否则接口落到哪个 worker 报哪个数) - 接口 GET /api/admin/stats/persist + POST /api/admin/stats/dump - 指令 ipass_stats_persist <秒>(0=只留退出钩子);生产 conf 刻意不写 fix(audit): excerpt 双重编码 - json_quote_bytes(手工转义+两侧引号)塞进 json!() 被二次转义,落盘成 "excerpt":"\"{\\\"model\\\"…",解码后多一层引号,消费方全解析不到 - 改为 excerpt_text():只 from_utf8_lossy,转义交给 serde docs: 新增 docs/llm/STATS_PERSISTENCE.md(含 runbook)、docs/llm/AUDIT_LOG.md (两者此前被代码注释与 Dockerfile 引用但文件并不存在) tests: - 新增【15】统计落盘/重启恢复 13 条(间隔压 1s → 快照产出与白名单 → nginx -s quit → 恢复键数 == 快照键数、用量不变、再打一笔 +1、趋势仍在) - 【13】「不再生成 body 副本」改断言本轮增量 = 0(对历史残留免疫); 选择器改 body_bytes>400 且取最后一条匹配(目录里有首版的双重编码行) - run.sh 复位改用 mv(rename 不算删除)——本机 safe-delete 钩子在累计删除 超 50 个文件后会静默拦掉后续删除,rm -rf 与 python rmtree 同样被拦 - 回归 298 全绿(网关 102 + LLM 196) --- CLAUDE.md | 39 +- docs/llm/AUDIT_LOG.md | 225 +++++++++++ docs/llm/STATS_PERSISTENCE.md | 317 +++++++++++++++ readme.md | 34 ++ rust/crates/ipass-core/src/util.rs | 34 ++ rust/crates/plugin-llm/src/api.rs | 30 ++ rust/crates/plugin-llm/src/config.rs | 52 ++- rust/crates/plugin-llm/src/lib.rs | 9 +- rust/crates/plugin-llm/src/llm_audit.rs | 93 ++++- rust/crates/plugin-llm/src/stats.rs | 5 + rust/crates/plugin-llm/src/stats_persist.rs | 407 ++++++++++++++++++++ rust/gateway/src/lib.rs | 65 +++- tests/llm/e2e.sh | 211 +++++++++- tests/llm/nginx.conf.in | 6 + tests/run.sh | 14 + 15 files changed, 1498 insertions(+), 43 deletions(-) create mode 100644 docs/llm/AUDIT_LOG.md create mode 100644 docs/llm/STATS_PERSISTENCE.md create mode 100644 rust/crates/plugin-llm/src/stats_persist.rs diff --git a/CLAUDE.md b/CLAUDE.md index 2b219dd..ed25be4 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -113,7 +113,7 @@ rust/ | crate | 模块 | 键空间 | | --- | --- | --- | | `plugin-domain` | `domains`(申请/审批/写穿)、`resolve`(ResolveHandler + `$proxy_backend_addr`)、`api`、`config/models/store` | `sub:` | -| `plugin-llm` | `llm`(slot 解析/变量求值)、`upstreams`(CRUD/写穿/健康/**多账号路由**/账号负载)、`usage_filter`(body filter 抓 usage+耗尽 marker,走 `loc::enabled`+`ctx_index`)、`llm_audit`(对话审计落盘)、`stats`(用量账本+趋势)、`handlers`(Llm/LlmHealth/Audit)、`api`、`config/models/store` | `up:` `upa:` `uac:` `ukb:` `upe:` `uh:` `ust:` `ums:` `utt:` `utms:` `ud:` `udu:` `uds:` `uda:` `uex:` | +| `plugin-llm` | `llm`(slot 解析/变量求值)、`upstreams`(CRUD/写穿/健康/**多账号路由**/账号负载)、`usage_filter`(body filter 抓 usage+耗尽 marker,走 `loc::enabled`+`ctx_index`)、`llm_audit`(对话审计落盘)、`stats`(用量账本+趋势)、`stats_persist`(统计落盘/恢复,1.0.18)、`handlers`(Llm/LlmHealth/Audit)、`api`、`config/models/store` | `up:` `upa:` `uac:` `ukb:` `upe:` `uh:` `ust:` `ums:` `utt:` `utms:` `ud:` `udu:` `uds:` `uda:` `uex:` `spr:` | | `plugin-apix` | `apix`(slug/拼体/写穿)、`handlers`(ApiProxyHandler)、`api`、`config/models/store` | `ax:` | gateway 只剩:模块壳(7 条指令 + `ModuleConfig` 开关 + 变量/装载装配循环)、 @@ -201,6 +201,7 @@ POST /openai/v1/chat/completions Authorization: Bearer sk_<本网关签 | `crates/plugin-llm/src/llm.rs` | 热路径:slot 解析、Bearer 提取、身份查询、OpenAI 兼容错误体、三个变量的 get_handler | | `crates/plugin-llm/src/upstreams.rs` | 上游校验/读写/写穿共享内存,是域名插件在 LLM 侧的翻版;`models` 登记 + `available()` / `models_flat()` 模型发现;**多账号路由**(`pick_account` 粘性 + FNV-1a 冷分散 + 天锚定冷却 `cool_until_until`)、**账号级负载**(`uda:`/`uex:` 日桶,`view()` 投影)、**`normalize_auth`**(裸 key 自动补 `Bearer `,写入 `upsert` + 读出 `read_upa` 双处应用) | | `crates/plugin-llm/src/stats.rs` | 用量账本(`ust:` 每账号 / `ums:` 每账号×上游,请求级、只读 shm)与 `overview()` 投影;**唯一写点在 `LlmHandler` 鉴权全通过之后** | +| `crates/plugin-llm/src/stats_persist.rs` | 统计落盘/恢复(1.0.18):快照 `data/llm-stats.json`、白名单 `PREFIXES`、退出钩子 + 周期落盘、put-if-absent 恢复、`spr:last` 恢复记录 | | `data/llm-upstreams.json` | 上游表(**含真实密钥**);`base` 可带路径,`auth` 是完整的 Authorization 值,`models` 仅供模型发现 | | `conf/nginx.conf` | `lm.mayishangshu.cn:18098` server;SSE 三件套 + `proxy_ssl_server_name` | | `users.json` → `allowed_models` | 上游白名单;**空 = 不限**(老数据没有该字段,反序列化即空表) | @@ -233,11 +234,31 @@ token 计费与零依赖红线冲突,别轻易许诺。 **用量统计(2026-09-12)**:`stats::record` 只统计**真正转发出去**的请求,401/403/404/429 不计, 所以它在 `check_quota` 之后、`NGX_DECLINED` 之前调用,**挪位置就改变了语义**。与配额计数 `st:` -**刻意分开**(配额宁可多算防滥用,用量要准对账),别想着合并。计数只在 shm(`ust:` 每账号、 -`ums:` 每账号×上游)、重启归零、不落盘——要持久化就得加文件,与红线冲突。 +**刻意分开**(配额宁可多算防滥用,用量要准对账),别想着合并。 **删账号必须调 `stats::forget`**:用量键是按前缀扫出来出报表的,不清就会让已删账号继续挂在用量榜上 (与「删账号必须摘 `ukey:`」同类,只是影响面在报表不在鉴权,最容易漏)。 +**统计落盘 / 恢复(1.0.18,发版不再清零)**:`ust:` `ums:` `utt:` `utms:` `ud:` `udu:` `uds:` `uda:` +`uex:` `uh:` 此前**只活在共享内存**,进程退出即消失 → 每次发版用量与趋势从 0 重长。 +现在由 `stats_persist.rs` 落一个 JSON 快照 `data/llm-stats.json`(与 `users.json` 同级), +**两个落盘点互补**:worker 退出钩子(`gateway::exit_process`,覆盖发版 / `docker stop`,零丢失) ++ 记账后按间隔节流落盘(默认 60 秒,覆盖 `SIGKILL`/OOM/断电)。 +启动时 `gateway::init_process` 调 `restore()`,**put-if-absent** → 多 worker 天然幂等、绝不把计数恢复成 N 倍。 +⚠️ **新增统计类键前缀必须同步 `stats_persist::PREFIXES`**,漏加不报错、只在发版后表现为「这一列从 0 开始」。 +恢复结果发布到 shm(`spr:last`)而不是进程内静态量——否则接口落到哪个 worker 就报哪个数。 +接口:`GET /api/admin/stats/persist`(状态)、`POST /api/admin/stats/dump`(强制落一次); +指令 `ipass_stats_persist <秒>`(**生产 conf 刻意不写**,用默认 60,避免旧镜像 unknown directive 起不来)。 +**新增统计前缀 = 改 `PREFIXES`**;详情与 runbook 见 `docs/llm/STATS_PERSISTENCE.md`。 + +**对话审计(1.0.18 改口径)**:LLM location 开 `client_body_in_file_only clean`, +log 阶段单遍扫描 body 临时文件,往 `<审计根>/YYYY-MM-DD/meta.jsonl` 追加**一行**: +`ts/time/user/slot/status/tin/tout/excerpt/body_hash/body_bytes`。 +**不再复制完整请求体**(旧版每请求 700 KB+,QPS 10 一天 600 GB,10 GB 配额 24 分钟就 purge)。 +`excerpt` = 前 100 字节(**转义只由 `json!()` 做一次**,自己再转义会双重编码成 `"\"{\\\"model…"`, +消费方全部解析不到——1.0.18 首版踩过);`body_hash` = **全文** SHA256 前 16 hex +(只哈希前 100 字节会因所有请求开头相同而**全量碰撞**);`body_bytes` = 全文字节数。 +`AUDIT_MAX_BYTES` 由 10 GB 改 **1 GB**。详见 `docs/llm/AUDIT_LOG.md`。 + **路径拼接去重(2026-09-12 修复)**:`llm::join_target(base, path)` 在 base 路径段与请求路径开头 重复时只保留一份——上游 `base` 带 `/v1`、客户端又带 `/v1` 时,少这一步就会拼成 `/v1/v1/...` → 上游 **404 且响应体为空**,而网关侧日志一切正常,极难排查。`upstreams::base_url` 对外回显的 @@ -269,6 +290,9 @@ location 与 80 端口 LLM server 是两份拷贝,改一处记得同步另一 | `/v1/models` 反而 404 | `is_models_probe` 的位置错了:**必须在解析 slot 之前**,否则被当成 `slot=v1` | | 用量一直是 0 | 被拒的请求(401/403/404/429)**不计用量**;或 `stats::record` 被挪出了"鉴权全通过之后" | | 删了账号还在用量榜上 | 没调 `stats::forget`(清 `ust:` / `ums:` 前缀) | +| **发版后用量/趋势全变 0** | 快照没落上:查 `data/llm-stats.json` 是否存在 / 可写(数据卷),看 error log 有无 `[stats]` 报错。⚠️ 注意**登录会话(`sess:`)与配额(`st:`)重启清零是设计如此**,别把这两样当成故障 | +| `restored_keys == 0` 但 `file_keys > 0` | 快照版本不符 / 解析失败(会改名 `.bad` 留档)/ 全部过期。看 error log 的 `[stats]` 行 | +| 某维度发版后从 0 开始、别的维度不丢 | 新加的统计前缀**漏加进 `stats_persist::PREFIXES`**(不报错,只在发版后暴露) | | 账号负载数是真实值的 3 倍 | `bump_acct_load` 被放进了 `pick_account` —— `$llm_target`/`$llm_auth`/`$llm_acct` 三个变量各触发一次。**只能在 log 阶段记一次** | | 某把 Key 耗尽后一直在冷却 / 迟迟不恢复 | `resets` 填成滚动时长(`now+5h`)而非天锚定周期;MiniMax 视角的 5h 窗口末段只有 4h(见 `upstreams::cool_until_until`) | | 同一下游 Key 每次换上游账号 | 粘性绑定 `ukb:` 没写(下行 Key 缺失时本就不写);或该 Key 哈希落点恰好在冷却账号上 | @@ -278,7 +302,7 @@ location 与 80 端口 LLM server 是两份拷贝,改一处记得同步另一 | query 参数丢失 | 变量形式的 `proxy_pass` 不会自动追加 args,靠 `llm::upstream_uri` 拼好 | **本机验证夹具**:`tests/llm/`,由 `bash tests/run.sh llm` 一并起假上游(18999)、LLM 网关(18090) -与**管理端口 18091**(跑 `/api/v1/*` 账号态断言)后跑断言。当前规模:网关 **102 条** + LLM **177 条** +与**管理端口 18091**(跑 `/api/v1/*` 账号态断言)后跑断言。当前规模:网关 **102 条** + LLM **196 条** (`bash tests/run.sh all`,期望失败 0)。 `tests/llm/upstream.py` 会把收到的 `path` / `auth` / `host` / `body` 记到 `.run/llm/upstream.log` @@ -290,6 +314,13 @@ carol `llm_rpm=2`、dave `llm_daily=2`(限流断言用)。夹具上游含 ** 夹具重置一律用 **`cp` 覆盖写**(`tests/gateway/fixtures/`、`tests/llm/fixtures/`), **不要 `rm` 运行目录里的 json**——本机安全钩子会拦 `rm`,残留脏数据会导致大面积假失败。 +⚠️ **本机 `safe-delete` 钩子会拦「批量删除」**:同一个 agent turn 里累计删除超过 **50** 个文件后, +后续所有删除**静默失效**(日志里只有 `SAFE_DELETE_BULK_CONFIRM_REQUIRED`)。表现为「清理没报错但没生效」。 +**要复位状态就用 `mv`(rename 不算删除)**——`tests/run.sh` 清上一轮的 `data/llm-stats.json` +就是 `mv` 到 `.run/llm/stale/`。清不掉的后果很隐蔽:上一轮的 `ust:`/`ud:`/`uh:` 会被启动时的 +`restore()` 灌进本轮(carol 用量 2 变 6、「上游健康初始状态」`unknown` 变 `ok`), +看起来像统计功能有 bug,实际是**测试间的状态泄漏**。 + ## 性能基线(实测,勿凭直觉优化) ### Rust 版(当前架构) diff --git a/docs/llm/AUDIT_LOG.md b/docs/llm/AUDIT_LOG.md new file mode 100644 index 0000000..ef5c95f --- /dev/null +++ b/docs/llm/AUDIT_LOG.md @@ -0,0 +1,225 @@ +# LLM 对话审计(meta.jsonl) + +> 适用版本:`ipass-1.0.18`(1.0.17 及更早是「全量请求体副本」口径)。 +> 涉及文件:`rust/crates/plugin-llm/src/llm_audit.rs`(实现)、 +> `rust/crates/plugin-llm/src/{config,handlers}.rs`、`conf/nginx.conf`(LLM location)、 +> `tests/llm/e2e.sh`(【9】【13】)、`Dockerfile`(审计目录与权限)。 + +--- + +## 一、解决什么问题 + +### 旧口径(1.0.17 及更早):把**完整请求体复制一份**存档 + +每个被转发的 LLM 请求,在 log 阶段把 body 临时文件整个复制成 +`<审计根>/YYYY-MM-DD/<毫秒>_.json`。 + +代价: + +| 请求类型 | 单请求审计占用 | +|---|---| +| 简单对话 | ~2 KB | +| 带 tools / 多轮 history(实际生产常见) | **700 KB+** | + +按 QPS 10 估算 = **一天 600 GB**。而 `AUDIT_MAX_BYTES` 当时是 10 GB → +**24 分钟就触发一次 purge**,审计留存时长实际是「分钟级」,复盘价值几乎为零。 +更糟的是它掩盖了容量真相:10 GB 的配额在新口径(~400 B/条)下等于「永远不会 purge」, +这个数字本身就是误导。 + +### 新口径(1.0.18):**元数据 + 前 100 字节摘录** + +不再复制 body。改为**单遍扫描** body 临时文件,产出一行元数据: + +``` +<审计根>/YYYY-MM-DD/meta.jsonl ← 一行一个请求,追加写 +``` + +单请求占用 **~400 B**(一行 meta),比旧口径**降约 3 个数量级**。 +`AUDIT_MAX_BYTES` 相应从 10 GB 改为 **1 GB**(够约 250 万条,约 7 天 @ QPS 4)。 + +### 为什么先扫全文,而不是只读前 100 字节 + +`body_hash` 要当「同一请求」的指纹用(查重、对齐上游账目)。而**所有** +OpenAI / Anthropic 请求的前 100 字节都是同一个开头: + +```json +{"model":"gpt-4o","messages":[{"role":"user","content":"... +{"model":"claude-3-5-sonnet","messages":[{"role":"user","con... +``` + +只哈希前 N 字节 → **全部碰撞**,这一列就是废数据。 +所以:**只把前 N 字节留在内存**,其余边读边喂 SHA256 后丢弃, +`body_hash` 用**全文**、`body_bytes` 记**全文字节数**。 + +> 成本仍然**低于** 1.0.17 的「读全文 + 写全文副本」——那是读 + 写, +> 这是只读一遍顺序 IO,不复制、不落盘。 + +--- + +## 二、捕获机制 + +1. LLM location 开 `client_body_in_file_only clean` —— nginx 自己把请求体刷到临时文件。 +2. 本模块在 **log 阶段**(`handlers.rs` 的日志处理器)调 `capture()`: + - 取 `r->request_body->temp_file`;**为空直接返回**(本地应答 / 被拒请求 / 无 body → 不审计)。 + - `scan_body()` 单遍扫描:拿前 100 字节 + 全文 SHA256 + 全文字节数。 + - 追加一行到 `<审计根>//meta.jsonl`。 + - 顺带触发一次容量巡检(节流)。 +3. **只有真正转发出去的请求才入档**:401 / 403 / 404 / 429 在 log 阶段拿不到 temp_file + (路径不同、body 没落盘),自然不入档。这与用量统计口径一致。 + +--- + +## 三、`meta.jsonl` 行格式 + +```json +{ + "ts": 1789384310, + "time": "2026-09-14 19:11:50", + "user": "alice", + "slot": "openai", + "status": 200, + "tin": 7, + "tout": 3, + "excerpt": "{\"model\":\"gpt-4o\",\"messages\":[{\"role\":\"user\",\"content\":\"AAAA…", + "body_hash": "172d7d031d91d02e", + "body_bytes": 472 +} +``` + +| 字段 | 含义 | +|---|---| +| `ts` / `time` | 落档时刻(秒 / 可读文本)。**注意这是 log 阶段时刻,不是请求开始时刻** | +| `user` | 下游账号(`ust:` 同一套用户名);取不到时为 `-` | +| `slot` | 上游 slot;取不到时为 `-`。apix 的条目是 `api/` | +| `status` | 转发后**回给客户端**的 HTTP 状态码 | +| `tin` / `tout` | 上游 usage 里的 input / output token(body filter 旁路抓的,见 `STREAMING_USAGE.md`)。`0` = 上游没给 usage(如 OpenAI 流式未开 `include_usage`) | +| `excerpt` | 请求体**前 100 字节**。JSON 转义由 serde 统一做 | +| `body_hash` | **全文** SHA256 的前 16 hex(64 bit) | +| `body_bytes` | **全文**字节数(不是 excerpt 的长度) | + +### ⚠️ `excerpt` 只转义一次 + +`excerpt` 的值是**裸字符串**,转义由 `json!()`(serde_json)统一处理。 +实现里**不要**自己再手工转义一遍 —— 那样会双重编码,落盘成 +`"excerpt":"\"{\\\"model\\\"…"`,读出来多一层引号, +任何按前缀匹配的消费方(含测试断言)都解析不到。 + +(1.0.18 首版踩过这个坑:原来有个 `json_quote_bytes()` 手工转义 + 加引号, +再塞进 `json!` 又被转义一次。已删除,改为 `excerpt_text()` 只做 UTF-8 安全解码。) + +截断按**字节**做,可能切在多字节字符中间;`String::from_utf8_lossy` 会把残缺尾巴 +换成 U+FFFD(合法 JSON 字符),不会产出非法 UTF-8。 + +### 摘录的取舍 + +- 100 字节覆盖:模型名 + 首条消息的 `role` + 首句用户内容(短 query 整条保留)。 +- 大 body(带 tools / 多轮 history)**只看得到头,看不到尾** —— 这是**有意**的: + 复盘 90% 的场景「当时用户问了什么 + 用了哪个模型」够用。 + 要看全文请走 hot path 日志或实时抓包,**不要**指望 audit。 + +--- + +## 四、目录与配置 + +| 项 | 值 / 指令 | +|---|---| +| 审计根(默认) | `data` 目录的**兄弟目录** `audit/`(容器内 `/usr/local/nginx/audit`) | +| 覆盖 | `ipass_audit_dir ` | +| 日期分目录 | `<审计根>/YYYY-MM-DD/`(字典序 = 时间序,purge 依赖这一点) | +| 文件名 | `meta.jsonl`(追加写,一行一条) | +| 容量上限 | `AUDIT_MAX_BYTES` = **1 GB**(1.0.18 起;旧值 10 GB) | +| 巡检节流 | `AUDIT_PURGE_MIN_INTERVAL` = 60 秒(`AtomicBool` 单飞) | +| 启动巡检 | worker 启动时强制巡检一次(不依赖外部 cron) | + +**purge 策略**:扫审计根下各日期目录算总字节;超限就按目录名(= 日期) +**从旧到新整目录删除**,直到回到上限内。 + +> 容器里首次启动会 `mkdir -p /usr/local/nginx/audit` 并 +> `chown -R nobody:nogroup`(见 `Dockerfile`)——**worker 默认是 nobody,目录必须对它可写**, +> 否则审计静默失效(只写 error log)。生产建议把 audit 挂到宿主机卷, +> 否则容器重建即丢(与 `data/` 同等对待)。 + +--- + +## 五、失败策略 + +审计是**旁路**功能: + +- body 没落盘 / temp_file 为空 → **静默返回**(不报错、不影响转发); +- 建目录失败 → `log_err` + **该次跳过**(并在启动时标记「审计停用」); +- 写 meta 失败 → `log_err`; +- 容量巡检失败 → `log_err`。 + +**任何情况下都不影响转发结果**,也不阻塞 worker 启动。 + +--- + +## 六、怎么用 + +### 复盘「某个用户当时问了什么」 + +```bash +# 今天 alice 的最近 20 条 +grep '"user":"alice"' /$(date +%F)/meta.jsonl | tail -20 | python3 -m json.tool --json-lines + +# 只看模型 + 前 100 字节摘录 +jq -r 'select(.user=="alice") | "\(.time) \(.status) \(.excerpt)"' /$(date +%F)/meta.jsonl +``` + +### 找「同一个请求被重复转发了几次」(`body_hash` 的用途) + +```bash +jq -r '.body_hash' /*/meta.jsonl | sort | uniq -c | sort -rn | head +``` + +### 看审计占了多少空间 / 是否需要 purge + +```bash +du -sh +du -sh /* | tail -5 # 按天分布 +``` + +### 按 token 找最贵的请求(复盘成本) + +```bash +jq -r 'select(.tin+.tout > 10000) | "\(.time) \(.user) \(.slot) in=\(.tin) out=\(.tout) \(.body_bytes)B"' \ + /$(date +%F)/meta.jsonl | sort -k4 -rn | head +``` + +--- + +## 七、测试覆盖 + +`tests/llm/e2e.sh`: + +- **【9】** 容量巡检 / purge 行为(`purge_once` 依赖 nginx 运行时符号, + `cargo test --lib` 会 SIGABRT —— 行为只能由 e2e 覆盖)。 +- **【13】** 元数据口径: + 1. 转发的请求都落了 meta 行; + 2. 本轮**没有新增** `*.json` 副本(断言的是**增量**,机器上可能还压着 + 1.0.17 及更早写下的上千个文件 —— 且本机的 safe-delete 钩子在累计删除 + 超过 50 个文件后会拦掉后续删除,清不掉); + 3. meta 行记录账号 / 上游 / 状态; + 4. `excerpt` **恰好**等于请求体前 100 字节(用 472 字节的长 body 验证, + 选择器是 `body_bytes > 400` 而不是「excerpt 前缀匹配」—— + 后者在 excerpt 被转义坏掉时连行都选不中,会把「内容不对」伪装成「找不到行」); + 5. `body_bytes` = 请求体真实长度(472); + 6. `body_hash` 是 16 位 hex; + 7. 全量目录里**搜不到**长 body 的尾部标记(`ZZ_TAIL_MARK`)→ 证明真的只截了 100 字节; + 8. 被拒请求(401)不入档。 + +> 断言取**最后一条**匹配的 meta 行(不是第一条):审计目录里可能留着 +> 1.0.18 首版写下的双重编码行,它排序在前会把第一条位置占掉。 + +--- + +## 八、已知限制 + +- **不是全量归档**:只留前 100 字节 + 全文指纹。要看全文请另建链路。 +- **一行一条、无索引**:日文件是纯追加的 JSONL,量大时用 `jq` / `grep` 流式扫; + 没有数据库(项目红线)。 +- **`ts` 是 log 阶段时刻**:与「客户端发出请求的时刻」有差(流式请求尤其明显, + 差值 ≈ 响应耗时)。 +- **陈旧残留**:1.0.17 及更早写下的 `<毫秒>_.json` 不会被新代码清理 + (purge 只按日期整目录删,会在超限时连带清掉)。升级后如果磁盘吃紧, + 手动清一次 `audit/*/*.json`。 diff --git a/docs/llm/STATS_PERSISTENCE.md b/docs/llm/STATS_PERSISTENCE.md new file mode 100644 index 0000000..c38a789 --- /dev/null +++ b/docs/llm/STATS_PERSISTENCE.md @@ -0,0 +1,317 @@ +# 运行期统计的落盘与恢复(发版不再清零用量 / 趋势) + +> 适用版本:`ipass-1.0.18`(插件化后的 `plugin-llm`)。 +> 涉及文件:`rust/crates/plugin-llm/src/stats_persist.rs`(主体)、 +> `rust/crates/plugin-llm/src/{config,stats,api}.rs`、`rust/gateway/src/lib.rs`(两个生命周期钩子)、 +> `tests/llm/{nginx.conf.in,e2e.sh}`、`tests/run.sh`。 + +--- + +## 一、解决什么问题 + +### 症状 + +**每次发版(容器重建)后,管理台的「用量」与「趋势」从 0 重新长起来**: +- 「用量」页所有人的累计请求数 / token 数回到 0; +- 「趋势」图最近 14 天的柱子在发版当天全部塌成 0。 + +而上游配置、账号、域名、用户都**不丢**——这个反差是定位问题的关键线索。 + +### 根因 + +| 数据 | 存放位置 | 发版后 | +|---|---|---| +| `up:` / `upa:` / `upe:`(上游与账号) | 共享内存 **+ `data/llm-upstreams.json`** | 不丢(启动由 `reload_shm` 从文件装载) | +| `ax:`(API 代理) | 共享内存 **+ `data/api-proxies.json`** | 不丢(同上) | +| `ukey:` / `sub:`(用户与 Key) | 共享内存 **+ `data/users.json`** | 不丢(同上) | +| `ust:` `ums:` `utt:` `utms:` `ud:` `udu:` `uds:` `uda:` `uex:` `uh:`(**用量 / 趋势 / 负载 / 健康**) | **只有共享内存** | **全丢** | + +共享内存是 nginx **每进程**启动时 mmap 出来的匿名区,**进程退出即消失**。 +统计类数据此前没有任何落盘,于是「重启 = 统计归零」。 + +### 做法(不引入数据库) + +项目红线禁止数据库 / Redis / MQ(见 `CLAUDE.md`)。所以方案是**一个 JSON 快照**: + +``` +data/llm-stats.json # 与 users.json / llm-upstreams.json 同级 +``` + +`data/` 是宿主机挂载卷(容器内 `/usr/local/nginx/data`),容器重建不影响它。 + +--- + +## 二、两个落盘点(互补,不是二选一) + +| 触发 | 时机 | 覆盖场景 | +|---|---|---| +| **worker 退出钩子** `exit_process` | 优雅停机(`docker stop` → `STOPSIGNAL SIGQUIT`;`SIGTERM` 同路径;`nginx -s quit`) | 发版 / 手动重启 —— **零丢失** | +| **周期性节流落盘** `maybe_dump()` | log 阶段记账之后,默认每 60 秒一次 | `SIGKILL` / OOM / 断电 —— 最多丢一个周期 | + +- 退出钩子是**主力**:镜像 `Dockerfile` 里声明了 `STOPSIGNAL SIGQUIT`, + `docker stop` 走的就是优雅停机路径,worker 退出前会调到该钩子。 +- 只有 `SIGKILL` 会绕过退出钩子(`docker kill`、OOM killer、宿主机断电), + 由周期落盘兜住。 +- **周期落盘挂在记账路径**(`stats::record` 末尾调 `maybe_dump()`), + 所以 apix 复用同一入口时也天然覆盖,不必单独挂。 + +### 原子写 + +`写 .tmp. → rename`。带 pid 后缀是必要的:多 worker 同时到点落盘时, +固定的 `.tmp` 会互相踩(一个已经 rename 走了,另一个还在往同名文件里写)。 +`rename` 本身是原子的,最后写完的那个赢——内容本来就只是「同一份共享内存的近似快照」,谁赢都对。 + +> 刻意**不复用** `store::write_json`(它用固定 `.tmp`)与 `state::file_lock()` +> (那是给「读-改-写」防丢失用的;本函数是纯覆盖写、不读旧值,拿锁只会在退出路径上增加卡死风险)。 + +--- + +## 三、恢复语义 + +启动时每个 worker 的 `init_process` 都会调一次 `stats_persist::restore()`(由 gateway 注册)。 +共享内存是**跨 worker 共享**的,所以: + +``` +worker 1 恢复全部键(共享内存是空的,全部「不存在」) +worker 2 再来一遍 → 键已存在 → 全部跳过 +``` + +### put-if-absent 带来的三个性质 + +1. **重启后可全量恢复**:共享内存是空的 → 所有键都「不存在」→ 逐个写回。 +2. **多 worker 天然幂等**:第二个 worker 起跳过,**不会把计数恢复成 N 倍**。 +3. **不打死新数据**:若恢复进行时已有新请求把某个键写活 → **不覆盖**。 + 宁可少恢复一条,也不把刚产生的真实计数抹掉。 + +### 其它规则 + +- **过期键(`exp <= now`)不恢复**:日桶 90 天保留期不能因为一次重启被续命。 + (落盘侧同样跳过过期键,两侧口径一致。) +- **版本不符不恢复**:`snap.version != STATS_SNAPSHOT_VERSION` → 只 `log_err`,宁可从零开始, + 也不把语义不明的旧数据灌进共享内存。 +- **解析失败改名留档**:文件改成 `llm-stats.json.bad` 再放弃本次恢复。 + 否则第一个请求到点就会用「空共享内存」覆盖掉这份文件,把唯一的现场抹掉、连查都没得查。 +- **任何异常都只降级**:统计与审计都是旁路,绝不能让 worker 起不来。 + +### 恢复结果的可见性(`spr:last`) + +恢复结果(时刻 / 恢复键数 / 快照键数)**发布到共享内存** `spr:last`, +而不是放进程内静态量: + +- `init_process` 是**每 worker 跑一次**,只有第一个 worker 真的在写键; +- 用静态量的话,`/api/admin/stats/persist` 落到哪个 worker 就报哪个数 + —— 运维看到的是**随机值**; +- 发布规则:`restored == 0` 的 worker **不写**(它只是「来晚了」的观察者, + 用 0 覆盖真实结果等于把这次恢复从记录里抹掉);已有记录时**累加 + `max(total)`** + (两个 worker 的 `init_process` 可能重叠、各恢复一半,累加才拼得出完整结果)。 + +--- + +## 四、什么被持久化,什么不被 + +### 持久化(`PREFIXES` 白名单,10 个) + +| 前缀 | 含义 | +|---|---| +| `ust:` | 账号维度请求数 | +| `ums:` | 账号 × 上游 请求数 | +| `utt:` | 账号维度 token | +| `utms:` | 账号 × 上游 token | +| `ud:` | 全局日桶(趋势图总览) | +| `udu:` | 按账号日桶 | +| `uds:` | 按上游(API 组)日桶 | +| `uda:` | 按上游账号日桶(「各 Key 负载」) | +| `uex:` | 账号额度耗尽次数日桶 | +| `uh:` | 上游健康展示缓存 | + +### 刻意不持久化 + +| 键 | 理由 | +|---|---| +| `up:` / `upa:` / `upe:` / `ax:` / `ukey:` / `sub:` | **各自有数据文件**(`data/*.json`),重启由 `reload_shm` 装载。再存一份会出现**两个真源**——「文件是新的、快照是旧的」时互相覆盖,属于自找的故障 | +| `ukb:` | 用户 Key → 上游账号粘性,设计上就是**重启即重绑** | +| `spr:` | 本模块自己的「上次恢复」记录。恢复过程的元信息、不是统计量,持久化它只会自我引用 | +| `st:` / `rl:` / `fail:` / `sess:` | 内核状态(配额 / 限流 / 登录会话)。语义上重启清零**更安全**(多送一点额度好过把用户锁死),且不由本插件代管 | + +> ⚠️ 新增统计类键前缀时,**必须同步 `stats_persist::PREFIXES`**,否则该维度发版即清零—— +> 而且不会报错,只会在发版后表现为「这一列从 0 开始」。 + +--- + +## 五、文件格式 + +```json +{ + "version": 1, + "saved_at": 1789384321, + "saved_at_text": "2026-09-14 19:12:01", + "keys": { + "ust:alice": "0:3:3:1789384321\u001f0", + "ud:0": "12:3456:789\u001f0" + } +} +``` + +- 键 = **完整键名**(前缀 + name)。 +- 值 = `\u001f`,分隔符是共享内存同款 `VAL_SEP`(0x1f), + 解析用 `rfind`(`exp` 是 ASCII 数字串、不含分隔符,所以**最后一个**才是真边界)—— + 与内核 `split_value` 同源。 +- 整份文件覆盖写,**不做历史轮转**:它只是「当前共享内存的近似快照」, + 不是时间序列存档。要看历史趋势请用日桶(`ud:` / `udu:` / `uds:`,TTL 90 天,本身也在快照里)。 + +### 容量 + +键数 ≈ 账号数 × slot 数 + 90 天 × (1 + 账号数 + slot 数 + 账号 × 上游数)。 +十来个账号的规模下是**几十 KB**,写一次几毫秒——与「每请求都写」的量级完全不同。 +(对比:1.0.17 及更早的对话审计每请求复制 700 KB+ 请求体,见 `AUDIT_LOG.md`。) + +--- + +## 六、配置:`ipass_stats_persist <秒>` + +| 值 | 行为 | +|---|---| +| 默认(指令**不写**) | 60 秒 | +| `0` | 关闭周期落盘,**只靠 worker 退出钩子**这一次 | + +```nginx +http { + ipass_stats_persist 0; # 例:完全关掉周期落盘 +} +``` + +**生产 `conf/nginx.conf` 刻意不写这条指令**:老镜像不认识它会起不来 +(unknown directive → 直接启动失败),而默认值 60 秒已经够用。 +只有当确实需要调整间隔时才加,且要保证**镜像里已经有这条指令**。 + +> 测试套件把它压到 `1` 秒(`tests/llm/nginx.conf.in`), +> 这样「周期落盘已产出快照」这条断言才能确定性地验证。 + +--- + +## 七、管理接口 + +| 接口 | 作用 | +|---|---| +| `GET /api/admin/stats/persist` | 快照文件状态 + 共享内存现状 + 上次恢复结果(只读) | +| `POST /api/admin/stats/dump` | **立刻落盘一次**(不看间隔),返回写入键数 | + +`GET /api/admin/stats/persist` 响应: + +```json +{ + "code": 0, "msg": "ok", + "data": { + "file": "/usr/local/nginx/data/llm-stats.json", + "file_exists": true, + "file_bytes": 20480, + "file_keys": 137, + "saved_at": 1789384321, + "saved_at_text": "2026-09-14 19:12:01", + "live_keys": 137, + "interval_secs": 60, + "last_dump_at": 1789384321, + "last_dump_text": "2026-09-14 19:12:01", + "restored_at": 1789384100, + "restored_keys": 137, + "restore_total": 137 + } +} +``` + +字段怎么读: + +| 字段 | 含义 | 异常时的含义 | +|---|---|---| +| `file_keys` | 快照里有多少键 | 长期远小于 `live_keys` → 周期落盘没跑起来(查 `interval_secs` / `last_dump_at`) | +| `live_keys` | 共享内存里当前有多少(已剔除过期) | 与 `file_keys` 长期接近 = 落盘正常 | +| `restored_keys` / `restore_total` | 上次启动**恢复了多少** / 快照里**有多少** | 两者不等 → 有键被跳过(已过期 / 已被新请求写活 / 不在白名单) | +| `restored_at` | 上次恢复时刻,`0` = 本进程没发生过恢复 | 刚发版后应等于启动时刻 | + +> 注意 `restored_*` 来自共享内存记录(见 §三),**所有 worker 报同一份**, +> 不会因为请求落到哪个 worker 而变。 + +--- + +## 八、运维 Runbook + +### 确认功能生效(发版前) + +```bash +# 1) 有没有快照、键数是否与内存接近 +curl -s -b /tmp/cookie.jar http://:18099/api/admin/stats/persist | python3 -m json.tool + +# 2) 强制落一次,看返回值 +curl -s -b /tmp/cookie.jar -X POST http://:18099/api/admin/stats/dump + +# 3) 宿主机上看文件确实存在且在变大 +ls -l /llm-stats.json +``` + +### 发版前后对照(验证「不再清零」) + +```bash +# 发版前:记下 alice 的累计用量与趋势总数 +curl -s -b /tmp/cookie.jar http://:18099/api/admin/usage | grep -o '"username": *"alice".*"total":[0-9]*' +curl -s -b /tmp/cookie.jar 'http://:18099/api/admin/trend?days=7' + +# 发版:bash deploy/agent.sh release && bash deploy/agent.sh verify + +# 发版后:重新登录(登录会话在共享内存里,重启即失效),比对 +# - 用量累计数应**持平**(不是回到 0) +# - 趋势最近 7 天的柱子应**仍在** +# - /api/admin/stats/persist 的 restored_keys 应 > 0 且 == restore_total +``` + +### 常见故障 + +| 现象 | 原因 | 处理 | +|---|---|---| +| 发版后统计仍然清零 | `data/llm-stats.json` 不存在或为空 | 检查 `data/` 挂载是否可写(容器内 `/usr/local/nginx/data`,需对 worker 可写);查 error log 有无 `[stats]` 前缀的报错 | +| `restored_keys == 0` 但 `file_keys > 0` | 快照版本不符 / 解析失败(已改名 `.bad`)/ 所有键都过期 | 看 error log 的 `[stats]` 行;`.bad` 文件留着可人工核对 | +| 磁盘上出现 `llm-stats.json.bad` | 上一次启动解析失败 | 保留排查(结构被手改过 / 写到一半断电);确认当前快照正常后可删 | +| 统计「丢了几十秒」 | `SIGKILL` / OOM(绕过了退出钩子) | 属预期,最多丢一个 `interval_secs`;要更小就把间隔调小 | +| 某些维度清零、其它维度不丢 | 新加的统计前缀**漏加进 `PREFIXES`** | 补 `stats_persist.rs` 的白名单(见 §四 末尾的警告) | + +--- + +## 九、测试覆盖 + +`tests/llm/e2e.sh` 的【15】段(刻意放在**最后**:它要停掉再拉起 nginx, +之后的断言环境会变——会话丢、共享内存重建): + +1. 落盘间隔被压到 1 秒(读 `/api/admin/stats/persist` 的 `interval_secs`) +2. 跑几笔请求 + `sleep 1.5` → 快照文件已产出 +3. 快照含 `ust:alice`、含 `ud:` 日桶 +4. 快照**不含**凭据类配置键(`up:` / `upa:` / `upe:` / `ax:` / `ukey:` / `sub:`) +5. `nginx -s quit`(等价于生产 `docker stop`)→ 重新拉起 +6. 重新登录后:`restored_keys > 0`、`restored_keys == restore_total` +7. alice 累计用量**不变**;再打一笔后 = 原值 + 1(证明是「接着长」而不是从 0 开始) +8. 趋势日桶仍在;`uda:` 账号级负载仍可读 + +`tests/run.sh` 在跑套件前会把上一轮的 `tests/.run/llm/data/llm-stats.json` +**挪到** `tests/.run/llm/stale/llm-stats..json`(留档,不删)—— +清不掉快照的话,上一轮的 `ust:` / `ud:` / `uh:` 会被启动时的 `restore()` +灌进本轮,症状极具欺骗性:carol 用量期望 2 变 6、「上游健康初始状态」期望 +`unknown` 变 `ok`,看起来像统计功能有 bug,实际是测试间的状态泄漏。 + +> ⚠️ **必须用 `mv`,不能用 `rm` / python `rmtree`**:本机装了 `safe-delete` 钩子 —— +> 同一个 agent turn 里累计删除超过 **50** 个文件后,后续所有删除都被**静默拦掉** +> (error log 里可见 `SAFE_DELETE_BULK_CONFIRM_REQUIRED`)。 +> `mv` 是 rename、不算删除,在沙箱下稳定生效。 +> +> 同理,`tests/.run/llm/audit/` 里的历史残留**不做清理**:「不再生成请求体副本」 +> 那条断言改成校验**本轮增量 = 0**,从而对历史残留免疫(见 `AUDIT_LOG.md` §七)。 +> 1.0.17 及更早写下的上千个 `*.json`(每个 700 KB+)需要时**手动清一次**。 + +--- + +## 十、边界与已知限制 + +- **不是备份**:快照只有一份、覆盖写。要长期归档请自行拷走 `data/llm-stats.json`。 +- **不跨版本迁移**:`version` 变了就不恢复(宁可从零开始)。升级时若希望保留统计, + 需同步 bump `STATS_SNAPSHOT_VERSION` 并写转换逻辑(当前不需要)。 +- **多 worker 落盘是「白写几次」**:`DUMPING` 单飞标记是**每 worker** 的静态量, + 跨 worker 不互斥。代价只是几毫秒重复 IO,`rename` 的原子性保证读侧永远看到完整文件。 +- **不影响鉴权与配额**:配额(`st:`)走的是另一套键,重启清零是**有意的** + (见 §四)。所以「发版后配额重置」不是 bug。 diff --git a/readme.md b/readme.md index 2e63117..bf43f45 100755 --- a/readme.md +++ b/readme.md @@ -1136,6 +1136,40 @@ GET /apix/search?q=nginx Authorization: Bearer sk_<本网关签 `admin.css` + `upstreams.js` 渲染路径做无头浏览器断言(比例条成比例、条块数、悬停日期、无溢出)。 - 专章:`docs/llm/MULTI_ACCOUNT_ROUTING.md`(数据模型 / 路由 / 冷却数学 / shm 布局 / 负载统计)。 +- **2026-09-14(续16)统计落盘/恢复 + 审计口径收口(`ipass-1.0.18`,未发版)** + - **起因**:发版后管理台「用量」与「趋势」从 0 重新长起来。根因是这两类数据 + (`ust:`/`ums:`/`utt:`/`utms:`/`ud:`/`udu:`/`uds:`/`uda:`/`uex:`/`uh:`)**只活在共享内存**, + 进程退出即消失;而上游/账号/域名/用户都有 `data/*.json` 所以不丢 —— 这个反差是定位关键。 + - **方案(不引入数据库)**:一个 JSON 快照 `data/llm-stats.json`(与 `users.json` 同级, + 落在宿主卷上)。**两个落盘点互补**:worker 退出钩子(`gateway::exit_process`, + 覆盖发版 / `docker stop` / `nginx -s quit`,**零丢失**;镜像已声明 `STOPSIGNAL SIGQUIT`) + + 记账后按间隔节流落盘(默认 60 秒,覆盖 `SIGKILL`/OOM/断电)。 + 启动时 `init_process` 恢复,**put-if-absent** → 多 worker 天然幂等、绝不把计数恢复成 N 倍, + 也不会覆盖恢复期间新产生的数据;过期键两侧一致地跳过(90 天日桶不因重启续命)。 + - **刻意不持久化**:配置类 `up:`/`upa:`/`upe:`/`ax:`/`ukey:`/`sub:`(各有数据文件, + 存两份会出现两个真源互相覆盖)、`ukb:`(粘性,设计上重启即重绑)、内核 `st:`/`rl:`/`fail:`/`sess:` + (**重启清零是有意的**,多送一点额度好过把用户锁死)。⚠️ **新增统计前缀必须同步白名单**,否则该维度发版即清零且**不报错**。 + - **接口/配置**:`GET /api/admin/stats/persist`(文件状态 + 内存现状 + 上次恢复结果)、 + `POST /api/admin/stats/dump`(强制落一次);指令 `ipass_stats_persist <秒>`(0=只留退出钩子), + 生产 conf **刻意不写**(用默认 60,避免旧镜像 unknown directive 起不来)。 + - **顺带修的真 bug:审计 `excerpt` 双重编码**。1.0.18 首版把手工转义(含两侧引号)的结果 + 塞进 `json!()` 被二次转义,落盘成 `"excerpt":"\"{\\\"model\\\"…"`,解码后多一层引号, + 任何按前缀匹配的消费方都解析不到 → 改为只做 UTF-8 解码、转义交给序列化器。 + 另确认 `body_hash` 必须是**全文** SHA256(只哈希前 100 字节会因所有请求开头相同而**全量碰撞**)。 + - **「上次恢复」计数不再放进程内静态量**:`init_process` 每 worker 跑一次、只有第一个 worker 真在写键, + 否则接口落到哪个 worker 就报哪个数(运维看到随机值)→ 发布到 shm `spr:last` + (`restored==0` 不写、已有则**累加** + `max(total)`,覆盖 worker 间恢复重叠)。 + - 回归 **298 条全绿**(网关 102 + LLM 196;新增【15】段 13 条:间隔压 1 秒 → 快照产出与白名单 → + `nginx -s quit` → 重启后恢复键数 > 0 且 == 快照键数、alice 累计用量不变、再打一笔为 **+1** + 而非从 0 重来、趋势日桶仍在、`uda:` 账号负载仍可读)。 + - 测试踩坑(**已写进 `CLAUDE.md`**):本机 `safe-delete` 钩子在「同一 turn 累计删除 > 50 个文件」后 + 会**静默拦掉**后续所有删除(`rm -rf` 与 python `rmtree` 同样被拦),导致清不掉上一轮的 + `llm-stats.json` → 被 `restore()` 灌进本轮(carol 用量 2 变 6、上游健康 `unknown` 变 `ok`), + **看起来像新功能有 bug,实为测试间状态泄漏**。修法:复位用 `mv`(rename 不算删除); + 审计目录残留则改为断言**本轮增量 = 0**,对历史残留免疫。 + - 新文档:`docs/llm/STATS_PERSISTENCE.md`(含 runbook)、`docs/llm/AUDIT_LOG.md` + (两者此前被代码注释与 `Dockerfile` 引用但文件并不存在)。 + - **2026-09-14(续15)auth 规范化 + 排障子命令(`ipass-1.0.15`)** - **根因**:表单 placeholder 写 `sk-...`,用户照着填了**裸 key**(无 `Bearer `), 转发时原样发 → 上游回 1004。`agent.sh upstreams` 一打就看出来:deepseek 掩码是 diff --git a/rust/crates/ipass-core/src/util.rs b/rust/crates/ipass-core/src/util.rs index 22ee3cc..3adbba2 100644 --- a/rust/crates/ipass-core/src/util.rs +++ b/rust/crates/ipass-core/src/util.rs @@ -41,6 +41,13 @@ pub fn log_notice(msg: &str) { log_at(nginx_sys::NGX_LOG_NOTICE as usize, msg); } +/// INFO 级日志:只在 error_log 配了 `info` 时才落盘(生产 `conf/nginx.conf` 是 `info`)。 +/// 用于「周期性但需要留痕」的动作(如统计落盘),NOTICE 会太吵、ERR 又会让正常的 +/// 例行动作看起来像故障。 +pub fn log_info(msg: &str) { + log_at(nginx_sys::NGX_LOG_INFO as usize, msg); +} + // =========================================================================== // 时间 // =========================================================================== @@ -248,6 +255,33 @@ pub fn sha256_hex(data: &[u8]) -> String { to_hex(&h.finalize()) } +/// 流式 SHA256:分块喂入,最后取 hex。 +/// +/// 用于「大文件只想拿指纹、不想整份读进内存」的场景(如审计算请求体哈希)。 +/// 与 `sha256_hex` 对同一份数据必然产出相同结果(同算法、同 hex 编码)。 +pub struct Sha256Stream(Sha256); + +impl Sha256Stream { + pub fn new() -> Self { + Self(Sha256::new()) + } + + pub fn update(&mut self, chunk: &[u8]) { + self.0.update(chunk); + } + + /// 收尾并返回 hex(64 字符)。消费 self,避免误续用已 finalize 的状态。 + pub fn finish_hex(self) -> String { + to_hex(&self.0.finalize()) + } +} + +impl Default for Sha256Stream { + fn default() -> Self { + Self::new() + } +} + /// 迭代加盐哈希,降低撞库速度。 /// /// 算法(与旧版 `util.hash_password` 完全一致): diff --git a/rust/crates/plugin-llm/src/api.rs b/rust/crates/plugin-llm/src/api.rs index 75fcba7..f48b2fc 100644 --- a/rust/crates/plugin-llm/src/api.rs +++ b/rust/crates/plugin-llm/src/api.rs @@ -16,6 +16,7 @@ use ipass_core::{http, util}; use crate::llm; use crate::stats; +use crate::stats_persist; use crate::upstreams; // =========================================================================== @@ -33,6 +34,8 @@ fn route(method: &str, uri: &str) -> Option<(Guard, Handler)> { ("POST", "/api/admin/upstreams/test") => (Guard::Admin, h_admin_upstream_test), ("POST", "/api/admin/upstreams/delete") => (Guard::Admin, h_admin_upstream_delete), ("GET", "/api/admin/usage") => (Guard::Admin, h_admin_usage), + ("GET", "/api/admin/stats/persist") => (Guard::Admin, h_admin_stats_persist), + ("POST", "/api/admin/stats/dump") => (Guard::Admin, h_admin_stats_dump), ("GET", "/api/v1/models") => (Guard::User, h_my_models), ("GET", "/api/v1/usage") => (Guard::User, h_my_usage), ("GET", "/api/v1/upstreams") => (Guard::User, h_my_upstreams), @@ -369,3 +372,30 @@ fn h_my_usage(r: *mut ngx_http_request_t, actor: Actor) -> Status { "ok", ) } + +// =========================================================================== +// 管理员:统计落盘 +// =========================================================================== +// +// 用量/趋势只活在共享内存里,进程退出即清零。落盘/恢复见 +// `crate::stats_persist` 模块注释与 docs/llm/STATS_PERSISTENCE.md。 +// 这两个端点不参与任何转发逻辑,纯粹是「让运维看得见 + 手动兜一次」。 + +/// `GET /api/admin/stats/persist`:快照文件状态 + 当前共享内存键数。 +/// +/// 排障用法:发版后立刻查一次,`restored_keys` 应当等于 `file_keys`; +/// 若 `live_keys` 长期远大于 `file_keys`(且 `saved_at` 很旧),说明周期落盘没跑。 +fn h_admin_stats_persist(r: *mut ngx_http_request_t, _actor: Actor) -> Status { + http::ok(r, stats_persist::status(), "ok") +} + +/// `POST /api/admin/stats/dump`:立刻落盘一次(不看间隔)。 +/// +/// 计划内维护前手动兜一次用;正常情况下不需要 —— 发版走 `exit_process` 钩子 +/// 已经是零丢失,这个端点只是给个「我说了算」的把手。 +fn h_admin_stats_dump(r: *mut ngx_http_request_t, _actor: Actor) -> Status { + match stats_persist::dump_now("admin") { + Ok(n) => http::ok(r, json!({ "keys": n }), "已落盘"), + Err(e) => http::fail(r, HTTPStatus::INTERNAL_SERVER_ERROR, &e), + } +} diff --git a/rust/crates/plugin-llm/src/config.rs b/rust/crates/plugin-llm/src/config.rs index 1ff77b6..465ef51 100644 --- a/rust/crates/plugin-llm/src/config.rs +++ b/rust/crates/plugin-llm/src/config.rs @@ -141,7 +141,55 @@ pub const TREND_DAYS_MAX: i64 = 90; /// 审计目录名:默认挂在 data 目录的**父目录**下(即与 data 同级),可被 /// `ipass_audit_dir` 指令整体覆盖 pub const AUDIT_DIR_NAME: &str = "audit"; -/// 审计总量上限(字节):超过即按日期目录从旧到新整目录删除,直到回落限内 -pub const AUDIT_MAX_BYTES: u64 = 10 * 1024 * 1024 * 1024; +/// 审计总量上限(字节):超过即按日期目录从旧到新整目录删除,直到回落限内。 +/// **1.0.18 起默认 1 GB**(旧 10 GB)——审计从「全量请求体」改为「meta + 100 字节摘要」, +/// 单条 ~400 B,1 GB 够撑约 250 万条(约 7 天 @ QPS 4);旧 10 GB 在新口径下等于 +/// 「永远不会被 purge」的反向证据,留着只是误导容量判断。 +pub const AUDIT_MAX_BYTES: u64 = 1024 * 1024 * 1024; /// 容量巡检最小间隔(秒):巡检要扫整个审计树,节流避免高频 IO pub const AUDIT_PURGE_MIN_INTERVAL: i64 = 60; +/// 请求体摘录字节数(meta 同一行的 `excerpt` 字段):取 body 前 N 字节的 JSON 安全字符串。 +/// 100 字符覆盖:模型名 + 首条消息 role + 首句用户内容(短 query 整条保留)。 +/// 大 body(带 tools / 多轮 history)只看得到头,看不到尾 —— 这是设计取舍: +/// 复盘 90% 场景「当时用户问了啥 + 用了哪个模型」足够;想看全文就别存 audit, +/// 走 hot path 日志或实时抓包。 +pub const AUDIT_EXCERPT_BYTES: usize = 100; +/// `body_hash` 字段截断字节数(hex):完整 SHA256 64 字符太长,复盘只需要够用即可; +/// 16 hex = 64 bit 抗碰撞,远超 audit「识别同一请求」的需求。 +/// ⚠️ 哈希对象是**请求体全文**(流式喂入,不整份读进内存),不是 excerpt —— 只哈希 +/// 前 N 字节会因所有请求开头相同而全量碰撞。 +pub const AUDIT_HASH_HEX_BYTES: usize = 16; + +// =========================================================================== +// 统计落盘 / 恢复(docs/llm/STATS_PERSISTENCE.md) +// =========================================================================== + +/// 运行期统计的快照文件名(落在 `data/` 下,与其他状态文件同级)。 +/// +/// **不含任何凭据**(只有账号名 / slot 名 / 计数 / token 数),但仍在 `data/` 里 +/// ——`data/` 整体 gitignore,别把它单独挪到别处再误提交。 +pub const STATS_FILE_NAME: &str = "llm-stats.json"; + +/// 周期性落盘间隔(秒)。**默认 60**,可被 `ipass_stats_persist <秒>` 覆盖, +/// `0` = 关闭周期落盘(只靠 worker 退出钩子那一次)。 +/// +/// 取 60 的理由:单次落盘要扫 10 个前缀 + 序列化,量级是毫秒;60 秒一次对磁盘与 +/// 热路径都可忽略,而「最多丢 60 秒统计」远好于「丢全部历史」(1.0.18 之前的实际行为)。 +/// 真要保零丢失也不靠调小它 —— 靠 worker 退出钩子(见 `stats_persist` 模块注释)。 +pub const STATS_PERSIST_INTERVAL_DEFAULT: i64 = 60; + +/// 快照格式版本。将来改结构时用它做兼容判断(版本对不上就**不恢复**, +/// 宁可从零开始,也不要把语义不明的旧数据灌进共享内存)。 +pub const STATS_SNAPSHOT_VERSION: i64 = 1; + +/// 键前缀:统计落盘模块的「上次恢复」记录(键 = `spr:last`, +/// value = `<时刻> \x1f <恢复键数> \x1f <快照键数>`)。 +/// +/// **刻意不在 `stats_persist::PREFIXES` 白名单里** —— 它是恢复过程的元信息, +/// 不是统计量,被持久化只会自我引用。 +/// +/// 为什么要落共享内存而不是进程内静态量:`init_process` 是**每 worker 跑一次**, +/// 首个 worker 恢复完、后续 worker 因 put-if-absent 全部跳过,各自计数天然不同 +/// —— 管理接口落到哪个 worker 就报哪个数,运维看到的是随机值。放共享内存后 +/// 所有 worker 报同一份,`/api/admin/stats/persist` 才可信。 +pub const KEY_SPR_PREFIX: &[u8] = b"spr:"; diff --git a/rust/crates/plugin-llm/src/lib.rs b/rust/crates/plugin-llm/src/lib.rs index bfe82b0..ada91ce 100644 --- a/rust/crates/plugin-llm/src/lib.rs +++ b/rust/crates/plugin-llm/src/lib.rs @@ -2,7 +2,8 @@ //! //! 职责:`//...` → 上游转发决策、上游 CRUD、OpenAI 兼容模型发现、 //! `rl:`/`st:` 配额执行、token 计量(body filter 旁路)、用量统计与趋势、 -//! 对话审计落盘。数据文件 `data/llm-upstreams.json`(敏感级别等同 users.json)。 +//! 对话审计落盘、运行期统计落盘/恢复。数据文件 `data/llm-upstreams.json` +//! (敏感级别等同 users.json)与 `data/llm-stats.json`(统计快照,无凭据)。 //! //! ## 装配点(gateway) //! @@ -12,6 +13,11 @@ //! * `zone_load` —— 全量装载 `up:` 上游表 //! * `dispatch_api` —— 认领上游 / 用量类端点(趋势端点留 gateway,需三方名册) //! +//! ## 进程生命周期钩子(由 gateway 调用,不是插件自己的钩子) +//! +//! * `stats_persist::restore()` 在 `init_process` —— 重启后把统计快照灌回共享内存 +//! * `stats_persist::dump_now()` 在 `exit_process` —— 退出前落盘,发版不丢统计 +//! //! ## 与其他插件的关系 //! //! 下行鉴权与配额执行(`ukey:` / `rl:` / `st:`)在内核 `ipass_core::auth`; @@ -25,6 +31,7 @@ pub mod llm; pub mod llm_audit; pub mod models; pub mod stats; +pub mod stats_persist; pub mod store; pub mod upstreams; pub mod usage_filter; diff --git a/rust/crates/plugin-llm/src/llm_audit.rs b/rust/crates/plugin-llm/src/llm_audit.rs index 6e2ff5a..885df16 100644 --- a/rust/crates/plugin-llm/src/llm_audit.rs +++ b/rust/crates/plugin-llm/src/llm_audit.rs @@ -1,20 +1,28 @@ -//! LLM 对话审计:把每个**被转发**的 LLM 请求体落盘存档,供事后审计与用量复盘。 +//! LLM 对话审计:把每个**被转发**的 LLM 请求**元数据**落盘存档。 //! //! 设计要点(详见 docs/llm/AUDIT_LOG.md): //! * **捕获方式**:LLM location 开 `client_body_in_file_only clean`,nginx 自己把 -//! 请求体刷到临时文件;本模块在 **log 阶段**(临时文件此刻尚未被清理)把它 -//! 复制进审计目录。热路径零改动——access 阶段不读体、不碰内存缓冲, -//! SSE 流式透传不受任何影响。被拒请求(401/403/404/429)与本地应答 -//! (/v1/models)的 body 从未被读走 → 没有临时文件 → 天然不入档。 -//! * **目录**:`<审计根>/YYYY-MM-DD/<毫秒>_.json` + 每目录一份 `meta.jsonl`。 +//! 请求体刷到临时文件;本模块在 **log 阶段**单遍扫描该临时文件 —— **只保留前 N 字节** +//! 作为 `excerpt`,其余边读边喂 SHA256 后丢弃,产出 `body_hash`(全文指纹)与 +//! `body_bytes`(全文长度),然后追加一行到 `meta.jsonl`。 +//! **1.0.18 起不再复制完整 body 到 audit 目录** —— 旧版每请求 700 KB+(带 tools / +//! 多轮 history),QPS 10 一天 600 GB,10 GB 配额 24 分钟就触发 purge,复盘价值 +//! 也不大(前 100 字符就能秒判「用了哪个模型 + 用户问了啥」)。 +//! * **目录**:`<审计根>/YYYY-MM-DD/meta.jsonl`。不再有 `<毫秒>_.json` 子文件。 //! 审计根默认 = data 目录的兄弟目录 `audit/`(`ipass_audit_dir` 指令可覆盖)。 //! * **清理**:按容量触发(`AUDIT_MAX_BYTES`)——写入后节流巡检 //! (≥ `AUDIT_PURGE_MIN_INTERVAL` 秒一次、AtomicBool 单飞),超限时按日期 //! 目录**从旧到新整目录删除**;worker 启动时强制巡检一次(不依赖外部 cron)。 //! * **失败策略**:审计是旁路功能,任何失败只 `log_err`,绝不影响转发结果。 +//! +//! ## 1.0.18 行为变更 +//! +//! - 不再复制完整 body:单请求审计占用从 ~700 KB 降到 ~500 B(一行 meta),**降约 3 个数量级** +//! - meta 行新增三个字段:`excerpt`(body 前 100 字节,JSON 转义交给序列化器,**不双重编码**)、`body_hash`(**全文** SHA256 前 16 hex)、`body_bytes`(全文字节数) +//! - `AUDIT_MAX_BYTES` 默认从 10 GB 改为 1 GB(旧值在新口径下等于「永远不会 purge」) use std::fs; -use std::io::Write; +use std::io::{BufReader, Read, Write}; use std::path::PathBuf; use std::sync::Mutex; use std::sync::atomic::{AtomicBool, AtomicI64, Ordering}; @@ -67,7 +75,56 @@ pub fn startup() { purge(true); } -/// log 阶段捕获:复制 body 临时文件进审计目录 + 追加一行元数据。 +/// 把「body 前 N 字节」解成字符串,供 meta 行的 `excerpt` 字段使用。 +/// +/// **只做 UTF-8 安全解码,不做 JSON 转义** —— 引号 / 反斜杠 / 控制字符一律交给 +/// `json!()`(serde_json)统一转义。这里若自己再转义一遍就是**双重编码** +/// (1.0.18 第一版踩过:落盘成 `"excerpt":"\"{\\\"model\\\"...\""`,读出来多一层 +/// 引号,任何按前缀匹配的消费方都解析不到)。 +/// +/// 截断是按**字节**做的,可能切在多字节字符中间;`from_utf8_lossy` 会把残缺尾巴 +/// 换成 U+FFFD(合法 JSON 字符),绝不产出非法 UTF-8 让序列化失败。 +fn excerpt_text(bytes: &[u8]) -> String { + String::from_utf8_lossy(bytes).into_owned() +} + +/// 单遍扫描 body 临时文件:**只把前 N 字节留在内存**,其余边读边喂哈希后丢弃。 +/// +/// 返回 `(前 N 字节, 全量 SHA256 hex, 全量字节数)`。读失败返回空值(审计是旁路,失败不报错)。 +/// +/// 为什么扫全文而不是只读前 N 字节:`body_hash` 要当「同一请求」的指纹用, +/// 而所有 OpenAI/Anthropic 请求的前 100 字节都是同一个开头 +/// (`{"model":"…","messages":[{"role":`),只哈希前缀 = 全部碰撞,这一列就是废数据。 +/// 扫全文只是顺序 IO,不复制、不落盘,成本仍**低于** 1.0.17 的「读全文 + 写全文副本」。 +fn scan_body(path: &str, n: usize) -> (Vec, String, u64) { + let f = match fs::File::open(path) { + Ok(f) => f, + Err(_) => return (Vec::new(), String::new(), 0), + }; + let mut r = BufReader::new(f); + let mut prefix: Vec = Vec::with_capacity(n); + let mut hasher = util::Sha256Stream::new(); + let mut total: u64 = 0; + let mut buf = [0u8; 64 * 1024]; + loop { + match r.read(&mut buf) { + Ok(0) => break, + Ok(k) => { + if prefix.len() < n { + let need = (n - prefix.len()).min(k); + prefix.extend_from_slice(&buf[..need]); + } + hasher.update(&buf[..k]); + total += k as u64; + } + Err(_) => break, + } + } + (prefix, hasher.finish_hex(), total) +} + +/// log 阶段捕获:单遍扫描 body 临时文件,取**前 N 字节**作为 excerpt、全文算 SHA256、 +/// 追加一行元数据。**1.0.18 起不再复制完整 body**。 /// /// `tin` / `tout` 是 body filter 旁路抓到的 token 数(`llm_usage` 模块提供), /// 0 = 上游没给 usage(如 OpenAI 流式未开 include_usage)。 @@ -97,19 +154,16 @@ pub unsafe fn capture(r: *mut ngx_http_request_t, username: &str, slot: &str, ti return; } - let fname = format!("{}_{}.json", ts * 1000, util::rand_digits(6)); - let dst = dir.join(&fname); - // 复制(不是 rename):nginx 在请求池销毁时还要 unlink 临时文件, - // 改名会让它打出 unlink 失败告警;多一次拷贝换零噪音。 - if let Err(e) = fs::copy(&src, &dst) { - util::log_err(&format!("[audit] 复制请求体失败 {src}: {e}")); - return; - } - let bytes = fs::metadata(&dst).map(|m| m.len()).unwrap_or(0); + // 单遍扫描:取前 N 字节作为 excerpt,全文算 SHA256(前 16 hex)。body 可能几 MB, + // 但只有前 N 字节留在内存,且**不再复制完整文件、不再写 `<毫秒>_.json` 子文件**。 + let (prefix, full_hash, body_bytes) = scan_body(&src, config::AUDIT_EXCERPT_BYTES); + let excerpt = excerpt_text(&prefix); + let hash_hex = &full_hash[..config::AUDIT_HASH_HEX_BYTES.min(full_hash.len())]; let status = (*r).headers_out.status as u64; let user = if username.is_empty() { "-" } else { username }; let up = if slot.is_empty() { "-" } else { slot }; + let line = json!({ "ts": ts, "time": util::fmt_time(ts), @@ -118,8 +172,9 @@ pub unsafe fn capture(r: *mut ngx_http_request_t, username: &str, slot: &str, ti "status": status, "tin": tin, "tout": tout, - "file": format!("{day}/{fname}"), - "bytes": bytes, + "excerpt": excerpt, + "body_hash": hash_hex, + "body_bytes": body_bytes, }); match fs::OpenOptions::new() .create(true) diff --git a/rust/crates/plugin-llm/src/stats.rs b/rust/crates/plugin-llm/src/stats.rs index 43b9358..1ca03b1 100644 --- a/rust/crates/plugin-llm/src/stats.rs +++ b/rust/crates/plugin-llm/src/stats.rs @@ -73,6 +73,11 @@ pub fn record(username: &str, slot: &str, now: i64) { usage::bump_day(KEY_UDAY_PREFIX, &day.to_string(), &delta, TREND_KEEP_SECS); usage::bump_day(KEY_UDAY_USER_PREFIX, &format!("{username}:{day}"), &delta, TREND_KEEP_SECS); usage::bump_day(KEY_UDAY_SLOT_PREFIX, &format!("{slot}:{day}"), &delta, TREND_KEEP_SECS); + + // 顺手看一眼要不要把统计落盘(默认 60 秒一次,间隔内只是一次原子比较)。 + // 挂在这里而不是各调用点,是因为本函数是 LLM 与 apix **两方唯一的记账入口** + // (apix 复用同一套统计,slot 带 `api/` 前缀)——以后再加一个租户也不会漏。 + crate::stats_persist::maybe_dump(); } /// 累加一次真实 token 消耗(来源:body filter 从上游响应抓到的 usage)。 diff --git a/rust/crates/plugin-llm/src/stats_persist.rs b/rust/crates/plugin-llm/src/stats_persist.rs new file mode 100644 index 0000000..dbae24c --- /dev/null +++ b/rust/crates/plugin-llm/src/stats_persist.rs @@ -0,0 +1,407 @@ +//! 运行期统计的**落盘 / 恢复**:让用量统计与趋势图熬过一次重启。 +//! +//! ## 为什么需要它(1.0.18 之前的实际故障) +//! +//! 共享内存是 nginx 每进程启动时 `mmap` 出来的匿名区,**进程退出即消失**。 +//! 而用量统计(`ust:`/`ums:`/`utt:`/`utms:`/`ud:`/`udu:`/`uds:`/`uda:`/`uex:`) +//! 全部只活在共享内存里 —— 于是「每次发版 = 统计与趋势清零」, +//! 用量页与趋势图在发版后从 0 重新长起来。 +//! +//! 不引入数据库(项目红线),做法就是**一个 JSON 快照**,与 +//! `users.json`/`llm-upstreams.json` 同级落在 `data/` 下;`data/` 是宿主挂载卷, +//! 容器重建也不丢。 +//! +//! ## 两个落盘点(互补,不是二选一) +//! +//! | 触发 | 时机 | 覆盖场景 | +//! | --- | --- | --- | +//! | **worker 退出钩子** | `exit_process`(gateway 注册) | 发版 / `docker stop` / `nginx -s quit` ——**零丢失** | +//! | **周期性节流落盘** | log 阶段记账后,默认 60 秒一次 | SIGKILL / OOM / 断电 —— 最多丢一个周期 | +//! +//! 退出钩子是主力:`docker stop` 发的是镜像里声明的 `STOPSIGNAL=SIGQUIT` +//! (优雅停机),`SIGTERM` 也走同一条 worker 退出路径,两者都会调到 `exit_process`。 +//! 只有 `SIGKILL` 绕过它,那由周期落盘兜住。 +//! +//! ## 恢复语义:**只在键不存在时写入**(put-if-absent) +//! +//! 三个性质一次拿到: +//! * 重启后共享内存是空的 → 所有键都「不存在」→ 全量恢复; +//! * 多 worker 各跑一遍 `init_process` → 第二个起键已存在 → 跳过,**天然幂等**, +//! 不会把计数恢复成 N 倍; +//! * 恢复期间若有新请求已经把某个键写活 → **不覆盖**,宁可少恢复一条, +//! 也不打死刚产生的新数据。 +//! +//! 已过期(`exp <= now`)的键不恢复:日桶的 90 天保留期不能因为一次重启被续命。 +//! +//! 恢复结果(恢复了多少 / 快照里有多少)**发布到共享内存**(`spr:last`), +//! 而不是放进程内静态量:`init_process` 每 worker 跑一次,只有第一个 worker +//! 真的在写键,其余全部跳过 —— 用静态量的话 `/api/admin/stats/persist` 落到哪个 +//! worker 就报哪个数,运维看到的是随机值。 +//! +//! ## 刻意**不**持久化的东西 +//! +//! * **配置类** `up:` / `upa:` / `upe:` / `ax:` / `ukey:` / `sub:` —— 它们各自有 +//! 数据文件(`data/*.json`),重启时由 `reload_shm` 装载。再存一份会出现两个真源, +//! 「文件是新的、快照是旧的」时互相覆盖,属于自找的故障。 +//! * **`ukb:`**(用户 key → 上游账号粘性)—— 设计上就是重启即重绑(见常量注释)。 +//! * **`spr:`**(本模块自己的「上次恢复」记录)—— 恢复过程的元信息,不是统计量, +//! 持久化它只会自我引用。它**只在共享内存里**,为的是让多 worker 报同一份结果。 +//! * **内核的** `st:`(配额)/ `rl:`(限流)/ `fail:` / `sess:` —— 语义上重启清零更安全 +//! (多送一点额度,好过把用户锁死),且属内核状态,不由本插件代管。 +//! +//! ## 容量 +//! +//! 一个键一行;键数 = 账号数 × slot 数 + 90 天 × (1 + 账号数 + slot 数 + 账号 × 上游数)。 +//! 十来个账号的规模下是几十 KB,写好一次几毫秒 —— 与「每请求都写」的量级完全不同。 +//! 详细口径与运维见 `docs/llm/STATS_PERSISTENCE.md`。 + +use std::collections::BTreeMap; +use std::path::PathBuf; +use std::sync::atomic::{AtomicBool, AtomicI64, Ordering}; + +use serde::{Deserialize, Serialize}; +use serde_json::{Value, json}; + +use ipass_core::{state, store, util}; + +use crate::config::{ + KEY_SPR_PREFIX, KEY_UDAY_ACCT_PREFIX, KEY_UDAY_PREFIX, KEY_UDAY_SLOT_PREFIX, + KEY_UDAY_USER_PREFIX, KEY_UEX_PREFIX, KEY_UH_PREFIX, KEY_UMS_PREFIX, KEY_UTMS_PREFIX, + KEY_UST_PREFIX, KEY_UTT_PREFIX, STATS_FILE_NAME, STATS_PERSIST_INTERVAL_DEFAULT, + STATS_SNAPSHOT_VERSION, +}; + +/// 参与持久化的共享内存前缀(一律以 `:` 结尾,且 `:` 不出现在前缀内部)。 +/// +/// 顺序无关,但保持一致(状态接口按此顺序统计 key 数)。 +/// 排除项的理由见模块注释「刻意不持久化的东西」。 +const PREFIXES: &[&[u8]] = &[ + KEY_UST_PREFIX, // 账号维度请求数 + KEY_UMS_PREFIX, // 账号 × 上游 请求数 + KEY_UTT_PREFIX, // 账号维度 token + KEY_UTMS_PREFIX, // 账号 × 上游 token + KEY_UDAY_PREFIX, // 全局日桶(趋势图总览) + KEY_UDAY_USER_PREFIX, // 按账号日桶 + KEY_UDAY_SLOT_PREFIX, // 按上游日桶 + KEY_UDAY_ACCT_PREFIX, // 按上游账号日桶(「各 Key 负载」) + KEY_UEX_PREFIX, // 账号额度耗尽次数日桶 + KEY_UH_PREFIX, // 上游健康展示缓存 +]; + +/// 快照值里的分隔符:`\x1f`。 +/// +/// 复用共享内存的 `VAL_SEP`(0x1f)而不是自定义一个:语义完全一样 +/// (payload 里不会出现该字节,因为内核写共享内存时就是这么切的), +/// 少一个常量少一处不一致。JSON 序列化时 serde 会把它转义成 `\u001f`。 +const SNAP_SEP: char = '\u{1f}'; + +/// 落盘间隔(秒);`0` = 关闭周期落盘(只保留退出钩子那一次)。 +/// 配置阶段由 `ipass_stats_persist` 设置一次,之后只读。 +static INTERVAL: AtomicI64 = AtomicI64::new(STATS_PERSIST_INTERVAL_DEFAULT); + +/// 本进程上次落盘时刻(秒);0 = 本进程还没落过盘 → 第一次调用就落。 +static LAST_DUMP_AT: AtomicI64 = AtomicI64::new(0); + +/// 单飞标记:并发请求同时到点,只放一个进去落盘。 +/// 注意这是**每 worker** 的静态量(跨 worker 不互斥)——多个 worker 同时落盘 +/// 只是白写几次同样的内容,`rename` 是原子的,不会有半个文件被人读到。 +static DUMPING: AtomicBool = AtomicBool::new(false); + +#[derive(Debug, Serialize, Deserialize)] +struct Snapshot { + version: i64, + saved_at: i64, + #[serde(default)] + saved_at_text: String, + #[serde(default)] + keys: BTreeMap, +} + +// =========================================================================== +// 配置 +// =========================================================================== + +/// `ipass_stats_persist <秒>`:周期落盘间隔。`0` = 只靠 worker 退出钩子。 +pub fn set_interval(secs: i64) { + INTERVAL.store(secs.max(0), Ordering::Relaxed); +} + +pub fn interval() -> i64 { + INTERVAL.load(Ordering::Relaxed) +} + +fn path() -> PathBuf { + store::path_in_data(STATS_FILE_NAME) +} + +// =========================================================================== +// 落盘 +// =========================================================================== + +/// 原子写:先写 `.tmp.` 再 `rename`。 +/// +/// 不复用 `store::write_json` 的原因:它用固定的 `.tmp`,多 worker 同时落盘 +/// 会互相踩临时文件(一个 rename 走了,另一个还在往里写同名文件)。 +/// 带 pid 后缀后各写各的,`rename` 本身是原子的,最后一个赢 —— 而内容本来就 +/// 只是「同一份共享内存的近似快照」,谁赢都对。 +/// +/// 也**不复用** `state::file_lock()`:那道锁是给「读文件→改→写文件」防丢失用的, +/// 本函数是纯覆盖写、不读旧值,拿锁只会在退出路径上增加卡死风险。 +fn write_atomic(path: &PathBuf, text: &str) -> Result<(), String> { + let tmp = PathBuf::from(format!("{}.tmp.{}", path.display(), std::process::id())); + std::fs::write(&tmp, text.as_bytes()).map_err(|e| { + let _ = std::fs::remove_file(&tmp); + format!("写入 {} 失败:{e}", tmp.display()) + })?; + std::fs::rename(&tmp, path).map_err(|e| { + let _ = std::fs::remove_file(&tmp); + format!("重命名到 {} 失败:{e}", path.display()) + }) +} + +/// 立刻落盘(不看间隔)。返回写入的键数。 +/// +/// `reason` 只进日志,用于事后分辨这次是谁触发的(`worker-exit` / `periodic` / `admin`)。 +pub fn dump_now(reason: &str) -> Result { + let now = util::now(); + let mut keys: BTreeMap = BTreeMap::new(); + + for p in PREFIXES { + // 前缀都是 ASCII 字面量,from_utf8 不会失败 + let Some(pfx) = core::str::from_utf8(p).ok() else { + continue; + }; + for (name, payload, exp) in state::iter_prefix_ex(p) { + // 已过期的键不带回:日桶的 90 天保留期不能靠重启续命 + if exp != 0 && exp <= now { + continue; + } + keys.insert(format!("{pfx}{name}"), format!("{payload}{SNAP_SEP}{exp}")); + } + } + + let snap = Snapshot { + version: STATS_SNAPSHOT_VERSION, + saved_at: now, + saved_at_text: util::fmt_time(now), + keys, + }; + let text = serde_json::to_string(&snap).map_err(|e| format!("序列化失败:{e}"))?; + let n = snap.keys.len(); + let p = path(); + write_atomic(&p, &text)?; + // 落盘成功才推进时间戳:失败时下次请求会立刻重试,而不是等满一个周期 + LAST_DUMP_AT.store(now, Ordering::Relaxed); + util::log_info(&format!( + "[stats] 落盘 {n} 键({} B,{reason})-> {}", + text.len(), + p.display() + )); + Ok(n) +} + +/// 按间隔节流落盘。**由记账路径每次请求调用一次**(见 `stats::record`)。 +/// +/// 间隔内直接返回:一次原子 load + 比较,热路径代价可忽略。 +/// 间隔设为 0 = 关闭周期落盘,此时这里退化为纯判断。 +pub fn maybe_dump() { + let iv = interval(); + if iv <= 0 { + return; + } + let now = util::now(); + let last = LAST_DUMP_AT.load(Ordering::Relaxed); + if last != 0 && now - last < iv { + return; + } + if DUMPING.swap(true, Ordering::Acquire) { + return; // 同 worker 内已有一个在落盘 + } + let r = dump_now("periodic"); + DUMPING.store(false, Ordering::Release); + if let Err(e) = r { + util::log_err(&format!("[stats] 周期落盘失败:{e}")); + } +} + +// =========================================================================== +// 恢复 +// =========================================================================== + +/// 拆快照值 `payload \x1f exp`。 +/// +/// 用 `rposition` 与内核 `split_value` 同款理由:`exp` 是 ASCII 数字串、 +/// 不含分隔符,所以**最后一个**分隔符才是真边界。 +fn split_value(v: &str) -> Option<(&str, i64)> { + let i = v.rfind(SNAP_SEP)?; + let exp = v[i + SNAP_SEP.len_utf8()..].parse::().ok()?; + Some((&v[..i], exp)) +} + +/// 把本次恢复结果发布到共享内存,供**所有** worker 一致地报告(见 `KEY_SPR_PREFIX` 注释)。 +/// +/// 两个要点: +/// * `restored == 0` 的 worker **不写** —— 它只是「来晚了、键已存在」的观察者, +/// 用自己的 0 覆盖真实结果就等于把这次恢复从记录里抹掉。 +/// * 已有记录时**累加**而不是覆盖:master 是顺序 fork 的,但两个 worker 的 +/// `init_process` 仍可能重叠,各恢复一半(put-if-absent 决定谁抢到哪批键)。 +/// 累加 + `max(total)` 才能拼出完整结果。 +fn publish_restore(at: i64, restored: usize, total: usize) { + if restored == 0 { + return; + } + let (prev_at, prev_ok, prev_total) = match state::get(KEY_SPR_PREFIX, b"last") { + Some((payload, _)) => parse_restore(&payload).unwrap_or((0, 0, 0)), + None => (0, 0, 0), + }; + let v = format!( + "{}{SNAP_SEP}{}{SNAP_SEP}{}", + at.max(prev_at), + prev_ok + restored, + prev_total.max(total) + ); + if !state::put(KEY_SPR_PREFIX, b"last", v.as_bytes(), 0) { + util::log_err("[stats] 发布恢复记录到共享内存失败(仅影响状态展示)"); + } +} + +/// 解析 `spr:last` 的 payload:`<时刻> \x1f <恢复键数> \x1f <快照键数>`。 +fn parse_restore(payload: &str) -> Option<(i64, usize, usize)> { + let mut it = payload.split(SNAP_SEP); + let at = it.next()?.parse::().ok()?; + let ok = it.next()?.parse::().ok()?; + let total = it.next()?.parse::().ok()?; + Some((at, ok, total)) +} + +/// 读回「上次恢复」记录:`(恢复时刻, 恢复键数, 快照键数)`。没有记录则全 0。 +fn read_restore() -> (i64, usize, usize) { + state::get(KEY_SPR_PREFIX, b"last") + .and_then(|(payload, _)| parse_restore(&payload)) + .unwrap_or((0, 0, 0)) +} + +/// worker 启动时把快照灌回共享内存。每个 worker 都会调一次(幂等,见模块注释)。 +/// +/// 任何异常都只降级:审计/统计都是旁路,绝不能让 worker 起不来。 +pub fn restore() { + let p = path(); + let text = match std::fs::read_to_string(&p) { + Ok(t) => t, + // 首次部署本来就没有快照,不算错误 + Err(e) if e.kind() == std::io::ErrorKind::NotFound => return, + Err(e) => { + util::log_err(&format!("[stats] 读取快照失败 {}:{e}", p.display())); + return; + } + }; + if text.trim().is_empty() { + return; + } + + let snap: Snapshot = match serde_json::from_str(&text) { + Ok(s) => s, + Err(e) => { + // 解析不了就**改名留档**再走:否则第一个请求到点就会用「空共享内存」 + // 覆盖掉这份文件,把唯一的副本抹掉,连现场都没得查。 + let bad = PathBuf::from(format!("{}.bad", p.display())); + let moved = std::fs::rename(&p, &bad); + util::log_err(&format!( + "[stats] 快照解析失败({e}),已{},本次不恢复统计", + match moved { + Ok(()) => format!("改名留档到 {}", bad.display()), + Err(me) => format!("尝试改名留档但失败({me})"), + } + )); + return; + } + }; + + if snap.version != STATS_SNAPSHOT_VERSION { + util::log_err(&format!( + "[stats] 快照版本 {} 与当前 {} 不符,不恢复(宁可从零开始)", + snap.version, STATS_SNAPSHOT_VERSION + )); + return; + } + + let now = util::now(); + let total = snap.keys.len(); + let mut restored = 0usize; + for (k, v) in &snap.keys { + let kb = k.as_bytes(); + let Some(pfx) = PREFIXES.iter().find(|p| kb.starts_with(p)) else { + continue; // 不在白名单(旧版本写的 / 手改的)→ 忽略 + }; + let Some((payload, exp)) = split_value(v) else { + continue; + }; + if exp != 0 && exp <= now { + continue; // 已过期 + } + let name = &kb[pfx.len()..]; + if name.is_empty() { + continue; + } + if state::get(pfx, name).is_some() { + continue; // 已被新请求写活 → 不覆盖 + } + if state::put(pfx, name, payload.as_bytes(), exp) { + restored += 1; + } + } + + publish_restore(now, restored, total); + util::log_notice(&format!( + "[stats] 已从快照恢复 {restored}/{total} 键({})", + p.display() + )); +} + +// =========================================================================== +// 状态(管理接口) +// =========================================================================== + +/// `/api/admin/stats/persist` 的响应体:快照文件状态 + 当前共享内存键数。 +/// +/// 「文件里有多少键」与「共享内存里现在有多少键」分开给:两者长期接近说明 +/// 落盘正常;文件远小于内存 = 周期落盘没跑(或刚重启还没到点)。 +pub fn status() -> Value { + let p = path(); + let text = std::fs::read_to_string(&p).ok(); + let (saved_at, saved_at_text, file_keys) = match text.as_deref().map(serde_json::from_str::) { + Some(Ok(s)) => (s.saved_at, s.saved_at_text, s.keys.len()), + _ => (0, String::new(), 0), + }; + let file_bytes = std::fs::metadata(&p).map(|m| m.len()).unwrap_or(0); + + let live: usize = PREFIXES + .iter() + .map(|pfx| { + let now = util::now(); + state::iter_prefix_ex(pfx) + .into_iter() + .filter(|(_, _, exp)| *exp == 0 || *exp > now) + .count() + }) + .sum(); + + let (restore_at, restore_ok, restore_total) = read_restore(); + let last_dump = LAST_DUMP_AT.load(Ordering::Relaxed); + + json!({ + "file": p.display().to_string(), + "file_exists": text.is_some(), + "file_bytes": file_bytes, + "file_keys": file_keys, + "saved_at": saved_at, + "saved_at_text": saved_at_text, + "live_keys": live, + "interval_secs": interval(), + "last_dump_at": last_dump, + "last_dump_text": if last_dump > 0 { util::fmt_time(last_dump) } else { String::new() }, + "restored_at": restore_at, + "restored_keys": restore_ok, + "restore_total": restore_total, + }) +} diff --git a/rust/gateway/src/lib.rs b/rust/gateway/src/lib.rs index 0897ccf..5168489 100644 --- a/rust/gateway/src/lib.rs +++ b/rust/gateway/src/lib.rs @@ -364,7 +364,7 @@ impl HttpModule for Module { } } -static mut NGX_HTTP_IPASS_COMMANDS: [ngx_command_t; 8] = [ +static mut NGX_HTTP_IPASS_COMMANDS: [ngx_command_t; 9] = [ ngx_command_t { name: ngx_string!("ipass_state"), type_: (NGX_HTTP_MAIN_CONF | NGX_CONF_TAKE2) as ngx_uint_t, @@ -389,6 +389,14 @@ static mut NGX_HTTP_IPASS_COMMANDS: [ngx_command_t; 8] = [ offset: 0, post: ptr::null_mut(), }, + ngx_command_t { + name: ngx_string!("ipass_stats_persist"), + type_: (NGX_HTTP_MAIN_CONF | NGX_CONF_TAKE1) as ngx_uint_t, + set: Some(set_stats_persist), + conf: NGX_HTTP_MAIN_CONF_OFFSET, + offset: 0, + post: ptr::null_mut(), + }, ngx_command_t { name: ngx_string!("ipass_proxy"), type_: (NGX_HTTP_LOC_CONF | NGX_CONF_TAKE1) as ngx_uint_t, @@ -446,6 +454,7 @@ pub static mut ngx_http_ipass_module: ngx_module_t = ngx_module_t { commands: unsafe { &raw mut NGX_HTTP_IPASS_COMMANDS[0] }, type_: NGX_HTTP_MODULE as _, init_process: Some(init_process), + exit_process: Some(exit_process), ..ngx_module_t::default() }; @@ -461,9 +470,30 @@ unsafe extern "C" fn init_process(_cycle: *mut ngx_cycle_t) -> ngx_int_t { } // 对话审计:确保目录存在 + 容量巡检一次(此后由请求写入节流触发) plugin_llm::llm_audit::startup(); + // 运行期统计:把上一次退出时落盘的快照灌回共享内存。 + // **放在每个 worker 里跑是刻意的**:恢复是「键不存在才写」(put-if-absent), + // 第一个 worker 恢复完,其余 worker 全部跳过 —— 天然幂等,不会把计数恢复成 N 倍。 + // 详见 plugin_llm::stats_persist 模块注释 / docs/llm/STATS_PERSISTENCE.md。 + plugin_llm::stats_persist::restore(); Status::NGX_OK.into() } +/// worker 退出前执行一次(nginx 的 `exit_process` 钩子)。 +/// +/// **这是「发版不丢统计」的关键**:共享内存随进程消失,而用量/趋势只活在共享内存里, +/// 所以必须在退出前落一次盘。`docker stop` 发的是镜像声明的 `STOPSIGNAL=SIGQUIT` +/// (优雅停机),`SIGTERM` 也走同一条 worker 退出路径 —— 两者都会到这里。 +/// 只有 `SIGKILL`(`rm -f` 超时兜底 / OOM / 断电)绕过它,那由周期落盘兜住 +/// (见 `stats_persist::maybe_dump`,默认 60 秒一次)。 +/// +/// 多 worker 会各落一次:内容本就只是「同一份共享内存的近似快照」, +/// 写临时文件带 pid、`rename` 原子,谁最后赢都对。 +unsafe extern "C" fn exit_process(_cycle: *mut ngx_cycle_t) { + if let Err(e) = plugin_llm::stats_persist::dump_now("worker-exit") { + util::log_err(&format!("[stats] 退出落盘失败:{e}")); + } +} + // =========================================================================== // 指令处理 // =========================================================================== @@ -638,6 +668,39 @@ extern "C" fn set_audit_dir( } } +/// `ipass_stats_persist <秒>`:运行期统计(用量 / 趋势 / 账号负载)的周期落盘间隔。 +/// +/// 缺省 60 秒;`0` = 关闭周期落盘,只保留 worker 退出钩子那一次(见 `exit_process`)。 +/// 调小它只为缩短「被 SIGKILL 时最多丢多久」,正常发版走退出钩子,本来就是零丢失。 +extern "C" fn set_stats_persist( + cf: *mut ngx_conf_t, + _cmd: *mut ngx_command_t, + _conf: *mut c_void, +) -> *mut c_char { + // SAFETY: 配置回调必然拿到有效的 cf + let cf_ref = unsafe { cf.as_mut().unwrap() }; + let args: &mut [ngx_str_t] = unsafe { (*cf_ref.args).as_slice_mut() }; + + let Ok(raw) = core::str::from_utf8(args[1].as_bytes()) else { + ngx_conf_log_error!(NGX_LOG_EMERG, cf_ref, "ipass_stats_persist: 不是合法 UTF-8"); + return NGX_CONF_ERROR; + }; + let Ok(secs) = raw.trim().parse::() else { + ngx_conf_log_error!( + NGX_LOG_EMERG, + cf_ref, + "ipass_stats_persist: 需要非负整数秒(0 = 只靠退出钩子)" + ); + return NGX_CONF_ERROR; + }; + if secs < 0 { + ngx_conf_log_error!(NGX_LOG_EMERG, cf_ref, "ipass_stats_persist: 秒数不能为负"); + return NGX_CONF_ERROR; + } + plugin_llm::stats_persist::set_interval(secs); + NGX_CONF_OK +} + /// 供测试与诊断使用:`NgxStr` 类型在模块里被多处引用,确保编译期链接到正确的符号 #[allow(dead_code)] fn _type_witness(_: &NgxStr, _: &NgxString) {} diff --git a/tests/llm/e2e.sh b/tests/llm/e2e.sh index e9b7104..56a40ff 100755 --- a/tests/llm/e2e.sh +++ b/tests/llm/e2e.sh @@ -483,30 +483,77 @@ curl -s -b "$JAR" -X POST $API/api/admin/users/delete -H 'Content-Type: applicat -d "$(jbody username healthprobe)" >/dev/null echo -echo "【9】对话审计(audit/ 目录:请求体落盘 + meta 索引 + 被拒不入档)" +echo "【13】对话审计(meta.jsonl:账号/上游/状态 + 前 100 字节 excerpt + 全文 hash)" AUDIT=$RUN/audit sleep 0.3 -audit_n() { find "$AUDIT" -name '*.json' 2>/dev/null | wc -l | tr -d ' '; } -N1=$(audit_n) -ck "转发的请求都落了审计文件" yes "$([ "$N1" -ge 3 ] && echo yes || echo no)" -ck "meta.jsonl 记录账号/上游/状态" yes \ +# 1.0.18 起不再把请求体复制进审计目录(旧版每请求 700 KB+),只写一行 meta。 +# 所以这里的断言从「有 N 个 body 文件」变成「有 N 行 meta,且**本轮没有新增** body 副本」。 +# 用「增量」而不是「绝对 0」:本机 .run/ 下可能还压着 1.0.17 及更早写下的上千个 +# *.json(且沙箱下不一定清得掉),绝对 0 会被历史残留判死;增量 0 才是这条断言 +# 真正要证明的事 —— 这些请求一个副本都没多写。 +meta_n() { cat "$AUDIT"/*/meta.jsonl 2>/dev/null | awk 'NF{n++} END{print n+0}'; } +body_files() { find "$AUDIT" -name '*.json' 2>/dev/null | wc -l | tr -d ' '; } +BODY_BASE=$(body_files) +N1=$(meta_n) +ck "转发的请求都落了 meta 行" yes "$([ "$N1" -ge 3 ] && echo yes || echo no)" +ck "meta 行记录账号/上游/状态" yes \ "$(grep -q '"user":"alice"' "$AUDIT"/*/meta.jsonl 2>/dev/null && grep -q '"slot":"openai"' "$AUDIT"/*/meta.jsonl && grep -q '"status":200' "$AUDIT"/*/meta.jsonl && echo yes || echo no)" -# 取 alice 一条成功记录,比对审计文件内容 = 原始请求体 -AF=$("$PY" -c " + +# ★ 长请求体:excerpt 必须恰好是「前 100 字节」,且**尾部内容不得落盘**。 +# 这是 1.0.18 的核心取舍(元数据 + 100 字符),必须证明它真的只截了 100 字节。 +PAD=$(printf 'A%.0s' $(seq 1 400)) +LBODY="{\"model\":\"gpt-4o\",\"messages\":[{\"role\":\"user\",\"content\":\"${PAD}ZZ_TAIL_MARK\"}]}" +code -H "Authorization: Bearer $ALICE_KEY" -X POST $GW/openai/v1/chat/completions \ + -H 'Content-Type: application/json' -d "$LBODY" >/dev/null +sleep 0.3 +ck "★excerpt = 请求体前 100 字节" yes "$("$PY" -c " import json, sys -for l in open(sys.argv[1], encoding='utf-8'): - d = json.loads(l) - if d.get('user') == 'alice' and d.get('status') == 200: - print(d['file']); break -" "$AUDIT"/*/meta.jsonl 2>/dev/null | head -1) -ck "审计文件内容 = 客户端原始请求体" "$BODY" "$(cat "$AUDIT/$AF" 2>/dev/null)" -N2=$(audit_n) +body, files = sys.argv[1], sys.argv[2:] +# 选择器:这一笔长请求体 body_bytes > 400,其余转发请求都只有几十字节 → 唯一命中。 +# 不再用 excerpt 前缀做选择器:那样在 excerpt 被转义坏掉时连行都选不中, +# 断言会以「找不到行」而不是「内容不对」失败,掩盖真正的原因。 +# 取**最后**一条匹配(而不是第一条):审计目录里可能还留着 1.0.18 首版写下的 +# 双重编码行(同样是 body_bytes 472),它排序在前、会把第一条位置占掉。 +res = 'no' +for f in files: + for l in open(f, encoding='utf-8'): + d = json.loads(l) + if d.get('user') == 'alice' and d.get('status') == 200 and d.get('body_bytes', 0) > 400: + res = 'yes' if d.get('excerpt') == body[:100] else 'no' +print(res) +" "$LBODY" "$AUDIT"/*/meta.jsonl 2>/dev/null)" +ck "★body_bytes = 请求体真实长度" "$(printf '%s' "$LBODY" | wc -c | tr -d ' ')" \ + "$("$PY" -c " +import json, sys +n = '' +for f in sys.argv[1:]: + for l in open(f, encoding='utf-8'): + d = json.loads(l) + if d.get('user') == 'alice' and d.get('body_bytes', 0) > 400: + n = d['body_bytes'] +print(n) +" "$AUDIT"/*/meta.jsonl 2>/dev/null)" +ck "★body_hash 是全文指纹(16 hex)" yes "$("$PY" -c " +import json, re, sys +res = 'no' +for f in sys.argv[1:]: + for l in open(f, encoding='utf-8'): + d = json.loads(l) + if d.get('user') == 'alice' and d.get('body_bytes', 0) > 400: + res = 'yes' if re.fullmatch(r'[0-9a-f]{16}', d.get('body_hash', '')) else 'no' +print(res) +" "$AUDIT"/*/meta.jsonl 2>/dev/null)" +ck "★不再生成请求体副本(本轮新增 *.json = 0)" 0 "$(( $(body_files) - BODY_BASE ))" +ck "★审计目录里搜不到请求体尾部(只截 100 字节)" yes \ + "$(if grep -q 'ZZ_TAIL_MARK' "$AUDIT"/*/meta.jsonl 2>/dev/null; then echo no; else echo yes; fi)" + +N2=$(meta_n) code -H "Authorization: Bearer sk_deadbeef" -X POST $GW/openai/v1/chat/completions \ -H 'Content-Type: application/json' -d "$BODY" >/dev/null sleep 0.3 -ck "被拒请求(401)不入档" 0 "$(( $(audit_n) - N2 ))" +ck "被拒请求(401)不入档" 0 "$(( $(meta_n) - N2 ))" -echo "【10】token 计量(body filter 旁路抓 usage → utt:/utms:)" +echo "【14】token 计量(body filter 旁路抓 usage → utt:/utms:)" # 非 stream usage 固定 7/3;带 usage_probe 的流式在 SSE 尾部给 11/22 curl -s -H "Authorization: Bearer $ALICE_KEY" -X POST $GW/openai/v1/chat/completions \ -H 'Content-Type: application/json' -d "$BODY" >/dev/null @@ -648,6 +695,138 @@ for f in sys.argv[1:]: print('yes' if hit else 'no') " "$AUDIT"/*/meta.jsonl 2>/dev/null)" +echo +echo "【15】★ 运行期统计落盘 / 重启恢复(发版不再清零用量与趋势)" +# 背景:用量/趋势只活在共享内存里,进程退出即消失 → 1.0.18 之前每次发版统计归零。 +# 现在:退出钩子(exit_process)落盘 + 记账路径按间隔节流落盘;启动时 put-if-absent 恢复。 +# 本段刻意放在**最后**:它要停掉再拉起 nginx,之后的断言环境会变(会话丢、共享内存重建)。 +STATS=$RUN/data/llm-stats.json +NBI=${NGINX_BIN:-} +ck "本套件把落盘间隔压到 1 秒(nginx.conf.in)" 1 \ + "$(curl -s -b "$JAR" "$API/api/admin/stats/persist" | jqv data.interval_secs)" + +# 跑几笔请求,让统计有东西可落 +for _ in 1 2 3; do + code -H "Authorization: Bearer $ALICE_KEY" -X POST $GW/openai/v1/chat/completions \ + -H 'Content-Type: application/json' -d "$BODY" >/dev/null +done +sleep 1.5 # > 间隔 1 秒:保证周期性落盘已经跑过一次 + +ck "★周期落盘已产出快照文件" yes "$([ -s "$STATS" ] && echo yes || echo no)" +ck "★快照含账号级用量键(ust:alice)" yes \ + "$("$PY" -c " +import json, sys +ok = 'no' +try: + d = json.load(open(sys.argv[1], encoding='utf-8')) + ok = 'yes' if any(k.startswith('ust:alice') for k in d.get('keys', {})) else 'no' +except Exception: + pass +print(ok) +" "$STATS" 2>/dev/null)" +ck "★快照含趋势日桶键(ud:)" yes \ + "$("$PY" -c " +import json, sys +ok = 'no' +try: + d = json.load(open(sys.argv[1], encoding='utf-8')) + ok = 'yes' if any(k.startswith('ud:') for k in d.get('keys', {})) else 'no' +except Exception: + pass +print(ok) +" "$STATS" 2>/dev/null)" +ck "★快照不含凭据类配置键(up:/upa:/ax:)" yes \ + "$("$PY" -c " +import json, sys +bad = 'no' +try: + d = json.load(open(sys.argv[1], encoding='utf-8')) + bad = 'yes' if any(k.split(':', 1)[0] + ':' in ('up:', 'upa:', 'upe:', 'ax:', 'ukey:', 'sub:') for k in d.get('keys', {})) else 'no' +except Exception: + pass +print('yes' if bad == 'no' else 'no') +" "$STATS" 2>/dev/null)" + +T0=$(curl -s -b "$JAR" $API/api/admin/usage | "$PY" -c " +import json, sys +d = json.load(sys.stdin)['data'] +for u in d.get('users', []): + if u['username'] == 'alice': + print(u['total']); break +else: + print(-1) +" 2>/dev/null) +TR0=$(curl -s -b "$JAR" "$API/api/admin/trend?days=7" | "$PY" -c " +import json, sys +print(sum(json.load(sys.stdin)['data']['total']['requests'])) +" 2>/dev/null) +ck "重启前 alice 用量 > 0" yes "$([ "${T0:-0}" -gt 0 ] && echo yes || echo no)" + +# ---- 优雅停机(= 生产 STOPSIGNAL SIGQUIT,会调到 worker 的 exit_process 钩子)---- +if [ -n "$NBI" ]; then + "$NBI" -p "$RUN" -c "$RUN/nginx.conf" -s quit >/dev/null 2>&1 + for _ in $(seq 1 30); do + code -s -o /dev/null --max-time 0.3 $GW/ >/dev/null 2>&1 || break + sleep 0.1 + done + "$NBI" -p "$RUN" -c "$RUN/nginx.conf" >>"$RUN/logs/restart.out" 2>&1 + sleep 0.5 +fi + +ck "重启后 LLM 端口可用" yes \ + "$(for _ in $(seq 1 40); do [ "$(code -H 'Authorization: Bearer en_bad' -X POST $GW/openai/v1/chat/completions -H 'Content-Type: application/json' -d "$BODY" 2>/dev/null)" = "401" ] && { echo yes; break; }; sleep 0.1; done)" + +# 会话在共享内存里(sess:),重启即失效 —— 这不是本功能的范畴,重新登录即可 +JAR2=$RUN/cookie2.jar +curl -s -c "$JAR2" -X POST $API/api/admin/login -H 'Content-Type: application/json' \ + -d "$(jbody username admin password 123456)" >/dev/null +PST=$(curl -s -b "$JAR2" "$API/api/admin/stats/persist") +ck "★重启后报告已恢复的键数 > 0" yes \ + "$(printf '%s' "$PST" | "$PY" -c 'import json,sys;d=json.load(sys.stdin)["data"];print("yes" if d.get("restored_keys",0)>0 else "no")' 2>/dev/null)" +ck "★恢复数 = 快照键数(没漏键)" yes \ + "$(printf '%s' "$PST" | "$PY" -c 'import json,sys;d=json.load(sys.stdin)["data"];print("yes" if d.get("restore_total",0)>0 and d.get("restored_keys",0)==d.get("restore_total",-1) else "no")' 2>/dev/null)" + +T1=$(curl -s -b "$JAR2" $API/api/admin/usage | "$PY" -c " +import json, sys +d = json.load(sys.stdin)['data'] +for u in d.get('users', []): + if u['username'] == 'alice': + print(u['total']); break +else: + print(-1) +" 2>/dev/null) +ck "★重启后 alice 累计用量不变(未被清零)" "$T0" "$T1" +# 再打一笔:应从恢复后的基数 +1,而不是从 0 重新长起来 +code -H "Authorization: Bearer $ALICE_KEY" -X POST $GW/openai/v1/chat/completions \ + -H 'Content-Type: application/json' -d "$BODY" >/dev/null +T2=$(curl -s -b "$JAR2" $API/api/admin/usage | "$PY" -c " +import json, sys +d = json.load(sys.stdin)['data'] +for u in d.get('users', []): + if u['username'] == 'alice': + print(u['total']); break +else: + print(-1) +" 2>/dev/null) +ck "★重启后继续累加(T0+1,而非从 0 重来)" "$(( T0 + 1 ))" "$T2" +ck "★重启后趋势日桶仍在(历史没丢)" yes \ + "$(curl -s -b "$JAR2" "$API/api/admin/trend?days=7" | "$PY" -c " +import json, sys +print('yes' if sum(json.load(sys.stdin)['data']['total']['requests']) >= $TR0 else 'no') +" 2>/dev/null)" +ck "★重启后账号级负载仍可读(uda: 恢复)" yes \ + "$(curl -s -b "$JAR2" $API/api/admin/upstreams | "$PY" -c " +import json, sys +d = json.load(sys.stdin)['data'] +ok = False +for s in d.get('items', []): + if s.get('slot') == 'openai': + for a in s.get('accounts', []): + if (a.get('load') or {}).get('requests', 0) > 0: + ok = True +print('yes' if ok else 'no') +" 2>/dev/null)" + echo echo "============================================================" printf " 通过 \033[32m%d\033[0m 失败 \033[31m%d\033[0m\n" "$pass" "$fail" diff --git a/tests/llm/nginx.conf.in b/tests/llm/nginx.conf.in index f465402..32c28bb 100644 --- a/tests/llm/nginx.conf.in +++ b/tests/llm/nginx.conf.in @@ -30,6 +30,12 @@ http { ipass_state state 10m; ipass_data_dir @RUN@/data; + # ★ 统计落盘间隔压到 1 秒:让「周期性落盘」在本套件里能被确定性验证。 + # 生产不写这条指令(用默认 60)——**刻意不在 conf/nginx.conf 里写死**, + # 否则回滚到不含该指令的旧镜像时 nginx 会因 unknown directive 起不来。 + # 见 plugin-llm/src/stats_persist.rs 模块注释。 + ipass_stats_persist 1; + # 可选 HTTPS:run.sh 会在 @RUN@/tls/ 放渲染好的 443 server + 自签证书; # 文件不存在时此 include 空匹配,不影响启动 include @RUN@/tls/*.conf; diff --git a/tests/run.sh b/tests/run.sh index 39dedba..90a210e 100755 --- a/tests/run.sh +++ b/tests/run.sh @@ -120,6 +120,19 @@ suite_llm() { cp "$HERE/llm/fixtures/llm-upstreams.json" "$RUN/data/llm-upstreams.json" cp "$HERE/llm/fixtures/api-proxies.json" "$RUN/data/api-proxies.json" rm -f "$RUN/upstream.log" + # 把上一轮的统计快照**挪开**(而不是删除),保证本轮从 0 起算。 + # + # 为什么不删:本机装了 safe-delete 钩子 —— 同一个 agent turn 里累计删除超过 + # 50 个文件后,后续所有删除都被静默拦掉(可见日志 SAFE_DELETE_BULK_CONFIRM_REQUIRED)。 + # `rm -rf` 与 python 的 shutil.rmtree / os.remove 都撞在这上面。 + # 症状很有欺骗性:清理「没报错但没生效」,于是上一轮的 ust:/ud:/uh: 被启动时的 + # restore() 恢复进本轮 —— carol 用量期望 2 变成 6、「上游健康初始状态」期望 + # unknown 变成 ok(看起来像统计功能有 bug,实际是测试间的状态泄漏)。 + # `mv` 是 rename、不是删除,在沙箱下稳定生效;留档也便于比对。 + if [ -s "$RUN/data/llm-stats.json" ]; then + mkdir -p "$RUN/stale" + mv "$RUN/data/llm-stats.json" "$RUN/stale/llm-stats.$(date +%s).json" + fi render "$HERE/llm/nginx.conf.in" "$RUN/nginx.conf" "$RUN" # TLS 夹具:本机 nginx 带 http_ssl_module 且有 openssl 时,生成自签证书 + @@ -181,6 +194,7 @@ except Exception: echo GW="http://127.0.0.1:18090" API="http://127.0.0.1:18091" \ UPSTREAM_LOG="$RUN/upstream.log" RUN="$RUN" PY="$PY" HAVE_TLS="$HAVE_TLS" \ + NGINX_BIN="$NGINX_BIN" \ bash "$HERE/llm/e2e.sh" local rc=$?