Skip to content
SPROOBO · CONTROL-PLANE v0.9.2-rc1ALL SYSTEMS NOMINAL

Health Checks

How health checks work in Sproobo and how to implement them in your application

Health checks let Sproobo verify that your site started correctly after a deployment. If the check fails, the deployment is marked as failed and you can roll back from the deployment history.

How Health Checks Work

After a deployment completes, Sproobo can send an HTTP request to a path on your site to confirm it is responding. If the endpoint returns a successful HTTP status code (2xx), the deployment is marked healthy.

Adding a Health Check Endpoint

Implement a lightweight endpoint in your application that returns 200 OK when the app is ready to serve traffic.

Express.js

javascript
app.get('/health', (req, res) => {
res.status(200).json({ status: 'ok' });
});

FastAPI

python
@app.get("/health")
async def health():
  return {"status": "ok"}

Go

go
http.HandleFunc("/health", func(w http.ResponseWriter, r *http.Request) {
  w.WriteHeader(http.StatusOK)
  w.Write([]byte(`{"status":"ok"}`))
})

Configuring the Health Check Path

Set the health check path in your site settings. Sproobo will call this path after each deployment to verify the app is running.

  1. 1

    Open Site Settings

    Navigate to your site in the dashboard and open the site settings.
  2. 2

    Set Health Check Path

    Enter the path for your health check endpoint (e.g. /health or /api/health).
  3. 3

    Save and Deploy

    Save your settings and trigger a deployment. After the app starts, Sproobo will call the health check path to confirm it is responding.

Best Practices

Health Check Best Practices

  • Keep the endpoint fast and lightweight — avoid expensive database queries
  • Return 200 only when the app is fully ready to handle requests
  • Return a non-2xx status code if a critical dependency (e.g. database) is unavailable
  • Do not expose sensitive information in the health check response

Next Steps