heliosdb-proxy 0.4.1

HeliosProxy - Intelligent connection router and failover manager for HeliosDB and PostgreSQL
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

# Postgres Cluster Example

A self-contained 3-node PostgreSQL cluster fronted by HeliosProxy with automatic read/write splitting and connection pooling.

## Architecture

```
                     +-----------+
  Client  --------→ | HeliosProxy| :6432 (PG wire) / :9090 (admin API)
                     +-----+-----+
                           |
         +-----------+-----+-----+-----------+
         |           |                       |
   +-----+-----+  +------+------+  +--------+----+
   | pg-primary |  | pg-standby1 |  | pg-standby2 |
   |  (R/W)    |  |  (read-only)|  |  (read-only) |
   +-----+-----+  +------+------+  +--------+----+
         |                ↑                  ↑
         +--- streaming replication ---------+
```

## Quick Start

```bash
# Start everything
docker compose up -d

# Watch proxy logs
docker compose logs -f proxy

# Wait for health
curl http://localhost:9090/health
```

## Connecting

All connections go through the proxy on port 6432:

```bash
# psql
psql postgresql://app:apppass@localhost:6432/appdb

# Or with flags
PGPASSWORD=apppass psql -h localhost -p 6432 -U app -d appdb
```

## What to Observe

### Read/Write Splitting

```sql
-- This INSERT is routed to the primary
INSERT INTO test (name) VALUES ('hello');

-- This SELECT is load-balanced across standbys
SELECT * FROM test;
```

### Admin API

```bash
# Health status
curl http://localhost:9090/health

# List backend nodes and their health
curl http://localhost:9090/nodes | jq .

# View current metrics (connections, queries, failovers)
curl http://localhost:9090/metrics | jq .

# Prometheus-format metrics
curl http://localhost:9090/metrics/prometheus

# Connection pool statistics
curl http://localhost:9090/pools | jq .

# Current proxy configuration
curl http://localhost:9090/config | jq .
```

### Disable a Node for Maintenance

```bash
# Take standby-1 out of rotation
curl -X POST http://localhost:9090/nodes/pg-standby1:5432/disable

# Confirm it is disabled
curl http://localhost:9090/nodes | jq .

# Re-enable it
curl -X POST http://localhost:9090/nodes/pg-standby1:5432/enable
```

## Configuration

See `proxy.toml` for all tunable parameters:

- `pool_mode.mode` -- `session`, `transaction`, or `statement`
- `load_balancer.read_strategy` -- `round_robin`, `least_connections`, `latency_based`, `random`
- `health.failure_threshold` -- consecutive failures before marking a node unhealthy
- `tr_enabled` / `tr_mode` -- Transaction Replay for session continuity during failover

## Teardown

```bash
docker compose down -v
```