.do
ApiAnalytics

HealthCheck

A service health check that monitors system availability, performance, and dependencies.

HealthCheck

A service health check that monitors system availability, performance, and dependencies.

Properties

  • id (string): Unique identifier for the health check.
  • name (string): Name of the health check.
  • description (string): Description of what this health check monitors.
  • service (string): Service being monitored.
  • type (string): Check type (liveness, readiness, startup, dependency).
  • status (string): Current health status (healthy, degraded, unhealthy, unknown).
  • timestamp (number): Time of last health check execution (Unix timestamp).
  • duration (number): Duration of last health check execution in milliseconds.
  • interval (number): Interval between health checks in seconds.
  • timeout (number): Timeout for health check execution in milliseconds.
  • retries (number): Number of retries before marking unhealthy.
  • endpoint (string): URL or endpoint being checked.
  • method (string): HTTP method or check protocol.
  • expectedStatus (number): Expected HTTP status code or response.
  • actualStatus (number): Actual HTTP status code or response received.
  • message (string): Health check result message.
  • checks (object[]): Individual component checks and their statuses.
  • dependencies ([[HealthCheck]][]): Health of dependent services.
  • metrics (object): Performance metrics from health check.
  • uptime (number): Service uptime in seconds.
  • uptimePercentage (number): Service uptime percentage.
  • environment (string): Environment being monitored (production, staging, development).
  • version (string): Application version being monitored.
  • lastHealthy (number): Time when service was last healthy (Unix timestamp).
  • lastUnhealthy (number): Time when service was last unhealthy (Unix timestamp).
  • consecutiveFailures (number): Number of consecutive failed checks.
  • tags (string[]): Tags for categorizing and filtering.
  • metadata (object): Set of key-value pairs for storing additional information.

Actions

create

Create a new health check configuration.

Input: [[HealthCheck]]
Output: [[HealthCheck]]

update

Update health check configuration.

Input: [[HealthCheck]]
Output: [[HealthCheck]]

execute

Execute the health check immediately.

Input: [[HealthCheck]]
Output: [[HealthCheck]]

enable

Enable automatic health check execution.

Input: [[HealthCheck]]
Output: [[HealthCheck]]

disable

Disable automatic health check execution.

Input: [[HealthCheck]]
Output: [[HealthCheck]]

query

Search and retrieve health checks matching criteria.

Input: [[HealthCheckQuery]]
Output: [[HealthCheck]][]

monitor

Create continuous monitoring for health check.

Input: [[HealthCheckMonitor]]
Output: [[Monitor]]

export

Export health check data to external format.

Input: [[HealthCheckExport]]
Output: [[File]]

delete

Permanently remove the health check.

Input: [[HealthCheck]]
Output: [[HealthCheck]]

Events

  • created: Triggered when a new health check is created.
  • updated: Triggered when health check configuration is updated.
  • deleted: Triggered when health check is permanently removed.
  • executed: Triggered when health check is executed.
  • passed: Triggered when health check passes.
  • failed: Triggered when health check fails.
  • Degraded: Triggered when service becomes degraded.
  • Recovered: Triggered when service recovers to healthy state.
  • Timeout: Triggered when health check times out.