Module io.helidon.health.checks
Package io.helidon.health.checks

Class DeadlockHealthCheck

java.lang.Object
io.helidon.health.checks.DeadlockHealthCheck
All Implemented Interfaces:
HealthCheck
public class DeadlockHealthCheck extends Object implements HealthCheck
A health check that looks for thread deadlocks. Automatically created and registered via CDI.

This health check can be referred to in properties as deadlock. So for example, to exclude this health check from being exposed, use helidon.health.exclude: deadlock.

  • Method Details

    • create

      public static DeadlockHealthCheck create(ThreadMXBean threadBean)
      Create a new deadlock health check to use.
      Parameters:
      threadBean - thread mx bean to get thread monitoring data from
      Returns:
      a new health check

    • create

      public static DeadlockHealthCheck create()
      Create a new deadlock health check to use.
      Returns:
      a new health check

    • type

      public HealthCheckType type()
      Description copied from interface: HealthCheck
      Type of this health check.
      Specified by:
      type in interface HealthCheck
      Returns:
      type, defaults to HealthCheckType.LIVENESS

    • name

      public String name()
      Description copied from interface: HealthCheck
      Name of this health check, used in output when details are requested.
      Specified by:
      name in interface HealthCheck
      Returns:
      name of this health check, defaults to simple class name

    • path

      public String path()
      Description copied from interface: HealthCheck
      Path of this health check, to support single health-check queries.
      Specified by:
      path in interface HealthCheck
      Returns:
      path to use, by default returns HealthCheck.name()

    • call

      public HealthCheckResponse call()
      Description copied from interface: HealthCheck
      Call a health check.
      Specified by:
      call in interface HealthCheck
      Returns:
      health response