Package org.elasticsearch.health
Interface HealthIndicatorService
- All Known Implementing Classes:
InstanceHasMasterHealthIndicatorService
,RepositoryIntegrityHealthIndicatorService
,ShardsAvailabilityHealthIndicatorService
public interface HealthIndicatorService
This is a service interface used to calculate health indicator from the different modules or plugins.
-
Method Summary
Modifier and TypeMethodDescriptiondefault HealthIndicatorResult
createIndicator
(HealthStatus status, String summary, HealthIndicatorDetails details, Collection<HealthIndicatorImpact> impacts) This method creates a HealthIndicatorResult with the given information.name()
-
Method Details
-
name
String name() -
component
String component() -
calculate
HealthIndicatorResult calculate() -
createIndicator
default HealthIndicatorResult createIndicator(HealthStatus status, String summary, HealthIndicatorDetails details, Collection<HealthIndicatorImpact> impacts) This method creates a HealthIndicatorResult with the given information. Note that it sorts the impacts by severity (the lower the number the higher the severity), and only keeps the 3 highest-severity impacts.- Parameters:
status
- The status of the resultsummary
- The summary used in the resultdetails
- The details used in the resultimpacts
- A collection of impacts. Only the 3 highest severity impacts are used in the result- Returns:
- A HealthIndicatorResult built from the given information
-