org.springframework.boot.actuate.system

Class DiskSpaceHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.system.DiskSpaceHealthIndicator

All Implemented Interfaces:

HealthIndicator

public class DiskSpaceHealthIndicator
extends AbstractHealthIndicator

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

Constructors

Constructor and Description
DiskSpaceHealthIndicator(File path, org.springframework.util.unit.DataSize threshold) Create a new DiskSpaceHealthIndicator instance.
DiskSpaceHealthIndicator(File path, long threshold) Deprecated. since 2.1.0 in favor of DiskSpaceHealthIndicator(File, DataSize)

Method Summary

Modifier and Type	Method and Description
protected 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

Constructor Detail

DiskSpaceHealthIndicator

public DiskSpaceHealthIndicator(File path,
                                org.springframework.util.unit.DataSize threshold)

Create a new DiskSpaceHealthIndicator instance.

Parameters:

path - the Path used to compute the available disk space

threshold - the minimum disk space that should be available

DiskSpaceHealthIndicator

@Deprecated
public DiskSpaceHealthIndicator(File path,
                                            long threshold)

Deprecated. since 2.1.0 in favor of DiskSpaceHealthIndicator(File, DataSize)

Create a new DiskSpaceHealthIndicator instance.

Parameters:

path - the Path used to compute the available disk space

threshold - the minimum disk space that should be available (in bytes)

Method Detail

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws Exception

Description copied from class: AbstractHealthIndicator

Actual health check logic.

Specified by:

doHealthCheck in class AbstractHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Throws:

Exception - any Exception that should create a Status.DOWN system status.