Skip to main content

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

AreaStatusNotes
PostgreSQL wire proxyWorks nowThe proxy accepts PostgreSQL clients and forwards traffic to a backend.
Transaction pooling and virtual sessionsWorks nowBackend reuse is conservative and pins sessions when state is unsafe to replay.
Read routingWorks now with limitsRuntime uses the first configured route. Replica routing depends on the route's replica config and conservative read classification.
Health endpointsWorks nowGET /healthz, GET /readyz, and GET /state; no HTTP drain endpoint.
Admin viewsWorks now for available snapshotsSome feature-specific views remain empty until the corresponding runtime path records data.
MetricsWorks now for installed collectorsFeature metrics stay zero when that feature path is disabled or preview-only.
TLS and client authWorks nowExact modes and failure cases are documented in TLS/auth docs.
Docker and Helm assetsLocal assets nowPublic images and Helm repository require a published GitHub Release.
ShardingPreview/offlineRoute-preview and core models exist; main proxy config does not expose live sharding traffic config.
PolicyPreview/offlinePolicy-preview and policy models exist; main proxy config does not expose live policy traffic config.
MirroringDisabled in live proxyThe proxy constructs a disabled mirror dispatcher today.
Adaptive operationsRecommendation/simulationRecords recommendations and simulated outcomes; does not mutate live settings.
Kubernetes operatorNot supportedNo CRDs or controller exist.

What To Read First

  1. What Is pg-kinetic? explains the connection-storm problem, adoption cost, and what pg-kinetic is not.
  2. How pg-kinetic Compares compares pg-kinetic with PgBouncer, PgDog, PgCat, and Odyssey.
  3. Is pg-kinetic Ready? puts maturity, release scope, and preview exclusions in one place.
  4. Benchmark Results shows source-backed baseline charts before the full benchmarking workflow.
  5. Quickstart runs one local end-to-end check.
  6. Configuration documents implemented runtime config fields and precedence.

Documentation Map