pg-kinetic documentation
pg-kinetic is a PostgreSQL wire proxy for teams that need a controlled boundary between application connection demand and PostgreSQL capacity. These docs explain what it is, how it compares with other PostgreSQL poolers, what is ready for traffic, and how to operate it without confusing preview tooling with stable runtime behavior.
Current State
| Area | Status | Notes |
|---|---|---|
| PostgreSQL wire proxy | Works now | The proxy accepts PostgreSQL clients and forwards traffic to a backend. |
| Transaction pooling and virtual sessions | Works now | Backend reuse is conservative and pins sessions when state is unsafe to replay. |
| Read routing | Works now with limits | Runtime uses the first configured route. Replica routing depends on the route's replica config and conservative read classification. |
| Health endpoints | Works now | GET /healthz, GET /readyz, and GET /state; no HTTP drain endpoint. |
| Admin views | Works now for available snapshots | Some feature-specific views remain empty until the corresponding runtime path records data. |
| Metrics | Works now for installed collectors | Feature metrics stay zero when that feature path is disabled or preview-only. |
| TLS and client auth | Works now | Exact modes and failure cases are documented in TLS/auth docs. |
| Docker and Helm assets | Local assets now | Public images and Helm repository require a published GitHub Release. |
| Sharding | Preview/offline | Route-preview and core models exist; main proxy config does not expose live sharding traffic config. |
| Policy | Preview/offline | Policy-preview and policy models exist; main proxy config does not expose live policy traffic config. |
| Mirroring | Disabled in live proxy | The proxy constructs a disabled mirror dispatcher today. |
| Adaptive operations | Recommendation/simulation | Records recommendations and simulated outcomes; does not mutate live settings. |
| Kubernetes operator | Not supported | No CRDs or controller exist. |
What To Read First
- What Is pg-kinetic? explains the connection-storm problem, adoption cost, and what pg-kinetic is not.
- How pg-kinetic Compares compares pg-kinetic with PgBouncer, PgDog, PgCat, and Odyssey.
- Is pg-kinetic Ready? puts maturity, release scope, and preview exclusions in one place.
- Benchmark Results shows source-backed baseline charts before the full benchmarking workflow.
- Quickstart runs one local end-to-end check.
- Configuration documents implemented runtime config fields and precedence.
Documentation Map
pg-kinetic PostgreSQL Proxy Documentation
Evaluate, benchmark, install, and operate pg-kinetic, a Rust PostgreSQL wire proxy for connection pooling, backpressure, conservative read routing, health checks, metrics, and admin visibility.
Evaluate
4 items
Start
7 items
Concepts
4 items
Runtime Features And Preview Tooling
9 items
Operations
8 items
Benchmarking And Regression
2 items
Contributing
2 items