io.dropwizard.elasticsearch.health

Class EsIndexExistsHealthCheck

java.lang.Object

com.codahale.metrics.health.HealthCheck

io.dropwizard.elasticsearch.health.EsIndexExistsHealthCheck

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

A HealthCheck which checks if one or more indices exist in Elasticsearch.

See Also:

Admin Indices Indices Exists

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
EsIndexExistsHealthCheck(org.elasticsearch.client.Client client, List<String> indices) Construct a new Elasticsearch index exists health check.
EsIndexExistsHealthCheck(org.elasticsearch.client.Client client, String indexName) Construct a new Elasticsearch index exists health check.

Method Summary

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

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

EsIndexExistsHealthCheck

public EsIndexExistsHealthCheck(org.elasticsearch.client.Client client,
                                List<String> indices)

Construct a new Elasticsearch index exists health check.

Parameters:

client - an Elasticsearch Client instance connected to the cluster

indices - a List of indices in Elasticsearch which should be checked

Throws:

IllegalArgumentException - if indices was null or empty

EsIndexExistsHealthCheck

public EsIndexExistsHealthCheck(org.elasticsearch.client.Client client,
                                String indexName)

Construct a new Elasticsearch index exists health check.

Parameters:

client - an Elasticsearch Client instance connected to the cluster

indexName - the index in Elasticsearch which should be checked

Method Detail

check

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

Perform a check of the number of documents in the Elasticsearch indices.

Specified by:

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

Returns:

if the Elasticsearch indices exist, 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