Table of Contents

Class HealthCheckResult

Namespace
Typhon.Engine
Assembly
Typhon.Engine.dll

Detailed result from a Typhon health check.

public sealed class HealthCheckResult
Inheritance
HealthCheckResult
Inherited Members

Constructors

HealthCheckResult() 

public HealthCheckResult()

Properties

Data

Additional diagnostic data for dashboards and debugging.

public IReadOnlyDictionary<string, object> Data { get; init; }

Property Value

IReadOnlyDictionary<string, object>

Remarks

Common keys include:

  • "most_utilized_path": Path of highest utilization node
  • "most_utilized_percent": Utilization percentage
  • "degraded_resources": List of degraded resource paths
  • "unhealthy_resources": List of unhealthy resource paths
  • "contention_hotspots": Resources with high wait times

Description

Human-readable description of the health status.

public string Description { get; init; }

Property Value

string

Examples

"All resources healthy" or "Storage/PageCache at 92% utilization (Degraded)"

MostUtilizedNode

The resource node with highest utilization, if any have capacity metrics. Null if no capacity metrics exist or snapshot is empty.

public NodeSnapshot MostUtilizedNode { get; init; }

Property Value

NodeSnapshot

Status

Overall health status.

public HealthStatus Status { get; init; }

Property Value

HealthStatus

Methods

Healthy()

Creates a healthy result with no diagnostic data.

public static HealthCheckResult Healthy()

Returns

HealthCheckResult