pub struct HealthApi { /* private fields */ }Expand description
Health checks, readiness, and metrics
Implementations§
Source§impl HealthApi
impl HealthApi
Sourcepub async fn get(&self) -> Result<GetHealthResponse>
pub async fn get(&self) -> Result<GetHealthResponse>
Health check
GET /health
Sourcepub async fn get_metrics(&self) -> Result<String>
pub async fn get_metrics(&self) -> Result<String>
Prometheus-compatible metrics export
GET /metrics
Sourcepub async fn get_ready(&self) -> Result<GetReadyResponse>
pub async fn get_ready(&self) -> Result<GetReadyResponse>
Readiness probe (checks KV connectivity)
GET /ready
Sourcepub async fn health_check_v1alias(&self) -> Result<HealthCheckV1aliasResponse>
pub async fn health_check_v1alias(&self) -> Result<HealthCheckV1aliasResponse>
Liveness (alias of /health)
Identical body to GET /health. Kept for callers that assume every route lives under
/api/v1; new callers should use /health.
GET /api/v1/health
Sourcepub async fn health_live(&self) -> Result<HealthLiveResponse>
pub async fn health_live(&self) -> Result<HealthLiveResponse>
Kubernetes liveness probe
GET /health/live
Sourcepub async fn health_ready(&self) -> Result<ReadinessReport>
pub async fn health_ready(&self) -> Result<ReadinessReport>
Kubernetes readiness probe
GET /health/ready
Sourcepub fn health_sse(&self) -> EventStream
pub fn health_sse(&self) -> EventStream
SSE end-to-end health check
GET /health/sse
Returns a server-sent event stream.
Sourcepub async fn healthz_alias(&self) -> Result<HealthzAliasResponse>
pub async fn healthz_alias(&self) -> Result<HealthzAliasResponse>
Health check alias (/healthz)
GET /healthz
Sourcepub async fn readyz_alias(&self) -> Result<ReadinessReport>
pub async fn readyz_alias(&self) -> Result<ReadinessReport>
Readiness alias (/readyz)
GET /readyz
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for HealthApi
impl !UnwindSafe for HealthApi
impl Freeze for HealthApi
impl Send for HealthApi
impl Sync for HealthApi
impl Unpin for HealthApi
impl UnsafeUnpin for HealthApi
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more