io.micronaut.management.health.aggregator

Class DefaultHealthAggregator

java.lang.Object

io.micronaut.management.health.aggregator.DefaultHealthAggregator

All Implemented Interfaces:

HealthAggregator<HealthResult>

@Singleton
 @Requires(beans=HealthEndpoint.class)
public class DefaultHealthAggregator
extends Object
implements HealthAggregator<HealthResult>

Default implementation of HealthAggregator that creates a {status: , description: (optional) , details: } response. The top level object represents the most severe status found in the provided health results, or HealthStatus.UNKNOWN if none found. All registered indicators have their own {status: , description: (optional , details: } object, keyed by the name of the HealthResult defined inside of the details of the top level object.

Example: [status: "UP, details: [diskSpace: [status: UP, details: [:]], cpuUsage: ...]]

Since:

1.0

Author:

James Kleeh, Graeme Rocher

Constructor Summary

Constructors

Constructor and Description
DefaultHealthAggregator(ApplicationConfiguration applicationConfiguration) Default constructor.

Method Summary

Modifier and Type	Method and Description
Publisher<HealthResult>	aggregate(HealthIndicator[] indicators, HealthLevelOfDetail healthLevelOfDetail)
Publisher<HealthResult>	aggregate(String name, Publisher<HealthResult> results)
protected Object	aggregateDetails(List<HealthResult> results)
protected reactor.core.publisher.Flux<HealthResult>	aggregateResults(HealthIndicator[] indicators)
protected HealthResult	buildResult(HealthStatus status, Object details, HealthLevelOfDetail healthLevelOfDetail)
protected HealthStatus	calculateOverallStatus(List<HealthResult> results)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHealthAggregator

public DefaultHealthAggregator(ApplicationConfiguration applicationConfiguration)

Default constructor.

Parameters:

applicationConfiguration - The application configuration.

Method Detail

aggregate

public Publisher<HealthResult> aggregate(HealthIndicator[] indicators,
                                         HealthLevelOfDetail healthLevelOfDetail)

Specified by:

aggregate in interface HealthAggregator<HealthResult>

Parameters:

indicators - The health indicators to aggregate.

healthLevelOfDetail - The HealthLevelOfDetail

Returns:

An aggregated response.

aggregate

public Publisher<HealthResult> aggregate(String name,
                                         Publisher<HealthResult> results)

Specified by:

aggregate in interface HealthAggregator<HealthResult>

Parameters:

name - The name of the new health result

results - The health results to aggregate.

Returns:

An aggregated HealthResult.

calculateOverallStatus

protected HealthStatus calculateOverallStatus(List<HealthResult> results)

Parameters:

results - A list of HealthResult

Returns:

The calculated overall health status

aggregateResults

protected reactor.core.publisher.Flux<HealthResult> aggregateResults(HealthIndicator[] indicators)

Parameters:

indicators - An array of HealthIndicator

Returns:

The aggregated results from all health indicators

aggregateDetails

protected Object aggregateDetails(List<HealthResult> results)

Parameters:

results - A list of health results

Returns:

The aggregated details for the results

buildResult

protected HealthResult buildResult(HealthStatus status,
                                   Object details,
                                   HealthLevelOfDetail healthLevelOfDetail)

Parameters:

status - A HealthStatus

details - The health status details

healthLevelOfDetail - The HealthLevelOfDetail

Returns:

A Map with the results from the health status