io.dropwizard.elasticsearch.health

Class EsClusterHealthCheck

java.lang.Object

com.codahale.metrics.health.HealthCheck

io.dropwizard.elasticsearch.health.EsClusterHealthCheck

public class EsClusterHealthCheck
extends com.codahale.metrics.health.HealthCheck

A HealthCheck which checks the cluster state of an Elasticsearch cluster.

See Also:

Admin Cluster Health

Nested Class Summary

Nested classes/interfaces inherited from class com.codahale.metrics.health.HealthCheck

com.codahale.metrics.health.HealthCheck.Result

Constructor Summary

Constructors

Constructor and Description
EsClusterHealthCheck(org.elasticsearch.client.Client client) Construct a new Elasticsearch cluster health check which will fail if the cluster health state is ClusterHealthStatus.RED.
EsClusterHealthCheck(org.elasticsearch.client.Client client, boolean failOnYellow) Construct a new Elasticsearch cluster health check.

Method Summary

Modifier and Type	Method and Description
protected com.codahale.metrics.health.HealthCheck.Result	check() Perform a check of the Elasticsearch cluster health.

Methods inherited from class com.codahale.metrics.health.HealthCheck

execute

Methods inherited from class java.lang.Object

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

Constructor Detail

EsClusterHealthCheck

public EsClusterHealthCheck(org.elasticsearch.client.Client client,
                            boolean failOnYellow)

Construct a new Elasticsearch cluster health check.

Parameters:

client - an Elasticsearch Client instance connected to the cluster

failOnYellow - whether the health check should fail if the cluster health state is yellow

EsClusterHealthCheck

public EsClusterHealthCheck(org.elasticsearch.client.Client client)

Construct a new Elasticsearch cluster health check which will fail if the cluster health state is ClusterHealthStatus.RED.

Parameters:

client - an Elasticsearch Client instance connected to the cluster

Method Detail

check

protected com.codahale.metrics.health.HealthCheck.Result check()
                                                        throws Exception

Perform a check of the Elasticsearch cluster health.

Specified by:

check in class com.codahale.metrics.health.HealthCheck

Returns:

if the Elasticsearch cluster is healthy, a healthy HealthCheck.Result; otherwise, an unhealthy HealthCheck.Result with a descriptive error message or exception

Throws:

Exception - if there is an unhandled error during the health check; this will result in a failed health check