Skip to content

Commit bb7391c

Browse files
authored
feat: add EE metrics description (#61)
1 parent b35ed12 commit bb7391c

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

docs/enterprise_edition/metrics.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,82 @@ Once the metrics reach the control plane, they are pushed down to the web dashbo
3131
<center>
3232
<img src="/images/ee/metrics.png" width="100%" alt="PgDog Real-time Metrics" class="screenshot" />
3333
</center>
34+
35+
## Available dashboard metrics
36+
37+
Dashboard metrics are distinct from the [OpenMetrics endpoint](../features/metrics.md). They use millisecond units throughout and are collected at specified intervals.
38+
39+
### Connection pool
40+
41+
| Metric | Description |
42+
|--------|-------------|
43+
| Clients | Total number of clients connected to PgDog. |
44+
| Server Connections | Total server connections open across all pools. |
45+
| Connection Rate (cps) | New server connections established from PgDog to PostgreSQL per second. |
46+
| Waiting | Clients currently queued waiting for a server connection. |
47+
| Max Wait (ms) | Age of the oldest client currently waiting for a connection. Resets to zero when the queue drains. Useful for spotting individual outlier waits. |
48+
| Idle Connections | Server connections open and available for use. |
49+
| Idle in Transaction Connections | Server connections currently idle inside an open transaction. Historical chart data for this metric is not currently tracked and will show zero. |
50+
| Checked Out | Server connections currently serving an active client request. |
51+
| Instances | Number of PgDog instances currently connected to the control plane. |
52+
53+
### Errors
54+
55+
| Metric | Description |
56+
|--------|-------------|
57+
| Errors | Client-facing errors per second across all pools. |
58+
| Server Errors | Errors reported by upstream PostgreSQL servers per second. |
59+
60+
### Query throughput
61+
62+
| Metric | Description |
63+
|--------|-------------|
64+
| Queries | Queries executed through PgDog per second. |
65+
| Transactions | Transactions completed per second. |
66+
| Transaction Rate (tps) | Rolling average transactions per second. |
67+
| Query Rate (qps) | Rolling average queries per second. |
68+
| Blocked Queries | Queries blocked by lock contention per second. |
69+
70+
### Timing and latency
71+
72+
| Metric | Description |
73+
|--------|-------------|
74+
| Query Time (ms) | Total query execution time per second. Does not include connection wait. |
75+
| Transaction Time (ms) | Total transaction execution time per second. Includes idle-in-transaction time; does not include connection wait. |
76+
| Idle in Transaction Time (ms) | Time per second spent idle inside open transactions. Elevated values indicate clients holding transactions open without executing queries. |
77+
| Wait Time (ms) | Total time all clients spent waiting for a server connection per second. Unlike Max Wait, this stays elevated when many clients are waiting briefly. |
78+
| Query Response Time (ms) | Full client-observed query latency per second, including connection wait time. |
79+
| Transaction Response Time (ms) | Full client-observed transaction latency per second, including connection wait time. |
80+
81+
!!! note "Max Wait vs Wait Time"
82+
**Max Wait** captures the worst single waiter at one instant — it drops to zero the moment that client is served.
83+
**Wait Time** measures total queuing burden per second across all clients — it stays elevated when many clients are waiting briefly.
84+
Use both together: high Max Wait with low Wait Time points to a single slow client; high Wait Time with low Max Wait indicates widespread shallow queuing.
85+
86+
### Network throughput
87+
88+
| Metric | Description |
89+
|--------|-------------|
90+
| Bytes Received (MB) | Megabytes received from PostgreSQL servers per second. |
91+
| Bytes Sent (MB) | Megabytes sent to PostgreSQL servers per second. |
92+
93+
### Memory and caching
94+
95+
| Metric | Description |
96+
|--------|-------------|
97+
| Prepared Statements | Number of prepared statements in the PgDog global cache. |
98+
| Prepared Statements Memory (MB) | Memory consumed by the prepared statements cache. |
99+
| Query Cache Size | Number of parsed queries stored in the query cache. |
100+
| Query Cache Hits | AST query cache hits per second. |
101+
| Query Cache Misses | AST query cache misses per second. |
102+
| Query Cache Hit Rate (%) | Percentage of queries served from the query cache. |
103+
| Direct Shard Queries | Queries routed to a single shard per second. |
104+
| Cross-Shard Queries | Queries broadcast to multiple shards per second. |
105+
| Direct Shard Hit Rate (%) | Percentage of queries that avoided a cross-shard fanout. |
106+
107+
### Query stats
108+
109+
| Metric | Description |
110+
|--------|-------------|
111+
| Query Stats Tracked Queries | Number of unique query fingerprints currently tracked. |
112+
| Query Stats Memory (MB) | Memory consumed by the query stats store. |

0 commit comments

Comments
 (0)