Class AbstractHealthIndicator

java.lang.Object
org.springframework.boot.actuate.health.AbstractHealthIndicator
All Implemented Interfaces:
HealthContributor, HealthIndicator
Direct Known Subclasses:
AvailabilityStateHealthIndicator, CassandraDriverHealthIndicator, CouchbaseHealthIndicator, DataSourceHealthIndicator, DiskSpaceHealthIndicator, ElasticsearchRestClientHealthIndicator, HazelcastHealthIndicator, InfluxDbHealthIndicator, JmsHealthIndicator, LdapHealthIndicator, MailHealthIndicator, MongoHealthIndicator, Neo4jHealthIndicator, PingHealthIndicator, RabbitHealthIndicator, RedisHealthIndicator

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.

Since:
1.1.0
Author:
Christian Dupuis
  • Constructor Details

    • 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.
      Parameters:
      healthCheckFailedMessage - the message to log on health check failure
      Since:
      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.
      Parameters:
      healthCheckFailedMessage - the message to log on health check failure
      Since:
      2.0.0
  • Method Details