Skip to main content

Class: TemporalHealthController

Defined in: src/health/temporal-health.controller.ts:13

Health check controller for Temporal components

Provides a single comprehensive health endpoint that returns overall system health with detailed metrics for all components including client, worker, discovery, schedules, and metadata.

Constructors​

Constructor​

new TemporalHealthController(temporalService, healthOptions?): TemporalHealthController

Defined in: src/health/temporal-health.controller.ts:14

Parameters​

temporalService​

TemporalService

healthOptions?​

TemporalHealthOptions

Returns​

TemporalHealthController

Methods​

getHealth()​

getHealth(): Promise<MinimalHealthResponse | HealthResponse>

Defined in: src/health/temporal-health.controller.ts:36

Get comprehensive system health status

Returns detailed health information for all Temporal components including:

  • Overall system status (healthy/degraded/unhealthy)
  • Client connection status and health
  • Worker status, availability, and activity count
  • Discovery service status and discovered activities
  • Schedule service status and schedule counts
  • Metadata statistics (classes, methods, totals)
  • Component health summary with counts

Returns​

Promise<MinimalHealthResponse | HealthResponse>

Promise Comprehensive health status