Package com.tangosol.util

Interface HealthCheck

public interface HealthCheck
A class that can return its health status

Applications can implement custom health checks and register them with the Coherence Management framework using Registry.register(HealthCheck).

Custom health checks, and built-in Coherence health checks will then appear as Coherence MBeans and can also be queried using the Coherence REST management and health APIs.

Since:
22.06
Author:
Jonathan Knight 2022.02.14
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PATH_HEALTHZ
    The http request path for the healthz endpoint.
    static final String
    PATH_LIVE
    The http request path for the live endpoint.
    static final String
    PATH_READY
    The http request path for the ready endpoint.
    static final String
    PATH_SAFE
    The http request path for the safe endpoint.
    static final String
    PATH_STARTED
    The http request path for the started endpoint.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Returns the unique name of this health check.
    boolean
    isLive()
    Returns
    invalid @link 
    {@link true
    } if the resource represented by this HealthCheck is alive, otherwise returns false.
    default boolean
    isMemberHealthCheck()
    Return true if this HealthCheck should be included when working out this Coherence member's health status.
    boolean
    isReady()
    Returns
    invalid @link 
    {@link true
    } if the resource represented by this HealthCheck is ready, otherwise returns false.
    boolean
    isSafe()
    Returns
    invalid @link 
    {@link true
    } if the resource represented by this HealthCheck is in a safe state to allow a rolling upgrade to proceed, otherwise returns false.
    boolean
    isStarted()
    Returns
    invalid @link 
    {@link true
    } if the resource represented by this HealthCheck is started, otherwise returns false.

  • Field Details

  • Method Details

    • getName

      String getName()
      Returns the unique name of this health check.
      Returns:
      the unique name of this health check

    • isMemberHealthCheck

      default boolean isMemberHealthCheck()
      Return true if this HealthCheck should be included when working out this Coherence member's health status.
      Returns:
      true if this HealthCheck should be included in the member's health status

    • isReady

      boolean isReady()
      Returns
      invalid @link 
      {@link true
      } if the resource represented by this HealthCheck is ready, otherwise returns false.

      The concept of what "ready" means may vary for different types of resources.

      Returns:
      invalid @link 
      {@link true
      } if the resource represented by this HealthCheck is ready, otherwise false

    • isLive

      boolean isLive()
      Returns
      invalid @link 
      {@link true
      } if the resource represented by this HealthCheck is alive, otherwise returns false.

      The concept of what "alive" means may vary for different types of resources.

      Returns:
      invalid @link 
      {@link true
      } if the resource represented by this HealthCheck is alive, otherwise returns false

    • isStarted

      boolean isStarted()
      Returns
      invalid @link 
      {@link true
      } if the resource represented by this HealthCheck is started, otherwise returns false.

      The concept of what "started" means may vary for different types of resources.

      Returns:
      invalid @link 
      {@link true
      } if the resource represented by this HealthCheck is started, otherwise returns false

    • isSafe

      boolean isSafe()
      Returns
      invalid @link 
      {@link true
      } if the resource represented by this HealthCheck is in a safe state to allow a rolling upgrade to proceed, otherwise returns false.

      The concept of what "safe" means may vary for different types of resources.

      Returns:
      invalid @link 
      {@link true
      } if the resource represented by this HealthCheck is in a safe state to allow a rolling upgrade to proceed, otherwise returns false