com.google.jenkins.plugins.health

Class HealthCheck

java.lang.Object

hudson.model.AbstractDescribableImpl<HealthCheck>

com.google.jenkins.plugins.health.HealthCheck

All Implemented Interfaces:

DerivedPageComponent<HealthCheckReport>, hudson.ExtensionPoint, hudson.model.Describable<HealthCheck>

Direct Known Subclasses:

ClassLoaderCheck, ExecutorCheck

public abstract class HealthCheck
extends hudson.model.AbstractDescribableImpl<HealthCheck>
implements DerivedPageComponent<HealthCheckReport>, hudson.ExtensionPoint

A Describable ExtensionPoint to perform health checks. Subclasses need to implement the perform(TaskListener taskListener) method.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
HealthCheck()

Method Summary

Methods

Modifier and Type	Method and Description
static List<hudson.model.Descriptor<HealthCheck>>	all()
abstract hudson.model.Result	perform(hudson.model.TaskListener taskListener) Subclass needs to implement its own health check logic here.
HealthCheckReport	performDerivation() Hook to derive the value of this particular page component.

Methods inherited from class hudson.model.AbstractDescribableImpl

getDescriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HealthCheck

public HealthCheck()

Method Detail

all

public static List<hudson.model.Descriptor<HealthCheck>> all()

Returns:

Descriptors of all HealthCheck extensions.

perform

public abstract hudson.model.Result perform(hudson.model.TaskListener taskListener)

Subclass needs to implement its own health check logic here.

Parameters:

taskListener - the logger to capture logs from performing the checks.

Returns:

generally, this should return Result.SUCCESS in case of a successful health-check and Result.FAILURE otherwise.

performDerivation

public HealthCheckReport performDerivation()

Description copied from interface: DerivedPageComponent

Hook to derive the value of this particular page component. For examples, verify that some piece of Jenkins functionality is working as a component of a health-checking application, or lookup some value for a status metric to display on a status page.

Specified by:

performDerivation in interface DerivedPageComponent<HealthCheckReport>