Class DiskSpaceHealthIndicator
java.lang.Object
org.springframework.boot.actuate.health.AbstractHealthIndicator
org.springframework.boot.actuate.system.DiskSpaceHealthIndicator
- All Implemented Interfaces:
HealthContributor
,HealthIndicator
A
HealthIndicator
that checks available disk space and reports a status of
Status.DOWN
when it drops below a configurable threshold.- Since:
- 2.0.0
- Author:
- Mattias Severson, Andy Wilkinson, Stephane Nicoll
-
Constructor Summary
ConstructorDescriptionDiskSpaceHealthIndicator
(File path, DataSize threshold) Create a newDiskSpaceHealthIndicator
instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
doHealthCheck
(Health.Builder builder) Actual health check logic.Methods inherited from class org.springframework.boot.actuate.health.AbstractHealthIndicator
health
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator
getHealth
-
Constructor Details
-
DiskSpaceHealthIndicator
Create a newDiskSpaceHealthIndicator
instance.- Parameters:
path
- the Path used to compute the available disk spacethreshold
- the minimum disk space that should be available
-
-
Method Details
-
doHealthCheck
Description copied from class:AbstractHealthIndicator
Actual health check logic.- Specified by:
doHealthCheck
in classAbstractHealthIndicator
- Parameters:
builder
- theHealth.Builder
to report health status and details- Throws:
Exception
- anyException
that should create aStatus.DOWN
system status.
-