io.micronaut.management.health.indicator.diskspace

Class DiskSpaceIndicator

java.lang.Object

io.micronaut.management.health.indicator.AbstractHealthIndicator<java.util.Map<java.lang.String,java.lang.Object>>

io.micronaut.management.health.indicator.diskspace.DiskSpaceIndicator

All Implemented Interfaces:

Ordered, HealthIndicator

@Singleton
 @Requires(property="endpoints.health.disk-space.enabled",notEquals="false") @Requires(beans=HealthEndpoint.class)
public class DiskSpaceIndicator
extends AbstractHealthIndicator<java.util.Map<java.lang.String,java.lang.Object>>

A HealthIndicator used to display information about the disk space of the server. Returns HealthStatus.DOWN if the free space is less than the configured threshold.

Since:

1.0

Author:

James Kleeh

See Also:

DiskSpaceIndicatorConfiguration.threshold

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	NAME

Fields inherited from class io.micronaut.management.health.indicator.AbstractHealthIndicator

executorService, healthStatus

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getHealthInformation() Provides information (typically a Map) to be returned.
java.lang.String	getName() Used to populate the HealthResult.

Methods inherited from class io.micronaut.management.health.indicator.AbstractHealthIndicator

getHealthResult, getResult, setExecutorService

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Field Detail

NAME

protected static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

Description copied from class: AbstractHealthIndicator

Used to populate the HealthResult. Provides a key to go along with the health information.

Specified by:

getName in class AbstractHealthIndicator<java.util.Map<java.lang.String,java.lang.Object>>

Returns:

The name of the indicator

getHealthInformation

protected java.util.Map<java.lang.String,java.lang.Object> getHealthInformation()

Description copied from class: AbstractHealthIndicator

Provides information (typically a Map) to be returned. Set the AbstractHealthIndicator.healthStatus field during execution, otherwise HealthStatus.UNKNOWN will be used.

Specified by:

getHealthInformation in class AbstractHealthIndicator<java.util.Map<java.lang.String,java.lang.Object>>

Returns:

Any details to be included in the response.