Skip to content

Commit 2cbee04

Browse files
committed
docs: bilingual lede on README.md + README.zh.md
So an EN reader landing on README.md or a zh reader landing on README.zh.md can pick up the project without switching files. Each README's first paragraph stays in its primary language; the second-language version follows immediately as a blockquoted paragraph (same wording, just translated). The rest of the README stays in the primary language to keep each surface readable. GitHub repo description was also updated out-of-band to bilingual: "Transparent LLM gateway trace recorder · sub2api / CLIProxyAPI / new-api 的 LLM 网关流量录制器".
1 parent 1431af4 commit 2cbee04

2 files changed

Lines changed: 4 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ English | [中文](README.zh.md)
1111

1212
api-log is a transparent HTTP recording proxy for LLM gateway observability. It sits in front of sub2api, CLIProxyAPI (CPA), new-api, or any OpenAI-compatible gateway and captures OpenAI Chat, Anthropic Messages, Responses, and Gemini traffic. Each completed request/response is written as append-only JSONL with a SQLite index for local search, replay, and per-key analysis.
1313

14+
> api-log 是一个面向 LLM 网关可观测性的透明 HTTP 录制 proxy。它部署在 sub2api、CLIProxyAPI(CPA)、new-api 等 OpenAI 兼容网关前面,原样转发流量,捕获 OpenAI Chat、Anthropic Messages、Responses、Gemini 等协议。每条完成的请求/响应 trace 以 append-only JSONL 落盘,并构建 SQLite 索引,用于本地检索、重放和按 key 排查问题。
15+
1416
The forwarding goroutine never inspects bodies. JSON unmarshalling, SSE event splitting, and session inference happen in a finalize step after the response has been delivered to the client. Token accounting, evaluation pipelines, and any semantic interpretation are downstream of this project's scope.
1517

1618
**Companion UI:** [api-log-viewer](https://github.com/2nd1st/api-log-viewer) — Svelte 5 SPA frontend for api-log traces; serve it from the built-in `/viewer/` route or behind Caddy/nginx next to the read API.

‎README.zh.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
api-log 是一个面向 LLM 网关可观测性的透明 HTTP 录制 proxy。它部署在 sub2api、CLIProxyAPI(CPA)、new-api 等 OpenAI 兼容网关前面,原样转发流量,捕获 OpenAI Chat、Anthropic Messages、Responses、Gemini 等协议。每条完成的请求/响应 trace 以 append-only JSONL 落盘,并构建 SQLite 索引,用于本地检索、重放和按 key 排查问题。
1313

14+
> api-log is a transparent HTTP recording proxy for LLM gateway observability. It sits in front of sub2api, CLIProxyAPI (CPA), new-api, or any OpenAI-compatible gateway and captures OpenAI Chat, Anthropic Messages, Responses, and Gemini traffic. Each completed request/response is written as append-only JSONL with a SQLite index for local search, replay, and per-key analysis.
15+
1416
转发 goroutine 不解析任何 body。JSON 反序列化、SSE 事件切分、session 推断都在响应回写给客户端之后的 finalize 阶段进行。Token 计费、评测流水线、以及任何语义层面的解释都在本项目范围之外。
1517

1618
**配套前端:** [api-log-viewer](https://github.com/2nd1st/api-log-viewer) —— api-log trace 的 Svelte 5 SPA 前端;可由后端 `/viewer/` 托管,也可放在 Caddy/nginx 后与 read API 同源部署。

0 commit comments

Comments
 (0)