Class AbstractReactiveHealthIndicator

java.lang.Object
org.springframework.boot.health.contributor.AbstractReactiveHealthIndicator
All Implemented Interfaces:
ReactiveHealthContributor, ReactiveHealthIndicator
Direct Known Subclasses:
CassandraDriverReactiveHealthIndicator, ConnectionFactoryHealthIndicator, CouchbaseReactiveHealthIndicator, DataElasticsearchReactiveHealthIndicator, DataRedisReactiveHealthIndicator, MongoReactiveHealthIndicator, Neo4jReactiveHealthIndicator
public abstract class AbstractReactiveHealthIndicator extends Object implements ReactiveHealthIndicator
Base ReactiveHealthIndicator implementations that encapsulates creation of Health instance and error handling.
Since:
4.0.0
Author:
Stephane Nicoll, Nikolay Rybak, Moritz Halbritter

  • Constructor Details

    • AbstractReactiveHealthIndicator

      protected AbstractReactiveHealthIndicator()
      Create a new AbstractReactiveHealthIndicator instance with a default healthCheckFailedMessage.

    • AbstractReactiveHealthIndicator

      protected AbstractReactiveHealthIndicator(@Nullable String healthCheckFailedMessage)
      Create a new AbstractReactiveHealthIndicator instance with a specific message to log when the health check fails.
      Parameters:
      healthCheckFailedMessage - the message to log on health check failure

    • AbstractReactiveHealthIndicator

      protected AbstractReactiveHealthIndicator(Function<Throwable, @Nullable String> healthCheckFailedMessage)
      Create a new AbstractReactiveHealthIndicator instance with a specific message to log when the health check fails.
      Parameters:
      healthCheckFailedMessage - the message to log on health check failure

  • Method Details

    • health

      public final reactor.core.publisher.Mono<Health> health()
      Description copied from interface: ReactiveHealthIndicator
      Provide the indicator of health.
      Specified by:
      health in interface ReactiveHealthIndicator
      Returns:
      a Mono that provides the Health

    • doHealthCheck

      protected abstract reactor.core.publisher.Mono<Health> doHealthCheck(Health.Builder builder)
      Actual health check logic. If an error occurs in the pipeline, it will be handled automatically.
      Parameters:
      builder - the Health.Builder to report health status and details
      Returns:
      a Mono that provides the Health