You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit c00b632
Browse filesBrowse the repository at this point in the historyBrowse files
docs: document scoped mutation locks and lock-pool sizing
In the High Availability guide, size PostgreSQL for 14 connections per
gateway pod, 10 for data and 4 for the new lock pool, so three or more
replicas now exceed what the PostgreSQL default leaves, and keep
headroom for lock sessions that cancelled requests leave behind.
Explain which changes lock a sandbox, a workspace, or the whole fleet,
and that a lock wait over 10 seconds returns a retryable UNAVAILABLE
with reason MUTATION_LOCK_TIMEOUT. A new upgrade subsection says to
raise max_connections to the 14-per-pod size before upgrading, because
the rollout already runs new pods at that count, and warns that older
replicas keep serializing every mutation until the rollout finishes.
Monitor Capacity gains the lock metrics and their queries, and names
slow driver, credential, middleware, or profile source calls as another
cause of lock waits.
List the lock wait histogram and timeout counter, with their scope
label, on the Gateway Metrics page. The counter also counts background
work and leaves out lock connections that PostgreSQL does not open
although at least a second of the wait remained.
In the cluster debugging skill, replace the single advisory-lock
paragraph with the lock levels and pool, what each timeout detail
means, how a lock connection that PostgreSQL does not open shows up,
when terminating a lock backend is safe, a pg_locks query that shows
holders and waiters, and how to spot the global key. The per-pod greps
also read the timeout counter, and new rows cover lock timeouts and
lock connections that PostgreSQL does not open.
Part of #3528
Signed-off-by: Emilien Macchi <[email protected]>
Copy file name to clipboardExpand all lines: docs/kubernetes/high-availability.mdx
+57-8Lines changed: 57 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -205,6 +205,7 @@ configuration, and access control.
205
205
| Relay rejections | `openshell_server_relay_rejected_total` | Alert on any increase. |
206
206
| Relay claims | `openshell_server_relay_claim_duration_seconds`, `openshell_server_relay_expired_total` | Supervisor connect-back time for exec, SSH, forwarding, and service traffic, including relays requested through peers. A high 99th percentile while rejections stay flat points at the supervisor or its node, not at relay capacity. Relays not claimed within 10 seconds are missing from the histogram and count as expired, so alert on any increase. |
207
207
| Routed requests | `openshell_server_routed_request_attempts_total`, `openshell_server_peer_request_duration_seconds` | Local/peer relay setup mix and outbound peer rate, failures, and latency. Counts completed or cancelled attempts, including retries. Spikes of `grpc_code="unavailable"` during rollouts are expected. Do not use as an HPA target. |
208
+
| Lock contention | `openshell_server_mutation_lock_wait_seconds`, `openshell_server_mutation_lock_timeouts_total` | Alert on any timeout. |
208
209
209
210
These queries assume that Prometheus labels each series with `namespace` and
210
211
`pod`:
@@ -234,6 +235,12 @@ sum by (operation) (rate(openshell_server_routed_request_attempts_total{route="p
234
235
235
236
# 99th percentile peer request latency across the fleet.
236
237
histogram_quantile(0.99, sum by (le, operation) (rate(openshell_server_peer_request_duration_seconds_bucket{outcome="success"}[5m])))
238
+
239
+
# 99th percentile mutation lock wait by scope. Watch scope="sandbox" during rollouts.
240
+
histogram_quantile(0.99, sum by (le, scope) (rate(openshell_server_mutation_lock_wait_seconds_bucket[5m])))
241
+
242
+
# Mutation lock timeouts by scope. Alert on any increase.
243
+
sum by (scope) (increase(openshell_server_mutation_lock_timeouts_total[10m]))
237
244
```
238
245
239
246
Relay capacity is used on the replica that owns the sandbox's supervisor
@@ -243,6 +250,16 @@ stays counted for up to about 40 seconds, the 10-second claim timeout plus the
243
250
30-second cleanup interval. Routed request counts include retries during
244
251
rollouts.
245
252
253
+
Each supervisor that reconnects takes one or two short sandbox-scoped locks on
254
+
the replica that receives it. When a gateway pod stops during a rollout, its
255
+
supervisors reconnect to the other replicas, so watch
256
+
`openshell_server_mutation_lock_wait_seconds`and
257
+
`openshell_server_mutation_lock_timeouts_total`with `scope="sandbox"` on the
258
+
receiving replicas. Rising waits or any timeout mean that those replicas
259
+
receive reconnects faster than they can absorb them, or that slow compute
260
+
driver, credential backend, middleware, or provider profile source calls during
261
+
sandbox and provider changes hold their locks longer.
262
+
246
263
## Scale the Gateway
247
264
248
265
Scale the gateway by changing a fixed replica count or by letting a
@@ -373,7 +390,9 @@ kubectl get --raw "/apis/custom.metrics.k8s.io/v1beta1/namespaces/openshell/pods
373
390
374
391
### Size PostgreSQL Connections
375
392
376
-
Each gateway pod opens up to 10 PostgreSQL connections on demand. The chart
393
+
Each gateway pod opens up to 14 PostgreSQL connections on demand, 10 for data
394
+
access and 4 for mutation locks. A request cancelled during a lock wait can
395
+
leave its lock session open for up to 10 seconds, so keep headroom. The chart
377
396
uses the Kubernetes default rolling update strategy for each workload kind, so
378
397
the number of pods that run during a rollout depends on the kind.
379
398
@@ -383,18 +402,18 @@ and each replaced pod can keep its connections throughout its termination
383
402
grace period. A rollout can therefore run up to twice the replica count at
384
403
once, and an eviction or an autoscaler scale-down during the rollout adds more
385
404
terminating pods. Set PostgreSQL `max_connections` to at least
386
-
`(2 × replicas + surge) × 10`, which leaves one surge of margin for those
405
+
`(2 × replicas + surge) × 14`, which leaves one surge of margin for those
387
406
pods, plus headroom for your other clients and administration. Use
388
407
`autoscaling.maxReplicas`as the replica count when autoscaling is enabled.
389
408
390
409
| Replicas | Surge | Minimum `max_connections` |
391
410
|---|---|---|
392
-
| 2 | 1 | `(4 + 1) × 10 = 50` |
393
-
| 3 | 1 | `(6 + 1) × 10 = 70` |
394
-
| 4 | 1 | `(8 + 1) × 10 = 90` |
395
-
| 6 | 2 | `(12 + 2) × 10 = 140` |
411
+
| 2 | 1 | `(4 + 1) × 14 = 70` |
412
+
| 3 | 1 | `(6 + 1) × 14 = 98` |
413
+
| 4 | 1 | `(8 + 1) × 14 = 126` |
414
+
| 6 | 2 | `(12 + 2) × 14 = 196` |
396
415
397
-
With a Deployment, five or more replicas exceed what the PostgreSQL default of
416
+
With a Deployment, three or more replicas exceed what the PostgreSQL default of
398
417
100 leaves for the gateway, because PostgreSQL reserves 3 connections for
399
418
superusers. Raise `max_connections` or use a larger managed instance. Let one
400
419
rollout finish before you start another, because each overlapping rollout adds
@@ -403,14 +422,44 @@ its own terminating pods.
403
422
If you run several replicas as a StatefulSet with
404
423
`workload.allowMultiReplicaStatefulSet`, a rollout adds no surge pods. It
405
424
replaces one pod at a time and creates each replacement only after the old pod
406
-
exits. Set `max_connections` to at least `replicas × 10`, using
425
+
exits. Set `max_connections` to at least `replicas × 14`, using
407
426
`autoscaling.maxReplicas`when autoscaling is enabled, plus headroom for your
408
427
other clients and administration.
409
428
410
429
If a connection pooler sits between the gateway and PostgreSQL, use session
411
430
pooling. The gateway holds session-level advisory locks, which transaction
412
431
pooling breaks.
413
432
433
+
Mutations lock only what they change. Sandbox operations lock their own
434
+
sandbox, provider and workspace-profile changes lock their workspace, and
435
+
gateway-global policy, settings, and platform-profile changes lock the whole
436
+
fleet. Sandbox start, stop, and delete lock only on the replica that runs them,
437
+
and only a gateway-global change on that replica blocks them directly.
438
+
Provider, workspace-profile, and other replicas' gateway-global changes delay
439
+
them only while another operation on the same sandbox waits behind the change.
440
+
Sandbox create, start, restart, and delete also take one fleet-wide lock while
441
+
they provision or remove the sandbox's SSH host identity, so that step runs for
442
+
one sandbox at a time across all replicas. For other
443
+
mutations, a lock wait longer than 10 seconds returns `UNAVAILABLE` with the
444
+
reason `MUTATION_LOCK_TIMEOUT`, and clients can retry the request. A request
445
+
that carried a `request_id` leaves its admission unresolved, like any other
446
+
error, so a retry with the same ID returns `REQUEST_OUTCOME_UNCERTAIN`. Observe
447
+
resource state and reconcile effects, then send a new request with a new
Copy file name to clipboardExpand all lines: docs/observability/gateway-metrics.mdx
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
# SPDX-License-Identifier: Apache-2.0
4
4
title: "Gateway Metrics"
5
5
sidebar-title: "Gateway Metrics"
6
-
description: "Scrape Prometheus metrics from the OpenShell gateway, including supervisor session, relay capacity, and peer routing signals for multi-replica deployments."
6
+
description: "Scrape Prometheus metrics from the OpenShell gateway, including supervisor session, relay capacity, peer routing, and mutation lock signals for multi-replica deployments."
@@ -175,6 +175,13 @@ that owns a sandbox's supervisor session:
175
175
| `openshell_server_routed_request_attempts_total` | Counter | `operation`, `route`, `relay_kind`, `outcome`, `grpc_code` | Local relay setup and outbound peer attempts, counted once when they finish or are cancelled. Each retry counts separately. |
176
176
| `openshell_server_peer_request_duration_seconds` | Histogram | `operation`, `outcome` | Latency of outbound peer requests only (`route="peer"`). For relays, until the owner's supervisor claimed the relay. |
177
177
178
+
Mutation locks:
179
+
180
+
| Metric | Type | Labels | Description |
181
+
|---|---|---|---|
182
+
| `openshell_server_mutation_lock_wait_seconds` | Histogram | `scope` | Time to acquire a mutation lock, recorded for successful acquisitions. |
183
+
| `openshell_server_mutation_lock_timeouts_total` | Counter | `scope` | Acquisitions that waited longer than 10 seconds, including background work such as supervisor disconnect handling and provider credential refresh. API requests fail with `UNAVAILABLE` and reason `MUTATION_LOCK_TIMEOUT`, and [API Errors](/sdk/api-errors) describes how to retry them. A lock connection that PostgreSQL does not open, although at least a second of the wait remained, is not counted. |
0 commit comments