Skip to content

Commit 230c0e5

Browse files
committed
Doc updates for banning and client_idle_timeout
1 parent b3db254 commit 230c0e5

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

docs/configuration/pgdog.toml/general.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,6 @@ queries as possible.
148148

149149
Default: **`60_000`** (60s)
150150

151-
152151
### `query_timeout`
153152

154153
Maximum amount of time to wait for a Postgres query to finish executing. Use only in unreliable network conditions or when Postgres runs on unreliable hardware.
@@ -192,6 +191,12 @@ Close client connections that have been idle, i.e., haven't sent any queries, fo
192191

193192
Default: **`none`** (disabled)
194193

194+
### `client_login_timeout`
195+
196+
Maximum amount of time new clients have to complete authentication. Clients that don't will be disconnected.
197+
198+
Default: **`60_000`** (60s)
199+
195200
## Load balancer
196201

197202
### `load_balancing_strategy`

docs/features/load-balancer/healthchecks.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,10 @@ ban_timeout = 300_000 # 5 minutes
8787

8888
The **default** value is **5 minutes** (`300_000` milliseconds).
8989

90-
If the database is still broken once the ban expires, it will fail a health check and will be removed from the load balancer again.
90+
!!! note
91+
A database will not be placed back into the load balancer until it passes a health check again.
92+
93+
Make sure that `idle_healthcheck_timeout` is set to a lower setting than `ban_timeout`, so health checks have time to run before you expect the database to resume serving traffic.
9194

9295
### False positives
9396

0 commit comments

Comments
 (0)