Struct HealthCheckInspect 

pub struct HealthCheckInspect { /* private fields */ }

Mirrors a driver’s most recent health check result into its own Inspect hierarchy.

The Rust SDK does not record health check results into a driver’s Inspect tree automatically. A driver that wants its latest health check visible in its own component Inspect hierarchy (at root/driver_health_check, matching the C++ driver SDK schema) creates one of these with the node it wants the record under and calls Self::record from its crate::Driver::health_check:

async fn health_check(&self, request: HealthCheckRequest) -> HealthCheckResult {
    let result = self.check_hardware(request).await;
    self.health_inspect.record(request, &result);
    result
}

Nothing here depends on how the driver publishes Inspect: it works the same with crate::DriverContext::publish_inspect, with crate::DriverContext::inspect_content_publisher, or with an inspector the driver serves itself. Drivers that build their Inspect tree on demand can instead call record_health_check_to_inspect while populating it.

Implementations

impl HealthCheckInspect

pub fn new(parent: &Node) -> Self

Creates a recorder that writes its HEALTH_INSPECT_NODE_NAME child under parent.

Only a weak reference to parent is kept: the driver stays the owner of its Inspect tree, and records are silently dropped once parent has been removed from it.

pub fn record(&self, level: HealthCheckRequest, result: &HealthCheckResult)

Records the result of a health check at level.

To avoid erasing diagnostic state with a routine liveness sweep or a skipped check, non-informative errors (HealthCheckError::NotSupported, HealthCheckError::Unavailable, HealthCheckError::InvalidState) and a healthy HealthCheckRequest::Ping do not overwrite an existing informative record from a deeper check.

pub fn record_alert(&self, alert: &HealthAlert)

Records the details of a HealthAlert::SelfFault the driver is reporting through its HealthAlertReporter, replacing the previous record, so Inspect also reflects faults the driver notices between health checks. Neighbour faults describe other drivers and are ignored.