Health

AJC-Software Ltd Codex AI Code, TIB-Trader, docs/health.md

Health checks in TIB-Trader

Endpoint

• URL: /healthz/
• Response: JSON with per-check status and HTTP 503 if any check fails.

{
  "ok": true,
  "checks": {
    "database": {"ok": true, "detail": "ok", "latency_ms": 1.2},
    "accounts_db": {"ok": true, "detail": "ok", "latency_ms": 1.1},
    "redis": {"ok": true, "detail": "pong", "latency_ms": 0.7},
    "migrations": {"ok": true, "detail": "up-to-date", "latency_ms": 2.3},
    "accounts_migrations": {"ok": true, "detail": "up-to-date", "latency_ms": 2.1},
    "encryption_key": {"ok": true, "detail": "ok", "latency_ms": -1}
  }
}

What is verified

• database: simple SELECT 1 on the default Postgres connection.
• accounts_db: simple SELECT 1 on the accounts Postgres connection.
• redis: ping against the configured Redis cache.
• migrations: pending migrations check (default DB).
• accounts_migrations: pending migrations check for auth apps on the accounts DB.
• encryption_key: ensures ENCRYPTION_KEY is set.

Usage

• Local direct to Django: curl http://127.0.0.1:8000/healthz/
• Through nginx (with host header): curl -H "Host: app.tib-trader.com" http://127.0.0.1/healthz/

Automation

• Full sweep script: bash scripts/shell/20_health_check.sh (also menu option 8).
• Python syntax guard: bash scripts/shell/15_python_compile_check.sh (menu option 10) runs python -m compileall in python:3.14-slim.
• CI hook: scripts/shell/40_ci.sh chains manage.py check, migrations drift, tests, and docker build.

Related UI

• The Connection page includes a live database status panel plus a test-connection form. This is separate from /healthz/ and intended for operator triage.

Extending

• Add new checks in pmcore/health.py and reference them in run_health_checks().
• Keep checks fast and side-effect free.

Back to wiki home