Skip to content

docs: Document configurable HEALTH_CHECK_PATH for load balancing endpoints#707

Merged
lavanya-gunreddi merged 4 commits into
mainfrom
promptless/lb-configurable-health-check-path
Jul 14, 2026
Merged

docs: Document configurable HEALTH_CHECK_PATH for load balancing endpoints#707
lavanya-gunreddi merged 4 commits into
mainfrom
promptless/lb-configurable-health-check-path

Conversation

@promptless

@promptless promptless Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Open this suggestion in Promptless to view citations and reasoning process

Updates the load balancing Serverless overview to document the new configurable health check path. The load balancer now polls the path set by the HEALTH_CHECK_PATH environment variable (defaulting to /ping) instead of a hardcoded /ping, so users running public images that expose health checks at other paths no longer need custom images.

Trigger Events


Tip: Tag @Promptless in a GitHub issue to turn it into a documentation update 🐙


Workers must expose a `/ping` endpoint on the `PORT_HEALTH` port. The load balancer periodically checks this endpoint:
Each worker exposes a health check endpoint on the `PORT_HEALTH` port, and the load balancer polls it periodically to decide whether the worker is healthy enough to receive traffic. By default the load balancer polls `/ping`, but you can point it at any path by setting the `HEALTH_CHECK_PATH` environment variable. This is useful when you deploy a public image whose server already exposes a health check at a different path, such as a `llama.cpp` image that serves `/health`, so you don't need to build a custom image just to satisfy the health check.

@lavanya-gunreddi lavanya-gunreddi Jul 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Promptless Add this note here - You can also set the health check path directly in the RunPod console when creating a new endpoint. The Health check endpoint field appears on the Configure image step. Leave it empty to use the default /ping.

@promptless

promptless Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @lavanya-gunreddi! I've added the <Note> to the Health checks section of the load balancing overview, right after the paragraph that introduces the HEALTH_CHECK_PATH environment variable. It notes that the health check path can also be set via the Health check endpoint field in the Runpod console's Configure image step, and that leaving it empty uses the default /ping.

The update has been pushed to this PR for your review.

@lavanya-gunreddi lavanya-gunreddi merged commit f412625 into main Jul 14, 2026
3 checks passed
@lavanya-gunreddi lavanya-gunreddi deleted the promptless/lb-configurable-health-check-path branch July 14, 2026 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant