Merge branch 'gh-2399'
Andy Wilkinson
10 years ago
commit
8797788619
@ -0,0 +1 @@
|
||||
/data
|
||||
@ -0,0 +1,73 @@
|
||||
/*
|
||||
* Copyright 2012-2015 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.actuate.health;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import org.elasticsearch.action.admin.cluster.health.ClusterHealthResponse;
|
||||
import org.elasticsearch.client.Client;
|
||||
import org.elasticsearch.client.Requests;
|
||||
|
||||
/**
|
||||
* {@link HealthIndicator} for an Elasticsearch cluster.
|
||||
*
|
||||
* @author Binwei Yang
|
||||
* @author Andy Wilkinson
|
||||
* @since 1.3.0
|
||||
*/
|
||||
public class ElasticsearchHealthIndicator extends AbstractHealthIndicator {
|
||||
|
||||
private final Client client;
|
||||
|
||||
private final ElasticsearchHealthIndicatorProperties properties;
|
||||
|
||||
public ElasticsearchHealthIndicator(Client client,
|
||||
ElasticsearchHealthIndicatorProperties properties) {
|
||||
this.client = client;
|
||||
this.properties = properties;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void doHealthCheck(Health.Builder builder) throws Exception {
|
||||
List<String> indices = this.properties.getIndices();
|
||||
ClusterHealthResponse response = this.client
|
||||
.admin()
|
||||
.cluster()
|
||||
.health(Requests.clusterHealthRequest(indices.isEmpty() ? null : indices
|
||||
.toArray(new String[indices.size()])))
|
||||
.actionGet(this.properties.getResponseTimeout());
|
||||
|
||||
switch (response.getStatus()) {
|
||||
case GREEN:
|
||||
case YELLOW:
|
||||
builder.up();
|
||||
break;
|
||||
case RED:
|
||||
default:
|
||||
builder.down();
|
||||
break;
|
||||
}
|
||||
builder.withDetail("clusterName", response.getClusterName());
|
||||
builder.withDetail("numberOfNodes", response.getNumberOfNodes());
|
||||
builder.withDetail("numberOfDataNodes", response.getNumberOfDataNodes());
|
||||
builder.withDetail("activePrimaryShards", response.getActivePrimaryShards());
|
||||
builder.withDetail("activeShards", response.getActiveShards());
|
||||
builder.withDetail("relocatingShards", response.getRelocatingShards());
|
||||
builder.withDetail("initializingShards", response.getInitializingShards());
|
||||
builder.withDetail("unassignedShards", response.getUnassignedShards());
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,56 @@
|
||||
/*
|
||||
* Copyright 2012-2015 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.actuate.health;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* External configuration properties for {@link ElasticsearchHealthIndicator}
|
||||
*
|
||||
* @author Binwei Yang
|
||||
* @author Andy Wilkinson
|
||||
* @since 1.3.0
|
||||
*/
|
||||
@ConfigurationProperties("management.health.elasticsearch")
|
||||
public class ElasticsearchHealthIndicatorProperties {
|
||||
|
||||
/**
|
||||
* Comma-separated index names
|
||||
*/
|
||||
private List<String> indices = new ArrayList<String>();
|
||||
|
||||
/**
|
||||
* The time, in milliseconds, to wait for a response from the cluster
|
||||
*/
|
||||
private long responseTimeout = 100L;
|
||||
|
||||
public List<String> getIndices() {
|
||||
return this.indices;
|
||||
}
|
||||
|
||||
public long getResponseTimeout() {
|
||||
return this.responseTimeout;
|
||||
}
|
||||
|
||||
public void setResponseTimeout(long responseTimeout) {
|
||||
this.responseTimeout = responseTimeout;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,238 @@
|
||||
/*
|
||||
* Copyright 2012-2015 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.boot.actuate.health;
|
||||
|
||||
import java.util.Arrays;
|
||||
import java.util.Map;
|
||||
|
||||
import org.elasticsearch.ElasticsearchException;
|
||||
import org.elasticsearch.ElasticsearchTimeoutException;
|
||||
import org.elasticsearch.action.admin.cluster.health.ClusterHealthRequest;
|
||||
import org.elasticsearch.action.admin.cluster.health.ClusterHealthResponse;
|
||||
import org.elasticsearch.action.admin.cluster.health.ClusterHealthStatus;
|
||||
import org.elasticsearch.action.support.PlainActionFuture;
|
||||
import org.elasticsearch.client.AdminClient;
|
||||
import org.elasticsearch.client.Client;
|
||||
import org.elasticsearch.client.ClusterAdminClient;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.mockito.ArgumentCaptor;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.runners.MockitoJUnitRunner;
|
||||
|
||||
import static org.hamcrest.Matchers.arrayContaining;
|
||||
import static org.hamcrest.Matchers.containsString;
|
||||
import static org.hamcrest.Matchers.equalTo;
|
||||
import static org.hamcrest.Matchers.is;
|
||||
import static org.hamcrest.Matchers.nullValue;
|
||||
import static org.junit.Assert.assertThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Matchers.any;
|
||||
|
||||
/**
|
||||
* Test for {@link ElasticsearchHealthIndicator}.
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
*/
|
||||
@RunWith(MockitoJUnitRunner.class)
|
||||
public class ElasticsearchHealthIndicatorTests {
|
||||
|
||||
@Mock
|
||||
private Client client;
|
||||
|
||||
@Mock
|
||||
private AdminClient admin;
|
||||
|
||||
@Mock
|
||||
private ClusterAdminClient cluster;
|
||||
|
||||
private ElasticsearchHealthIndicator indicator;
|
||||
|
||||
private ElasticsearchHealthIndicatorProperties properties = new ElasticsearchHealthIndicatorProperties();
|
||||
|
||||
@Before
|
||||
public void setUp() throws Exception {
|
||||
given(this.client.admin()).willReturn(this.admin);
|
||||
given(this.admin.cluster()).willReturn(this.cluster);
|
||||
|
||||
this.indicator = new ElasticsearchHealthIndicator(this.client, this.properties);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void defaultConfigurationQueriesAllIndicesWith100msTimeout() {
|
||||
TestActionFuture responseFuture = new TestActionFuture();
|
||||
responseFuture.onResponse(new StubClusterHealthResponse());
|
||||
ArgumentCaptor<ClusterHealthRequest> requestCaptor = ArgumentCaptor
|
||||
.forClass(ClusterHealthRequest.class);
|
||||
given(this.cluster.health(requestCaptor.capture())).willReturn(responseFuture);
|
||||
Health health = this.indicator.health();
|
||||
assertThat(responseFuture.getTimeout, is(100L));
|
||||
assertThat(requestCaptor.getValue().indices(), is(nullValue()));
|
||||
assertThat(health.getStatus(), is(Status.UP));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void certainIndices() {
|
||||
PlainActionFuture<ClusterHealthResponse> responseFuture = new PlainActionFuture<ClusterHealthResponse>();
|
||||
responseFuture.onResponse(new StubClusterHealthResponse());
|
||||
ArgumentCaptor<ClusterHealthRequest> requestCaptor = ArgumentCaptor
|
||||
.forClass(ClusterHealthRequest.class);
|
||||
given(this.cluster.health(requestCaptor.capture())).willReturn(responseFuture);
|
||||
this.properties.getIndices()
|
||||
.addAll(Arrays.asList("test-index-1", "test-index-2"));
|
||||
Health health = this.indicator.health();
|
||||
assertThat(requestCaptor.getValue().indices(),
|
||||
is(arrayContaining("test-index-1", "test-index-2")));
|
||||
assertThat(health.getStatus(), is(Status.UP));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void customTimeout() {
|
||||
TestActionFuture responseFuture = new TestActionFuture();
|
||||
responseFuture.onResponse(new StubClusterHealthResponse());
|
||||
ArgumentCaptor<ClusterHealthRequest> requestCaptor = ArgumentCaptor
|
||||
.forClass(ClusterHealthRequest.class);
|
||||
given(this.cluster.health(requestCaptor.capture())).willReturn(responseFuture);
|
||||
this.properties.setResponseTimeout(1000L);
|
||||
this.indicator.health();
|
||||
assertThat(responseFuture.getTimeout, is(1000L));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void healthDetails() {
|
||||
PlainActionFuture<ClusterHealthResponse> responseFuture = new PlainActionFuture<ClusterHealthResponse>();
|
||||
responseFuture.onResponse(new StubClusterHealthResponse());
|
||||
given(this.cluster.health(any(ClusterHealthRequest.class))).willReturn(
|
||||
responseFuture);
|
||||
Health health = this.indicator.health();
|
||||
assertThat(health.getStatus(), is(Status.UP));
|
||||
Map<String, Object> details = health.getDetails();
|
||||
assertDetail(details, "clusterName", "test-cluster");
|
||||
assertDetail(details, "activeShards", 1);
|
||||
assertDetail(details, "relocatingShards", 2);
|
||||
assertDetail(details, "activePrimaryShards", 3);
|
||||
assertDetail(details, "initializingShards", 4);
|
||||
assertDetail(details, "unassignedShards", 5);
|
||||
assertDetail(details, "numberOfNodes", 6);
|
||||
assertDetail(details, "numberOfDataNodes", 7);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void redResponseMapsToDown() {
|
||||
PlainActionFuture<ClusterHealthResponse> responseFuture = new PlainActionFuture<ClusterHealthResponse>();
|
||||
responseFuture.onResponse(new StubClusterHealthResponse(ClusterHealthStatus.RED));
|
||||
given(this.cluster.health(any(ClusterHealthRequest.class))).willReturn(
|
||||
responseFuture);
|
||||
assertThat(this.indicator.health().getStatus(), is(Status.DOWN));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void yellowResponseMapsToUp() {
|
||||
PlainActionFuture<ClusterHealthResponse> responseFuture = new PlainActionFuture<ClusterHealthResponse>();
|
||||
responseFuture.onResponse(new StubClusterHealthResponse(
|
||||
ClusterHealthStatus.YELLOW));
|
||||
given(this.cluster.health(any(ClusterHealthRequest.class))).willReturn(
|
||||
responseFuture);
|
||||
assertThat(this.indicator.health().getStatus(), is(Status.UP));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void responseTimeout() {
|
||||
PlainActionFuture<ClusterHealthResponse> responseFuture = new PlainActionFuture<ClusterHealthResponse>();
|
||||
given(this.cluster.health(any(ClusterHealthRequest.class))).willReturn(
|
||||
responseFuture);
|
||||
Health health = this.indicator.health();
|
||||
assertThat(health.getStatus(), is(Status.DOWN));
|
||||
assertThat((String) health.getDetails().get("error"),
|
||||
containsString(ElasticsearchTimeoutException.class.getName()));
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
private <T> void assertDetail(Map<String, Object> details, String detail, T value) {
|
||||
assertThat((T) details.get(detail), is(equalTo(value)));
|
||||
}
|
||||
|
||||
private static class StubClusterHealthResponse extends ClusterHealthResponse {
|
||||
|
||||
private final ClusterHealthStatus status;
|
||||
|
||||
private StubClusterHealthResponse() {
|
||||
this(ClusterHealthStatus.GREEN);
|
||||
}
|
||||
|
||||
private StubClusterHealthResponse(ClusterHealthStatus status) {
|
||||
super("test-cluster", null);
|
||||
this.status = status;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getActiveShards() {
|
||||
return 1;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getRelocatingShards() {
|
||||
return 2;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getActivePrimaryShards() {
|
||||
return 3;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getInitializingShards() {
|
||||
return 4;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getUnassignedShards() {
|
||||
return 5;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getNumberOfNodes() {
|
||||
return 6;
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getNumberOfDataNodes() {
|
||||
return 7;
|
||||
}
|
||||
|
||||
@Override
|
||||
public ClusterHealthStatus getStatus() {
|
||||
return this.status;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private static class TestActionFuture extends
|
||||
PlainActionFuture<ClusterHealthResponse> {
|
||||
|
||||
private long getTimeout = -1L;
|
||||
|
||||
@Override
|
||||
public ClusterHealthResponse actionGet(long timeoutMillis)
|
||||
throws ElasticsearchException {
|
||||
this.getTimeout = timeoutMillis;
|
||||
return super.actionGet(timeoutMillis);
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue