docs: correct Health Check & Observability in the beta README
spikersoft-backend@master SpikerSoft.Api/Extensions/ServiceCollectionExtensions.cs:286 Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
1 parent
37801c255e
commit
73e37252c7
1 file changed
+9
-7
@@ -2536,9 +2536,9 @@ The app's one non-`/tm` call is the shared `Geocoding` controller. There is no w
|
||||
|
||||
The platform exposes a comprehensive `/healthz` endpoint that validates the entire infrastructure stack. This endpoint powers uptime monitoring and aids rapid diagnosis during incidents.
|
||||
|
||||
### Health Checks (13 total)
|
||||
### Health Checks (15 by default)
|
||||
|
||||
Registered in `SpikerSoft.Api` `AddHealthChecksConfiguration` (order in code: RabbitMQ, MongoDB, MongoDB Indexes, Redis Cluster, Vector Search, Keycloak, InfluxDB, Email Server, DNS Server, DKIM, DMARC, SPF, Postal Code Data).
|
||||
Registered in `SpikerSoft.Api` `AddHealthChecksConfiguration`. Always on, in code order: RabbitMQ, MongoDB, MongoDB Indexes, Redis Cluster, Vector Search, Keycloak, InfluxDB, Email Server, DKIM Validation, DMARC Validation, SPF Validation, Postal Code Data, Transport Security. `HealthChecks:Tls:Enabled` defaults to true and adds Certificate Files and TLS Endpoints, so a production `/healthz` report has 15 checks. Set that flag false and those two are omitted (13).
|
||||
|
||||
| Check | What It Validates |
|
||||
|-------|-------------------|
|
||||
@@ -2546,15 +2546,17 @@ Registered in `SpikerSoft.Api` `AddHealthChecksConfiguration` (order in code: Ra
|
||||
| **MongoDB Indexes** | Expected indexes exist on the collections that need them |
|
||||
| **Redis Cluster** | All 6 nodes connected (3 masters + 3 replicas), cluster state `ok`, slot coverage |
|
||||
| **RabbitMQ** | Queue health, consumer counts, message depth, DLQ status |
|
||||
| **Vector Search** | Redis vector index exists (default name `idx:BookPageChunk`, overridable via `VectorSearch:IndexName`) |
|
||||
| **Vector Search** | Redis vector index exists. Shipped `VectorSearch:IndexName` is `book_chunks_idx`; if that key is absent the check uses `idx:BookPageChunk` |
|
||||
| **Keycloak** | Authentication endpoint reachable at `ids.spikersoft.com` |
|
||||
| **InfluxDB** | Ping, bucket existence, write/query round-trip at `influxdb.spikersoft.com` |
|
||||
| **Email Server** | SMTP connection to `mail.spikersoft.com:587`, STARTTLS, authentication |
|
||||
| **DNS Server** | Self-hosted DNS at `192.168.0.105:5380` responding |
|
||||
| **Email Server** | TCP connect to `Email:Host`:`Email:Port` (shipped `mail.spikersoft.com:587`), plus a PTR lookup. This check does not negotiate STARTTLS or authenticate |
|
||||
| **DKIM** | DKIM record valid for `spikersoft.com` (selector: `mail`, RSA key) |
|
||||
| **DMARC** | DMARC policy active (`quarantine`) with aggregate reporting |
|
||||
| **SPF** | SPF record valid with `-all` (hard fail for unauthorized senders) |
|
||||
| **SPF** | Looks up the SPF TXT record and reports the `all` mechanism. The published record ends in `-all` |
|
||||
| **Postal Code Data** | MongoDB `postal-codes` collection has rows; **Degraded** if empty (seed via `POST /api/PostalCodes/seed`) — see `PostalData_HealthCheck` |
|
||||
| **Transport Security** | Always Healthy. Reports whether each dependency is plaintext, TLS, or mTLS, and which server certificates the clients were shown |
|
||||
| **Certificate Files** | Present when `HealthChecks:Tls:Enabled` is true (the default). Checks the Redis, Mongo, and Kestrel certificate files exist, parse, and chain |
|
||||
| **TLS Endpoints** | Present when `HealthChecks:Tls:Enabled` is true. Handshakes the configured endpoints and reports protocol, trust, and days left |
|
||||
|
||||
### Observability Stack
|
||||
|
||||
@@ -2570,7 +2572,7 @@ Registered in `SpikerSoft.Api` `AddHealthChecksConfiguration` (order in code: Ra
|
||||
│ └──────────────┘ └──────────────┘ └──────────────┘ │
|
||||
│ │
|
||||
│ ┌──────────────────────────────────────────────────┐ │
|
||||
│ │ /healthz — 13 infrastructure checks │ │
|
||||
│ │ /healthz — 15 checks by default (13 if TLS off) │ │
|
||||
│ │ RabbitMQ DLQ monitoring + retry tier escalation │ │
|
||||
│ │ Correlation IDs across all cross-service calls │ │
|
||||
│ └──────────────────────────────────────────────────┘ │
|
||||
|
||||
Reference in new issue
Block a user