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
Copy file name to clipboardExpand all lines: README.md
+30-1Lines changed: 30 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -496,7 +496,7 @@ control:
496
496
497
497
### Helm
498
498
499
-
When the dashboard provisions a new PgDog cluster, it shells out to `helm upgrade --install` against a chart fetched from our Helm repository. `control.config.helm` controls which chart and which reposiory. The defaults point at the public `pgdogdev` chart on `helm.pgdog.dev`, which is what you want unless you mirror the chart internally.
499
+
When the dashboard provisions a new PgDog cluster, it shells out to `helm upgrade --install` against a chart fetched from our Helm repository. `control.config.helm` controls which chart and which repository. The defaults point at the public `pgdogdev` chart on `helm.pgdog.dev`, which is what you want unless you mirror the chart internally.
500
500
501
501
```yaml
502
502
control:
@@ -541,6 +541,33 @@ control:
541
541
| `cloudwatch.lookback_secs` | How far back each fetch reaches. A fresh deploy pulls the full window on its first tick (int, default `3600`). |
542
542
| `cloudwatch.period_secs` | CloudWatch aggregation period. The smallest bucket the metric API returns (int, default `60`). |
543
543
544
+
### Alerting
545
+
546
+
`control.config.alerts`enables outbound alert integrations. Leave `incident_io` unset to disable incident.io. Thresholds are optional and only configured metrics create alerts.
547
+
548
+
```yaml
549
+
control:
550
+
config:
551
+
alerts:
552
+
evaluation_window_secs: 300
553
+
thresholds:
554
+
clients_waiting: 10
555
+
cpu: 90.0
556
+
memory: 2048
557
+
server_connections: 100
558
+
incident_io:
559
+
api_key: inc_live_xxx
560
+
```
561
+
562
+
| Option | Description |
563
+
|-|-|
564
+
| `evaluation_window_secs` | How long metrics must remain at or above threshold before creating an alert (int, default `300`). |
565
+
| `thresholds.clients_waiting` | Number of clients waiting on a server connection (int, optional). |
566
+
| `thresholds.cpu` | CPU usage percentage. Must be between `0.0` and `100.0`, inclusive (float, optional). |
567
+
| `thresholds.memory` | Memory used, in megabytes (int, optional). |
568
+
| `thresholds.server_connections` | Number of open server connections (int, optional). |
569
+
| `incident_io.api_key` | incident.io API key with permission to create incidents. Missing `incident_io` disables the integration (string, optional). |
570
+
544
571
### State store
545
572
546
573
`control.config.store` governs the in-memory metric store: how often it sweeps for stale data, when an instance is marked stale or evicted, and how long per-instance metric history is retained. The defaults are tight enough for an interactive dashboard; widen them if you keep the UI open against a cluster that's intentionally idle, or if you want a longer historical window in memory.
@@ -553,6 +580,7 @@ control:
553
580
stale_after_secs: 5
554
581
evict_after_secs: 60
555
582
metrics_retention_secs: 300
583
+
query_history_limit: 1000
556
584
```
557
585
558
586
| Option | Description |
@@ -561,6 +589,7 @@ control:
561
589
| `stale_after_secs` | Instance is marked stale if its newest metric is older than this. The UI dims it but keeps it visible (int, default `5`). |
562
590
| `evict_after_secs` | Instance is dropped from the store entirely if its newest metric is older than this (int, default `60`). |
563
591
| `metrics_retention_secs` | How much per-instance metric history is kept in memory. Older points are dropped as new ones arrive (int, default `300`). |
592
+
| `query_history_limit` | Per-token historical query store capacity. Oldest deduped query entries are evicted first once the limit is reached (int, default `1000`). |
0 commit comments