For the complete documentation index, see llms.txt.

Documentation

Repository docs

This route renders the repository README and markdown under docs/ .

Source: docs/HEALTH_CHECKS.md

Rendered document

docs/HEALTH_CHECKS.md

Parsed server-side (markdown to HTML in the app). Same bytes you get from the checkout.

Health Checks

Smart Deploy verifies your app is reachable after deploy and continues probing running deployments for runtime health.

Post-deploy verification

After ECS rollout (or static publish), the deploy pipeline runs verification:

SettingValue
Paths probed/, /health, /healthz, /api/health
SuccessHTTP 2xx or 3xx on any path
WindowUp to ~5 minutes with multiple rounds
On failureDeploy status failed, code DEPLOYMENT_VERIFICATION_FAILED

Verification logs include ECS service events and filtered CloudWatch excerpts on failure.

Adding a health endpoint (recommended)

Expose a lightweight route that returns 200 when your app is ready:

// Express example
app.get('/health', (_req, res) => res.status(200).send('ok'));
# FastAPI example
@app.get("/health")
def health():
    return {"status": "ok"}

If your app only serves SPA routes, / may return 200 once the server is up — verification can succeed without a dedicated /health.

Database-dependent health

For production-grade checks, verify critical dependencies:

app.get('/health', async (_req, res) => {
  await db.ping();
  res.status(200).send('ok');
});

Keep checks fast — verification runs repeatedly during the deploy window.

Static sites

Static S3 deploys verify the public URL serves expected content (HTTP success on probed paths). No container process — ensure index.html is at the correct S3 prefix.

Common verification failures

SymptomLikely cause
Connection refusedApp not listening on PORT; container crashed on start
502/503 from ALBTasks not healthy; app still starting or wrong port
404 on all pathsWrong start command or missing build output
TimeoutSlow cold start; increase readiness in app or optimize startup

See Startup and Runtime Failures.

Runtime health (ongoing)

Separate from deploy verification, a background reconciler probes running deployments every ~10 minutes.

See Runtime Health.

Related