org.spf4j.actuator.health

Interface HealthCheck

All Known Implementing Classes:

DeadlockHealthCheck

public interface HealthCheck

Author:

Zoltan Farkas

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HealthCheck.Registration
static class	HealthCheck.Type

Field Summary

Fields

Modifier and Type	Field and Description
static HealthCheck	NOP

Method Summary

Modifier and Type	Method and Description
default org.spf4j.base.avro.HealthRecord	getRecord(String name, String origin, org.slf4j.Logger logger, boolean isDebug, boolean isDebugOnError)
default HealthCheck.Type	getType()
String	info()
void	test(org.slf4j.Logger logger) Will run the health check.
default long	timeout(TimeUnit tu)

Field Detail

NOP

static final HealthCheck NOP

Method Detail

test

void test(org.slf4j.Logger logger)
   throws Exception

Will run the health check. If health check is supposed to fail it should throw an Exception.

Parameters:

logger -

Throws:

Exception

getRecord

default org.spf4j.base.avro.HealthRecord getRecord(String name,
                                                   String origin,
                                                   org.slf4j.Logger logger,
                                                   boolean isDebug,
                                                   boolean isDebugOnError)

info

String info()

getType

default HealthCheck.Type getType()

timeout

default long timeout(TimeUnit tu)