Skip to content

Commit dec88a1

Browse files
authored
fix(metrics): maxwait description (#60)
1 parent 46a248e commit dec88a1

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

docs/administration/pools.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ The following information is returned for each connection pool (user/database pa
2626
| `sv_active` | Number of checked out (used) server connections in the pool. | `12` |
2727
| `sv_idle_xact` | Number of idle-in-transaction server connections in the pool. | `0` |
2828
| `sv_total` | Total number of server connections in the pool. | `20` |
29-
| `maxwait` | Maximum wait time for connections. | `30` |
30-
| `maxwait_us` | Maximum wait time for connections in microseconds. | `30000000` |
29+
| `maxwait` | How long the first (oldest) client in the queue has waited, in seconds. | `30` |
30+
| `maxwait_us` | Microsecond part of the `maxwait` value. | `30000000` |
3131
| `pool_mode` | Connection pooling mode. | `transaction` |
3232
| `paused` | The pool is paused and won't issue connections until resumed. | `f` |
3333
| `banned` | The pool is blocked from serving more clients. | `f` |

docs/enterprise_edition/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,5 @@ The default value is **1 second**, which should be sufficient to debug most prod
2929
Once the metrics reach the control plane, they are pushed down to the web dashboard via a real-time connection. Per-minute aggregates are computed in the background and stored in a separate PostgreSQL database, which provides a historical view into overall database performance.
3030

3131
<center>
32-
<img src="/images/ee/metrics.png" width="100%" alt="How PgDog works" class="screenshot" />
32+
<img src="/images/ee/metrics.png" width="100%" alt="PgDog Real-time Metrics" class="screenshot" />
3333
</center>

docs/features/metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ The following metrics are exported via the OpenMetrics endpoint:
7575
| `sv_active` | Servers currently serving client requests. | `gauge` |
7676
| `sv_idle` | Servers available for clients to use. | `gauge` |
7777
| `sv_idle_xact` | Servers currently idle in transaction. | `gauge` |
78-
| `maxwait` | How long clients have been waiting for a connection (in seconds). | `gauge` |
78+
| `maxwait` | How long the first (oldest) client in the queue has waited (in seconds). | `gauge` |
7979
| `errors` | Errors that connections in the pool have experienced. | `counter` |
8080
| `out_of_sync` | Connections that have been returned to the pool in a broken state. | `counter` |
8181
| `total_xact_count` | Total number of executed transactions. | `counter` |

0 commit comments

Comments
 (0)