程序包 org.springframework.boot.actuate.health

类 AbstractHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

所有已实现的接口:

HealthContributor, HealthIndicator

直接已知子类:

AvailabilityStateHealthIndicator, CassandraDriverHealthIndicator, CouchbaseHealthIndicator, DataSourceHealthIndicator, DiskSpaceHealthIndicator, ElasticsearchRestClientHealthIndicator, HazelcastHealthIndicator, JmsHealthIndicator, LdapHealthIndicator, MailHealthIndicator, MongoHealthIndicator, Neo4jHealthIndicator, PingHealthIndicator, RabbitHealthIndicator, RedisHealthIndicator, SslHealthIndicator

public abstract class AbstractHealthIndicator
extends Object
implements HealthIndicator

Base HealthIndicator implementations that encapsulates creation of Health instance and error handling.

This implementation is only suitable if an Exception raised from doHealthCheck(org.springframework.boot.actuate.health.Health.Builder) should create a Status.DOWN health status.

从以下版本开始:

1.1.0

作者:

Christian Dupuis

构造器概要

构造器

限定符	构造器	说明
protected	AbstractHealthIndicator()	Create a new AbstractHealthIndicator instance with a default healthCheckFailedMessage.
protected	AbstractHealthIndicator(String healthCheckFailedMessage)	Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.
protected	AbstractHealthIndicator(Function<Exception,String> healthCheckFailedMessage)	Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.

方法概要

修饰符和类型	方法	说明
protected abstract void	doHealthCheck(Health.Builder builder)	Actual health check logic.
final Health	health()	Return an indication of health.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.springframework.boot.actuate.health.HealthIndicator

getHealth

构造器详细资料

AbstractHealthIndicator

protected AbstractHealthIndicator()

Create a new AbstractHealthIndicator instance with a default healthCheckFailedMessage.

AbstractHealthIndicator

protected AbstractHealthIndicator(String healthCheckFailedMessage)

Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.

参数:

healthCheckFailedMessage - the message to log on health check failure

从以下版本开始:

2.0.0

AbstractHealthIndicator

protected AbstractHealthIndicator(Function<Exception,String> healthCheckFailedMessage)

Create a new AbstractHealthIndicator instance with a specific message to log when the health check fails.

参数:

healthCheckFailedMessage - the message to log on health check failure

从以下版本开始:

2.0.0

方法详细资料

health

public final Health health()

从接口复制的说明: HealthIndicator

Return an indication of health.

指定者:

health 在接口中 HealthIndicator

返回:

the health

doHealthCheck

protected abstract void doHealthCheck(Health.Builder builder)
                               throws Exception

Actual health check logic.

参数:

builder - the Health.Builder to report health status and details

抛出:

Exception - any Exception that should create a Status.DOWN system status.