GoForjUnreleased

Appearance

Health and Readiness ​

Health and readiness answer different operational questions.

Health says the process is alive. Readiness says the App can serve traffic safely.

Health ​

bash
curl http://localhost:3000/-/health

For an additional app running on its generated local default:

bash
curl http://localhost:3001/-/health

GoForj Apps return a fixed 200 response:

json
{"status":"ok"}

Health does not run dependency checks. Use it for container liveness and "is the process answering HTTP?" probes.

Readiness ​

bash
curl http://localhost:3000/-/ready

For an additional app, prefix the command with the app name:

bash
curl http://localhost:3001/-/ready

GoForj Apps return:

  • 200 with {"status":"ready","app":"app"} when all readiness checks pass
  • 503 with {"status":"not_ready","app":"app"} when any readiness check fails

Readiness checks run sequentially against enabled infrastructure components and use a two-second timeout per check. Set the deployment probe's total timeout high enough for the number of configured checks. Failed readiness checks are logged server-side.

Authorized Readiness ​

Detailed readiness output should require:

text
Authorization: Bearer $APP_DIAG_TOKEN

Public readiness omits raw dependency errors and infrastructure details. Authorized readiness includes structured checks with type, name, driver, status, and the raw error for failed checks.

Example authorized failure shape:

json
{
  "status": "not_ready",
  "checks": [
    {
      "type": "db",
      "name": "default",
      "driver": "mysql",
      "status": "failed",
      "error": "dial tcp 127.0.0.1:3306: connect: connection refused"
    }
  ]
}

Health Command ​

GoForj Apps include a generated health command that queries a live App without booting local runtime dependencies.

bash
./bin/app health --probe ready --timeout-ms 10000 --fail

The command defaults to http://127.0.0.1:3000, uses ready by default, and automatically sends Authorization: Bearer $APP_DIAG_TOKEN for readiness when the token is configured. Its default request timeout is two seconds; increase --timeout-ms when the App has several readiness checks.

For the staff operations App, use the admin binary:

bash
./bin/admin health --probe ready --fail

If you override admin's HTTP port, pass the matching base URL or full probe URL as the command's URL argument.

bash
./bin/admin health http://127.0.0.1:3100 --probe ready --fail

What to Check ​

Readiness can cover:

  • database connectivity
  • required storage disks
  • required cache accessors
  • queue backend readiness
  • event backend readiness
  • generated component state

Optional facilities should report degraded state instead of crashing unrelated runtimes when the App is designed to tolerate degradation.

Next Steps ​