zai-proxy/README.md
jedarden e7c24a0c08 feat: initial zai-proxy ecosystem repo
Extracted from ardenone-cluster/containers/zai-proxy and
ardenone-cluster/containers/zai-proxy-dashboard.

- proxy/: OpenAI-compatible ZAI reverse proxy (Go, v1.10.0)
  - Token counting, rate limiting, Prometheus metrics, canary support
- dashboard/: Metrics dashboard backend + React frontend (Go, v1.0.0)
  - Prometheus collector, SQLite storage, SSE live updates
- docs/: Operational notes, research, and plan subdirs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-16 15:53:52 -04:00

37 lines
1.2 KiB
Markdown

# zai-proxy
LLM reverse proxy and metrics dashboard for the [Z.AI](https://z.ai) API.
## Components
### proxy/
OpenAI-compatible reverse proxy that fronts the Z.AI API. Features:
- Request/response body parsing and token counting (tiktoken + GLM tokenizers)
- Rate limiting with configurable burst and steady-state limits
- Prometheus metrics export
- Blue/green and canary deployment support
- Translation layer for provider-specific request/response formats
See [proxy/README.md](proxy/README.md) for setup and configuration.
### dashboard/
Go backend + React frontend for visualizing proxy metrics, token usage, and request history.
- Collects metrics from the proxy's Prometheus endpoint
- Stores aggregated data in SQLite
- Serves a Tailwind/Vite frontend via SSE for live updates
See [dashboard docs](docs/notes/) for deployment and monitoring.
## Docs
- [`docs/plan/`](docs/plan/) — architecture decisions and roadmaps
- [`docs/notes/`](docs/notes/) — deployment, operations, monitoring, canary procedures
- [`docs/research/`](docs/research/) — tokenizer research, metrics references
## Git remotes
- Forgejo (primary): `https://git.ardenone.com/jedarden/zai-proxy.git`