nick/nick-doc
3
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: sync from deployment 38cb75b — pg store defaults

Browse Source
This commit is contained in:
Siavash Sameni
2026-06-01 21:40:42 +04:00
parent 8a90bb69be
commit e908cfce63
5 changed files with 57 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
08 - Operations/Gatus Monitoring - Proposed Config.md
View File

@@ -91,6 +91,8 @@ Each `checks.*.ok` reflects the current backend state, except `rnApi`, which is
**Backend work:** ✅ Complete (2.6.49). Includes `healthCheckService` with 5 checks, route wired in `app.ts`, rate-limiter + logging skip, and 5 route-level unit tests.
**Postgres cutover monitoring:** As of deployment `38cb75b`, the live dev config also asserts `checks.postgres.enabledStoreCount >= 7` plus the individual `checks.postgres.storeModes.* == "postgres"` values for auth, config, address, category, level config, shop settings, and reviews.
---
## Proposed Gatus config
@@ -140,6 +142,14 @@ endpoints:
- "[BODY].checks.postgres.ok == true"
- "[BODY].checks.postgres.configured == true"
- "[BODY].checks.postgres.required == true"
- "[BODY].checks.postgres.enabledStoreCount >= 7"
- "[BODY].checks.postgres.storeModes.auth == \"postgres\""
- "[BODY].checks.postgres.storeModes.config == \"postgres\""
- "[BODY].checks.postgres.storeModes.address == \"postgres\""
- "[BODY].checks.postgres.storeModes.category == \"postgres\""
- "[BODY].checks.postgres.storeModes.levelConfig == \"postgres\""
- "[BODY].checks.postgres.storeModes.shopSettings == \"postgres\""
- "[BODY].checks.postgres.storeModes.review == \"postgres\""
- "[BODY].checks.redis.ok == true"
- "[BODY].checks.rnChainRegistry.ok == true"
- "[BODY].checks.rnChainRegistry.chainCount >= 1"

2
08 - Operations/Monitoring.md
View File

@@ -14,7 +14,7 @@ What's instrumented today and what to watch. Today's stack is intentionally lean
Two paths are registered (both are public, rate-limited, not auth-gated):
- `GET /health` — simple ping used by Docker healthchecks. Returns `200 { success, message, timestamp, environment, version }`. Does **not** probe MongoDB or Redis.
- `GET /api/health` — deep health check added in commit `44579d6` (backend v2.6.49). Calls `runHealthChecks` from `backend/src/services/health/healthCheckService.ts`. Probes MongoDB, Postgres, Redis, Request Network registry data, and Request Network API reachability. Returns `503` only when `report.status === 'down'`. As of backend `2.8.11`, Postgres is a hard dependency only when at least one `*_STORE=postgres` flag is enabled; otherwise an unconfigured Postgres check is reported as skipped. The Postgres check also reports active store modes so monitoring can distinguish "PG is reachable" from "this runtime is actually using PG-backed stores".
- `GET /api/health` — deep health check added in commit `44579d6` (backend v2.6.49). Calls `runHealthChecks` from `backend/src/services/health/healthCheckService.ts`. Probes MongoDB, Postgres, Redis, Request Network registry data, and Request Network API reachability. Returns `503` only when `report.status === 'down'`. As of backend `2.8.11`, Postgres is a hard dependency only when at least one `*_STORE=postgres` flag is enabled; otherwise an unconfigured Postgres check is reported as skipped. The Postgres check also reports active store modes so monitoring can distinguish "PG is reachable" from "this runtime is actually using PG-backed stores". As of deployment `38cb75b`, dev Gatus requires all seven PG-capable store modes to be `postgres` and `enabledStoreCount >= 7`.
`GET /api/health` response shape (from `healthCheckService`):
```json