Health

A measure of the operational status, performance, and reliability of a system, service, or component.

Properties

• id (string): Unique identifier for the health record
• name (string): Display name of the monitored entity
• targetId (string): ID of the entity being monitored
• targetType (string): Type of entity (Cluster, Microservice, Node, etc.)
• status (string): Overall health status (healthy, degraded, unhealthy, unknown)
• score (number): Health score (0-100)
• availability (number): Availability percentage
• uptime (number): Uptime in seconds
• lastCheck (Date): Timestamp of last health check
• metrics (object): Key health metrics (CPU, memory, latency, etc.)
• issues (object[]): List of detected issues or problems
• warnings (string[]): Warning messages
• errors (string[]): Error messages
• dependencies (object[]): Health status of dependencies
• checks (object[]): Individual health check results
• threshold (object): Thresholds for health status determination
• createdAt (Date): Creation timestamp
• updatedAt (Date): Last update timestamp

Actions

create

Initialize health monitoring for an entity

Input: [[Health]]
Output: [[Health]]

read

Retrieve current health status

Input: string
Output: [[Health]]

update

Update health metrics

Input: [[Health]]
Output: [[Health]]

delete

Remove health monitoring

Input: string
Output: boolean

list

List all health records

Input: object
Output: [[Health]][]

check

Perform health check

Input: string
Output: [[Health]]

diagnose

Run diagnostic checks

Input: string
Output: object

heal

Attempt automatic remediation

Input: string
Output: [[Health]]

alert

Send health alert

Input: object
Output: void

Events

• created: Fired when health monitoring is initialized
• updated: Fired when health status changes
• deleted: Fired when health monitoring is removed
• degraded: Fired when health degrades
• unhealthy: Fired when entity becomes unhealthy
• recovered: Fired when entity recovers to healthy state
• checked: Fired when health check completes