jenkins.metrics.api

Class HealthCheckProvider

java.lang.Object

jenkins.metrics.api.HealthCheckProvider

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

JenkinsHealthCheckProviderImpl

public abstract class HealthCheckProvider
extends Object
implements hudson.ExtensionPoint

Provides HealthCheck instances to register.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
HealthCheckProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected static Map.Entry<String,com.codahale.metrics.health.HealthCheck>	check(String name, com.codahale.metrics.health.HealthCheck metric)
protected static Map.Entry<String,com.codahale.metrics.health.HealthCheck>	check(String name, com.codahale.metrics.health.HealthCheck metric, boolean enabled)
protected static Map<String,com.codahale.metrics.health.HealthCheck>	checks(Map.Entry<String,com.codahale.metrics.health.HealthCheck>... metrics)
abstract Map<String,com.codahale.metrics.health.HealthCheck>	getHealthChecks() A map of HealthCheck instances keyed by name.

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckProvider

public HealthCheckProvider()

Method Detail

check

protected static Map.Entry<String,com.codahale.metrics.health.HealthCheck> check(String name,
                                                              com.codahale.metrics.health.HealthCheck metric)

check

protected static Map.Entry<String,com.codahale.metrics.health.HealthCheck> check(String name,
                                                              com.codahale.metrics.health.HealthCheck metric,
                                                              boolean enabled)

checks

protected static Map<String,com.codahale.metrics.health.HealthCheck> checks(Map.Entry<String,com.codahale.metrics.health.HealthCheck>... metrics)

getHealthChecks

@NonNull
public abstract Map<String,com.codahale.metrics.health.HealthCheck> getHealthChecks()

A map of HealthCheck instances keyed by name.

Returns:

a map of HealthCheck instances keyed by name.