org.springframework.boot.actuate.health

Interface HealthAggregator

All Known Implementing Classes:

AbstractHealthAggregator, OrderedHealthAggregator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface HealthAggregator

Strategy interface used by CompositeHealthIndicator to aggregate Health instances into a final one.

This is especially useful to combine subsystem states expressed through Health.getStatus() into one state for the entire system. The default implementation OrderedHealthAggregator sorts Status instances based on a priority list.

It is possible to add more complex Status types to the system. In that case either the OrderedHealthAggregator needs to be properly configured or users need to register a custom HealthAggregator as bean.

Since:

1.1.0

Author:

Christian Dupuis

Method Summary

Modifier and Type	Method and Description
Health	aggregate(Map<String,Health> healths) Aggregate several given Health instances into one.

Method Detail

aggregate

Health aggregate(Map<String,Health> healths)

Aggregate several given Health instances into one.

Parameters:

healths - the health instances to aggregate

Returns:

the aggregated health