Package jenkins.health

Interface HealthCheck

All Superinterfaces:
ExtensionPoint
All Known Implementing Classes:
CompletedInitializationMonitor.HealthCheckImpl
@Restricted(org.kohsuke.accmod.restrictions.Beta.class) public interface HealthCheck extends ExtensionPoint

Specifies a health check that is essential for Jenkins to function properly.
If this health check fails, monitoring systems will treat the controller as unusable for meaningful tasks.
It is assumed that restarting Jenkins can resolve the issue.

For instance, low disk space is not a good health check because it can't be solved by restarting Jenkins.
Detecting a deadlock in a critical singleton thread would be a good health check as long as associated information (thread dump) is reported somewhere before restarting.

Since:
TODO

  • Method Details

    • getName

      default String getName()
      Returns:
      the name of the health check. Must be unique among health check implementations. Defaults to the fully qualified class name.

    • check

      boolean check()
      Returns:
      true if the health check passed.