Skip to main content

Module health

Module health 

Source
Expand description

Product-neutral health report models and runner.

The types in this module describe component health and aggregate status. Product crates decide which components to probe and how to map the report into HTTP responses, task results, metrics, or admin UI payloads.

Structs§

HealthCheckDescriptor
Static description of a registered health check.
HealthCheckOptions
Options applied to a registered health check.
HealthCheckRegistry
Registry and concurrent runner for product-provided health checks.
HealthCheckRegistryBuilder
Builder for health check registries with shared defaults.
HealthCheckScopes
Scope membership for a registered health check.
HealthComponentDetail
Structured diagnostic detail attached to a component report.
HealthComponentReport
Health status for one named component.
SystemHealthReport
Aggregate health report for a service instance.

Enums§

HealthCheckRequirement
Requirement level for a registered health check.
HealthCheckScope
Runtime view used when selecting which registered checks to run.
HealthComponentDetailValue
Typed diagnostic value attached to a component detail.
HealthStatus
Coarse status for a health component or an aggregate system report.

Traits§

HealthMetricsRecorder
Product-side bridge for recording health reports into a metrics backend.