Interface ProcessHealthMonitor

interface ProcessHealthMonitor {
    assessHealth(
        process: HealthCheckable,
        overrideReason?: WhyNotHealthy,
    ): null | WhyNotHealthy;
    assessReadiness(
        process: HealthCheckable,
        overrideReason?: WhyNotHealthy,
    ): null | WhyNotReady;
    cleanupProcess(pid: number): void;
    getHealthStats(): {
        monitoredProcesses: number;
        processesWithFailures: number;
        totalHealthCheckFailures: number;
    };
    getProcessHealthState(
        pid: number,
    ):
        | undefined
        | {
            healthCheckFailures: number;
            lastHealthCheck: number;
            lastJobFailed: boolean;
        };
    initializeProcess(pid: number): void;
    isHealthy(
        process: HealthCheckable,
        overrideReason?: WhyNotHealthy,
    ): boolean;
    isReady(process: HealthCheckable, overrideReason?: WhyNotHealthy): boolean;
    maybeRunHealthcheck(
        process: HealthCheckable & {
            execTask: (task: Task<unknown>) => boolean;
        },
    ): undefined
    | Task<unknown>;
    recordJobFailure(pid: number): void;
    recordJobSuccess(pid: number): void;
    resetHealthCheckFailures(pid: number): void;
}

Index

Methods

assessHealth assessReadiness cleanupProcess getHealthStats getProcessHealthState initializeProcess isHealthy isReady maybeRunHealthcheck recordJobFailure recordJobSuccess resetHealthCheckFailures

Methods

assessHealth

assessHealth(
process: HealthCheckable,
overrideReason?: WhyNotHealthy,
): null | WhyNotHealthy
Assess the health of a process and return why it's not healthy, or null if healthy
Parameters
- process: HealthCheckable
- OptionaloverrideReason: WhyNotHealthy
Returns null | WhyNotHealthy
- Defined in src/ProcessHealthMonitor.ts:95

assessReadiness

assessReadiness(
process: HealthCheckable,
overrideReason?: WhyNotHealthy,
): null | WhyNotReady
Assess why a process is not ready (combines health and business)
Parameters
- process: HealthCheckable
- OptionaloverrideReason: WhyNotHealthy
Returns null | WhyNotReady
- Defined in src/ProcessHealthMonitor.ts:119

cleanupProcess

cleanupProcess(pid: number): void
Clean up health monitoring for a process
Parameters
- pid: number
Returns void
- Defined in src/ProcessHealthMonitor.ts:68

getHealthStats

getHealthStats(): {
    monitoredProcesses: number;
    processesWithFailures: number;
    totalHealthCheckFailures: number;
}
Get health statistics for monitoring

Returns {
    monitoredProcesses: number;
    processesWithFailures: number;
    totalHealthCheckFailures: number;
}
- Defined in src/ProcessHealthMonitor.ts:183

getProcessHealthState

getProcessHealthState(
    pid: number,
):
    | undefined
    | {
        healthCheckFailures: number;
        lastHealthCheck: number;
        lastJobFailed: boolean;
    }
Get health check state for a specific process
Parameters
- pid: number
Returns
    | undefined
    | {
        healthCheckFailures: number;
        lastHealthCheck: number;
        lastJobFailed: boolean;
    }
- Defined in src/ProcessHealthMonitor.ts:218

initializeProcess

initializeProcess(pid: number): void
Initialize health monitoring for a process
Parameters
- pid: number
Returns void
- Defined in src/ProcessHealthMonitor.ts:57

isHealthy

isHealthy(process: HealthCheckable, overrideReason?: WhyNotHealthy): boolean
Check if a process is healthy
Parameters
- process: HealthCheckable
- OptionaloverrideReason: WhyNotHealthy
Returns boolean
- Defined in src/ProcessHealthMonitor.ts:112

isReady

isReady(process: HealthCheckable, overrideReason?: WhyNotHealthy): boolean
Check if a process is ready to handle tasks
Parameters
- process: HealthCheckable
- OptionaloverrideReason: WhyNotHealthy
Returns boolean
- Defined in src/ProcessHealthMonitor.ts:129

maybeRunHealthcheck

maybeRunHealthcheck(
    process: HealthCheckable & {
        execTask: (task: Task<unknown>) => boolean;
    },
): undefined
| Task<unknown>
Run a health check on a process if needed
Parameters
- process: HealthCheckable & { execTask: (task: Task<unknown>) => boolean }
Returns undefined | Task<unknown>
- Defined in src/ProcessHealthMonitor.ts:136

recordJobFailure

recordJobFailure(pid: number): void
Record that a job failed for a process
Parameters
- pid: number
Returns void
- Defined in src/ProcessHealthMonitor.ts:75

recordJobSuccess

recordJobSuccess(pid: number): void
Record that a job succeeded for a process
Parameters
- pid: number
Returns void
- Defined in src/ProcessHealthMonitor.ts:85

resetHealthCheckFailures

resetHealthCheckFailures(pid: number): void
Reset health check failures for a process (useful for recovery scenarios)
Parameters
- pid: number
Returns void
- Defined in src/ProcessHealthMonitor.ts:208

Interface ProcessHealthMonitor

Index

Methods

Methods

assessHealth

Parameters

Returns null | WhyNotHealthy

assessReadiness

Parameters

Returns null | WhyNotReady

cleanupProcess

Parameters

Returns void

getHealthStats

Returns { monitoredProcesses: number; processesWithFailures: number; totalHealthCheckFailures: number;}

getProcessHealthState

Parameters

Returns | undefined | { healthCheckFailures: number; lastHealthCheck: number; lastJobFailed: boolean; }

initializeProcess

Parameters

Returns void

isHealthy

Parameters

Returns boolean

isReady

Parameters

Returns boolean

maybeRunHealthcheck

Parameters

Returns undefined | Task<unknown>

recordJobFailure

Parameters

Returns void

recordJobSuccess

Parameters

Returns void

resetHealthCheckFailures

Parameters

Returns void

Settings

On This Page

Returns {
monitoredProcesses: number;
processesWithFailures: number;
totalHealthCheckFailures: number;
}

Returns
| undefined
| {
healthCheckFailures: number;
lastHealthCheck: number;
lastJobFailed: boolean;
}