Documentation
Docs
Agent Development

Health Checks

Liveness and Readiness probes for reliable operations.

Why Health Checks?

Kubernetes needs to know if your agent is alive and ready to receive traffic.

Default Behavior

The Sidecar automatically exposes health endpoints which check if it can reach your agent code on port 8080.

Custom Health Logic

If your agent needs to check external dependencies (like a DB connection), implement a /health endpoint.

python
@app.route("/health")
def health():
    if not db.is_connected():
        return "DB Down", 500
    return "OK", 200

Then configure it in agent.yaml:

yaml
health:
  path: /health
  port: 8080
  initialDelaySeconds: 10