Package io.helidon.microprofile.health.checks

Class HeapMemoryHealthCheck

java.lang.Object

io.helidon.microprofile.health.checks.HeapMemoryHealthCheck

All Implemented Interfaces:

org.eclipse.microprofile.health.HealthCheck

@Health
@ApplicationScoped
public final class HeapMemoryHealthCheck
extends java.lang.Object
implements org.eclipse.microprofile.health.HealthCheck

A health check that verifies whether the server is running out of Java heap space. If heap usage exceeds a specified threshold, then the health check will fail. By default, this health check has a threshold of .98 (98%). If heap usage exceeds this level, then the server is considered to be unhealthy. This default can be modified using the healthCheck.heapMemory.thresholdPercent property. The threshold should be set to a fraction, such as .50 for 50% or .99 for 99%. This health check is automatically created and registered through CDI. This health check can be referred to in properties as "heapMemory". So for example, to exclude this health check from being exposed, use "helidon.health.exclude: heapMemory".

Method Summary

Modifier and Type	Method	Description
org.eclipse.microprofile.health.HealthCheckResponse	call()

Methods inherited from class java.lang.Object

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

Method Detail

call

public org.eclipse.microprofile.health.HealthCheckResponse call()

Specified by:

call in interface org.eclipse.microprofile.health.HealthCheck