Module io.helidon.health.checks

Package io.helidon.health.checks

Class HealthChecks

java.lang.Object

io.helidon.health.checks.HealthChecks

public final class HealthChecks
extends Object

Utility class for built-in health checks.

See Also:

• healthChecks()

Method Summary

Modifier and Type	Method	Description
static HealthCheck	deadlockCheck()	Deadlock health check.
static HealthCheck	diskSpaceCheck()	Disk space health check.
static HealthCheck	diskSpaceCheck(Config config)	Disk space health check, set up via config.
static HealthCheck[]	healthChecks()	Built-in health checks.
static HealthCheck[]	healthChecks(Config config)	Built-in health checks, set up using configuration at "health.checks" or the deprecated "helidon.health".
static HeapMemoryHealthCheck	heapMemoryCheck()	Memory health check.
static HeapMemoryHealthCheck	heapMemoryCheck(Config config)	Memory health check.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

deadlockCheck

public static HealthCheck deadlockCheck()

Deadlock health check.

Returns:

deadlock health check

See Also:

• HealthSupport.Builder.addLiveness(org.eclipse.microprofile.health.HealthCheck...)

diskSpaceCheck

public static HealthCheck diskSpaceCheck()

Disk space health check.

Returns:

disk space health check with default configuration

See Also:

• HealthSupport.Builder.addLiveness(org.eclipse.microprofile.health.HealthCheck...)
• DiskSpaceHealthCheck.builder()

diskSpaceCheck

public static HealthCheck diskSpaceCheck(Config config)

Disk space health check, set up via config.

Parameters:

config - configuration to use in setting up the disk space check

Returns:

disk space health check with default configuration

See Also:

• HealthSupport.Builder.addLiveness(org.eclipse.microprofile.health.HealthCheck...)
• DiskSpaceHealthCheck.builder()

heapMemoryCheck

public static HeapMemoryHealthCheck heapMemoryCheck()

Memory health check.

Returns:

memory health check with default configuration

See Also:

• HealthSupport.Builder.addLiveness(org.eclipse.microprofile.health.HealthCheck...)
• HeapMemoryHealthCheck.builder()

heapMemoryCheck

public static HeapMemoryHealthCheck heapMemoryCheck(Config config)

Memory health check.

Parameters:

config - the configuration to use in setting up the heap memory check

Returns:

memory health check with default configuration

See Also:

• HealthSupport.Builder.addLiveness(org.eclipse.microprofile.health.HealthCheck...)
• HeapMemoryHealthCheck.builder()

healthChecks

public static HealthCheck[] healthChecks()

Built-in health checks.

Returns:

built-in health checks to be configured with HealthSupport

See Also:

• HealthSupport.Builder.addLiveness(org.eclipse.microprofile.health.HealthCheck...)

healthChecks

public static HealthCheck[] healthChecks(Config config)

Built-in health checks, set up using configuration at "health.checks" or the deprecated "helidon.health".

Parameters:

config - configuration at the node containing health checks config

Returns:

built-in health checks, set up using the provided configuration

See Also:

• HealthSupport.Builder.addLiveness(org.eclipse.microprofile.health.HealthCheck...)