org.springframework.boot.actuate.elasticsearch

Class ElasticsearchHealthIndicator

java.lang.Object

org.springframework.boot.actuate.health.AbstractHealthIndicator

org.springframework.boot.actuate.elasticsearch.ElasticsearchHealthIndicator

All Implemented Interfaces:

HealthIndicator

public class ElasticsearchHealthIndicator
extends AbstractHealthIndicator

HealthIndicator for an Elasticsearch cluster.

Since:

2.0.0

Author:

Binwei Yang, Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
ElasticsearchHealthIndicator(org.elasticsearch.client.Client client, long responseTimeout, List<String> indices) Create a new ElasticsearchHealthIndicator instance.
ElasticsearchHealthIndicator(org.elasticsearch.client.Client client, long responseTimeout, String... indices) Create a new ElasticsearchHealthIndicator instance.

Method Summary

Modifier and Type	Method and Description
protected void	doHealthCheck(Health.Builder builder) Actual health check logic.

Methods inherited from class org.springframework.boot.actuate.health.AbstractHealthIndicator

health

Methods inherited from class java.lang.Object

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

Constructor Detail

ElasticsearchHealthIndicator

public ElasticsearchHealthIndicator(org.elasticsearch.client.Client client,
                                    long responseTimeout,
                                    List<String> indices)

Create a new ElasticsearchHealthIndicator instance.

Parameters:

client - the Elasticsearch client

responseTimeout - the request timeout in milliseconds

indices - the indices to check

ElasticsearchHealthIndicator

public ElasticsearchHealthIndicator(org.elasticsearch.client.Client client,
                                    long responseTimeout,
                                    String... indices)

Create a new ElasticsearchHealthIndicator instance.

Parameters:

client - the Elasticsearch client

responseTimeout - the request timeout in milliseconds

indices - the indices to check

Method Detail

doHealthCheck

protected void doHealthCheck(Health.Builder builder)
                      throws Exception

Description copied from class: AbstractHealthIndicator

Actual health check logic.

Specified by:

doHealthCheck in class AbstractHealthIndicator

Parameters:

builder - the Health.Builder to report health status and details

Throws:

Exception - any Exception that should create a Status.DOWN system status.