From 547c46cd02f56193fd1aeca98122475f6949abae Mon Sep 17 00:00:00 2001 From: Ishaan Jaff Date: Thu, 31 Jul 2025 17:16:46 -0700 Subject: [PATCH] add When to Use Each Endpoint (#13193) --- docs/my-website/docs/proxy/health.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/my-website/docs/proxy/health.md b/docs/my-website/docs/proxy/health.md index 6788045a0a2..5cd6b5d18a7 100644 --- a/docs/my-website/docs/proxy/health.md +++ b/docs/my-website/docs/proxy/health.md @@ -1,6 +1,15 @@ # Health Checks Use this to health check all LLMs defined in your config.yaml +## When to Use Each Endpoint + +| Endpoint | Use Case | Purpose | +|----------|----------|---------| +| `/health/liveliness` | **Container liveness probes** | Basic alive check - use for container restart decisions | +| `/health/readiness` | **Load balancer health checks** | Ready to accept traffic - includes DB connection status | +| `/health` | **Model health monitoring** | Comprehensive LLM model health - makes actual API calls | +| `/health/services` | **Service debugging** | Check specific integrations (datadog, langfuse, etc.) | + ## Summary The proxy exposes: