add When to Use Each Endpoint (#13193)

This commit is contained in:
Ishaan Jaff 2025-07-31 17:16:46 -07:00 committed by GitHub
parent cc4881eedd
commit 547c46cd02
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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: