HealthcheckRule

class applications.healthcheck.core.base.HealthcheckRule(workload: Workload, **params: Any)

Bases: ABC

Abstract base class for all healthcheck rules.

Rule authors must: 1. Define params_model class attribute (a Pydantic BaseModel subclass) 2. Implement evaluate() method that returns a list of Alert objects

The base class provides: - Parameter validation via the params_model - Access to the workload context - Data access methods for querying cluster load metrics

Example

>>> from pydantic import BaseModel, Field
>>> from applications.healthcheck.core import HealthcheckRule, Alert
>>> from applications.healthcheck.models import AlertLevel
>>>
>>> class MyRuleParams(BaseModel):
...     threshold: float = Field(default=0.90, ge=0.0, le=1.0)
...
>>> class MyRule(HealthcheckRule):
...     params_model = MyRuleParams
...
...     def evaluate(self) -> list[Alert]:
...         load = self.get_core_load()
...         if load.utilization_rate > self.params.threshold:
...             return [Alert(
...                 level=AlertLevel.HIGH,
...                 title="High core utilization",
...                 description=f"Utilization is {load.utilization_rate:.1%}",
...                 reason=f"Exceeds threshold of {self.params.threshold:.1%}",
...             )]
...         return []

params_model

Class attribute - Pydantic model for parameter validation.

Type:: type[pydantic.main.BaseModel]

params: Instance attribute - Validated parameters for this execution.

workload: Instance attribute - The workload this rule operates on.

property cluster_load: ClusterLoadDataProvider

Get or create the cluster load data provider (cores, cost, CO₂, power).

Type:: ClusterLoadDataProvider

property congestion: CongestionDataProvider

Get or create the congestion data provider (cluster congestion metrics).

Type:: CongestionDataProvider

property cores: CoresDataProvider

Get or create the cores data provider (cores distribution analysis).

Type:: CoresDataProvider

property cores_memory: CoresMemoryDataProvider

Get or create the cores-memory data provider (cores vs memory distribution).

Type:: CoresMemoryDataProvider

abstractmethod evaluate() → list[Alert]

Execute rule logic and return alerts.

This is the main method that rule authors must implement. It should: 1. Access data using the data access methods (self.get_core_load, etc.) 2. Apply business logic to detect issues 3. Return a list of Alert objects for any issues found

Returns:: List of Alert objects. Empty list means no issues detected. Return AlertLevel.OK alerts explicitly if you want to record that the check passed.

Notes