com.google.jenkins.plugins.health

Class HealthZone

java.lang.Object

com.google.jenkins.plugins.health.lib.DerivedPageZone<HealthCheck,HealthCheckReport>

com.google.jenkins.plugins.health.HealthZone

All Implemented Interfaces:

hudson.model.Describable<HealthZone>, hudson.model.ModelObject

@ExportedBean
public class HealthZone
extends DerivedPageZone<HealthCheck,HealthCheckReport>
implements hudson.model.Describable<HealthZone>

A HealthZone is a named container for HealthChecks. The main use case for separating the checks into different grouping is to allow for different severity levels, different listeners, etc... For examples, critical health metrics may require immediate actions, while low severity ones may need a reaction only once a day. Each HealthZone has a unique URL "/health/zone/${zoneName}".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HealthZone.DescriptorImpl Descriptor of HealthZone.
static class	HealthZone.ErrorApi An implementation of Api that can give a better error message for our use case.

Constructor Summary

Constructors

Constructor and Description
HealthZone(String name, List<HealthCheck> healthChecks)

Method Summary

Methods

Modifier and Type	Method and Description
protected HealthCheckReport	derivePageComponent(HealthCheck check) Return the component's Report indicating the success of the derivation and any result obtained from it.
hudson.model.Api	getApi()
HealthCheckReport	getCombinedReport()
hudson.model.Result	getCombinedResult()
hudson.model.Descriptor<HealthZone>	getDescriptor()
static List<hudson.model.Descriptor<HealthZone>>	getDescriptors()
String	getDisplayName()
protected String	namePageComponent(HealthCheck component) Provide the key by which a Component's derived result will be indexed and displayed to the user.

Methods inherited from class com.google.jenkins.plugins.health.lib.DerivedPageZone

getComponents, getName, getReports

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthZone

@DataBoundConstructor
public HealthZone(String name,
                               List<HealthCheck> healthChecks)

Parameters:

name - the name of this HealthZone.

healthChecks - a list of HealthChecks to contain.

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface hudson.model.ModelObject

getApi

public hudson.model.Api getApi()

namePageComponent

protected String namePageComponent(HealthCheck component)

Description copied from class: DerivedPageZone

Provide the key by which a Component's derived result will be indexed and displayed to the user. For examples, a name passed to the component's constructor on page configuration, or the name of the component class when there will be no reuse within a page.

Specified by:

namePageComponent in class DerivedPageZone<HealthCheck,HealthCheckReport>

derivePageComponent

protected HealthCheckReport derivePageComponent(HealthCheck check)

Return the component's Report indicating the success of the derivation and any result obtained from it. In this implementation the success indicator is the value, and debugging information is appended as the report's value.

Specified by:

derivePageComponent in class DerivedPageZone<HealthCheck,HealthCheckReport>

getCombinedReport

public HealthCheckReport getCombinedReport()

Returns:

the result combined from individual HealthCheck results.

getCombinedResult

public hudson.model.Result getCombinedResult()

getDescriptors

public static List<hudson.model.Descriptor<HealthZone>> getDescriptors()

Returns:

the list of Descriptor for HealthZones.

getDescriptor

@Nullable
public hudson.model.Descriptor<HealthZone> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<HealthZone>