Skip to content

docs(usage): phase 2 final 3 — logs-stats + recording + troubleshooting#183

Merged
g1331 merged 1 commit into
masterfrom
docs/phase2-usage-final-3
May 23, 2026
Merged

docs(usage): phase 2 final 3 — logs-stats + recording + troubleshooting#183
g1331 merged 1 commit into
masterfrom
docs/phase2-usage-final-3

Conversation

@g1331
Copy link
Copy Markdown
Owner

@g1331 g1331 commented May 23, 2026

Summary

Phase 2 使用侧收尾 3 篇,至此使用指南 9/9 全部完成。

  • docs/guide/usage/logs-stats.md — 请求日志与统计
  • docs/guide/usage/request-recording.md — 请求录制
    • Runtime Settings 主控(env 已弃用,shouldRecordFixture 只读 DB),默认 enabled=false / mode=failure
    • 磁盘布局:{dir}/{provider}/{route}/{timestamp}.json + latest.json 双写、16 MiB 截断、compactSSEChunks 对 OpenAI Responses 大型快照事件的 instructions/tools 替换。
    • 脱敏 SENSITIVE_HEADER_NAMES 全列;hook 时机 fire-and-forget、tee() 分叉不影响 client 延迟。
    • /api/mock 回放仅 NODE_ENV !== production 生效。
    • 校正.env.example 注释里 tests/fixtures 与源码默认值 data/traffic-recordings 不一致,文档以源码为准并明确指出。
  • docs/guide/usage/troubleshooting.md — 使用侧故障排查手册
    • 按 客户端 Key / 路由 / SSE / CLIProxyAPI / 计费 / 日志 六类组织 symptom → error code → 源码定位 → 排查方向表格。
    • 覆盖错误码:API_KEY_MODEL_NOT_ALLOWED / NO_AUTHORIZED_UPSTREAMS / NO_HEALTHY_CANDIDATES / CONCURRENCY_FULL / QUEUE_WAIT_TIMEOUT / CLIENT_DISCONNECTED / queue_full / REQUEST_TIMEOUT / STREAM_ERROR 等。
    • CLIProxyAPI 四态、CliproxyInstanceInUseErrorduration_ms 24.8 天、status_code=520UnbillableReason 四类。
    • 与部署侧 troubleshooting / circuit breaker 长篇 / cliproxy 长篇的边界明确划分,避免主题重叠。

Phase 2 使用侧 6/9 → 9/9 全部合入,剩部署 0/6、架构 0/9。

Test plan

  • pnpm exec vitepress build docs 本地通过,仅 env 语言无 highlighter 与 vueuse #PURE 注释告警,与本 PR 无关。
  • pre-commit prettier hook 通过。
  • Pages 部署任务在 master 合入后自动触发,等 CI 校验。
  • 三篇文档引用的所有源码路径与行号基于当前 master 校对。

…hooting (#167)

收尾使用侧 9 篇,至此 Phase 2 使用指南全部完成。

- logs-stats:request_logs 40+ 列分组列出,重点讲 PR #170/#171 的
  duration_ms INT4 clamp、stale reconcile (status_code=520) 兜底;
  /api/admin/logs 的 query 参数集(无 model 过滤)、/api/admin/logs/live
  SSE 与多副本下的进程内 pub/sub 限制;overview / timeseries / leaderboard
  三类聚合的实时计算口径,特别是 TPS 的多重过滤条件;明确指出
  LOG_RETENTION_DAYS 当前无后台清理任务消费、表实际无限增长,给出手动
  DELETE 的兜底方案。
- request-recording:Runtime Settings 主控(env 已弃用,shouldRecordFixture
  只读 DB),默认 enabled=false / mode=failure;磁盘布局含 latest.json
  双写、16 MiB 截断、compactSSEChunks 对 OpenAI Responses 大型快照事件
  的 instructions/tools 替换;脱敏的 SENSITIVE_HEADER_NAMES 全列;hook
  时机 fire-and-forget、tee() 分叉不影响 client 延迟;/api/mock 回放仅
  NODE_ENV !== production 生效。同时纠正 .env.example 注释里 tests/fixtures
  与源码实际默认 data/traffic-recordings 的不一致。
- troubleshooting:按客户端 Key / 路由 / SSE / CLIProxyAPI / 计费 / 日志
  六类组织 symptom→error code→源码定位→排查方向表格。覆盖
  API_KEY_MODEL_NOT_ALLOWED、NO_AUTHORIZED_UPSTREAMS、NO_HEALTHY_CANDIDATES、
  CONCURRENCY_FULL、QUEUE_WAIT_TIMEOUT、CLIENT_DISCONNECTED、queue_full、
  REQUEST_TIMEOUT、STREAM_ERROR、CliproxyConnectionStatus 四态、
  CliproxyInstanceInUseError、duration_ms 24.8 天、status_code=520、
  UnbillableReason 四类等,并明确划分与部署侧 troubleshooting / circuit
  breaker 长篇 / cliproxy 长篇的边界,避免主题重叠。

Phase 2 使用侧 6/9 → 9/9,剩部署 0/6、架构 0/9。
@g1331 g1331 merged commit 57fdc2e into master May 23, 2026
14 checks passed
@g1331 g1331 deleted the docs/phase2-usage-final-3 branch May 23, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant