Class HealthCheck

  • Direct Known Subclasses:
    ThreadDeadlockHealthCheck

    public abstract class HealthCheck
    extends java.lang.Object
    A health check for a component of your application.
    • Constructor Detail

      • HealthCheck

        public HealthCheck()
    • Method Detail

      • check

        protected abstract HealthCheck.Result check()
                                             throws java.lang.Exception
        Perform a check of the application component.
        Returns:
        if the component is healthy, a healthy HealthCheck.Result; otherwise, an unhealthy HealthCheck.Result with a descriptive error message or exception
        Throws:
        java.lang.Exception - if there is an unhandled error during the health check; this will result in a failed health check