Spring/spring-boot-data-geode
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Spring Boot HealthIndicator for Apache Geode AsyncEventQueues.

Browse Source
This commit is contained in:
John Blum
2018-09-18 22:44:01 -07:00
parent 38a4fdf593
commit f61d506e31
2 changed files with 235 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
spring-geode-actuator/src/main/java/org/springframework/geode/boot/actuate/GeodeAsyncEventQueuesHealthIndicator.java Normal file
View File

@@ -0,0 +1,111 @@
/*
* Copyright 2018 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.geode.boot.actuate;
import java.util.Collections;
import java.util.Objects;
import java.util.Set;
import org.apache.geode.cache.Cache;
import org.apache.geode.cache.GemFireCache;
import org.apache.geode.cache.asyncqueue.AsyncEventQueue;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.data.gemfire.util.CacheUtils;
import org.springframework.geode.boot.actuate.health.AbstractGeodeHealthIndicator;
/**
* The {@link GeodeAsyncEventQueuesHealthIndicator} class is a Spring Boot {@link HealthIndicator} providing details
* about the health of Apache Geode {@link AsyncEventQueue AsyncEventQueues}.
*
* @author John Blum
* @see org.apache.geode.cache.Cache
* @see org.apache.geode.cache.GemFireCache
* @see org.apache.geode.cache.asyncqueue.AsyncEventQueue
* @see org.springframework.boot.actuate.health.Health
* @see org.springframework.boot.actuate.health.HealthIndicator
* @see org.springframework.geode.boot.actuate.health.AbstractGeodeHealthIndicator
* @since 1.0.0
*/
@SuppressWarnings("unused")
public class GeodeAsyncEventQueuesHealthIndicator extends AbstractGeodeHealthIndicator {
/**
* Default constructor to construct an uninitialized instance of {@link GeodeAsyncEventQueuesHealthIndicator},
* which will not provide any health information.
*/
public GeodeAsyncEventQueuesHealthIndicator() {
super("Async Event Queues health check failed");
}
/**
* Constructs an instance of the {@link GeodeAsyncEventQueuesHealthIndicator} initialized with a reference to
* the {@link GemFireCache} instance.
*
* @param gemfireCache reference to the {@link GemFireCache} instance used to collect health information.
* @throws IllegalArgumentException if {@link GemFireCache} is {@literal null}.
* @see org.apache.geode.cache.GemFireCache
*/
public GeodeAsyncEventQueuesHealthIndicator(GemFireCache gemfireCache) {
super(gemfireCache);
}
@Override
protected void doHealthCheck(Health.Builder builder) throws Exception {
if (getGemFireCache().filter(CacheUtils::isPeer).isPresent()) {
Set<AsyncEventQueue> asyncEventQueues = getGemFireCache()
.map(Cache.class::cast)
.map(Cache::getAsyncEventQueues)
.orElseGet(Collections::emptySet);
builder.withDetail("geode.async-event-queue.count", asyncEventQueues.size());
asyncEventQueues.stream()
.filter(Objects::nonNull)
.forEach(asyncEventQueue -> {
String asyncEventQueueId = asyncEventQueue.getId();
builder.withDetail(asyncEventQueueKey(asyncEventQueueId, "batch-conflation-enabled"), toYesNoString(asyncEventQueue.isBatchConflationEnabled()))
.withDetail(asyncEventQueueKey(asyncEventQueueId, "batch-size"), asyncEventQueue.getBatchSize())
.withDetail(asyncEventQueueKey(asyncEventQueueId, "batch-time-interval"), asyncEventQueue.getBatchTimeInterval())
.withDetail(asyncEventQueueKey(asyncEventQueueId, "disk-store-name"), asyncEventQueue.getDiskStoreName())
.withDetail(asyncEventQueueKey(asyncEventQueueId, "disk-synchronous"), toYesNoString(asyncEventQueue.isDiskSynchronous()))
.withDetail(asyncEventQueueKey(asyncEventQueueId, "dispatcher-threads"), asyncEventQueue.getDispatcherThreads())
.withDetail(asyncEventQueueKey(asyncEventQueueId, "forward-expiration-destroy"), toYesNoString(asyncEventQueue.isForwardExpirationDestroy()))
.withDetail(asyncEventQueueKey(asyncEventQueueId, "max-queue-memory"), asyncEventQueue.getMaximumQueueMemory())
.withDetail(asyncEventQueueKey(asyncEventQueueId, "order-policy"), asyncEventQueue.getOrderPolicy())
.withDetail(asyncEventQueueKey(asyncEventQueueId, "parallel"), toYesNoString(asyncEventQueue.isParallel()))
.withDetail(asyncEventQueueKey(asyncEventQueueId, "persistent"), toYesNoString(asyncEventQueue.isPersistent()))
.withDetail(asyncEventQueueKey(asyncEventQueueId, "primary"), toYesNoString(asyncEventQueue.isPrimary()))
.withDetail(asyncEventQueueKey(asyncEventQueueId, "size"), asyncEventQueue.size());
});
builder.up();
return;
}
builder.unknown();
}
private String asyncEventQueueKey(String id, String suffix) {
return String.format("geode.async-event-queue.%1$s.%2$s", id, suffix);
}
}

124
spring-geode-actuator/src/test/java/org/springframework/geode/boot/actuate/GeodeAsyncEventQueuesHealthIndicatorUnitTests.java Normal file
View File

@@ -0,0 +1,124 @@
/*
* Copyright 2018 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.geode.boot.actuate;
import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.apache.geode.cache.Cache;
import org.apache.geode.cache.asyncqueue.AsyncEventQueue;
import org.apache.geode.cache.wan.GatewaySender;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.junit.MockitoJUnitRunner;
import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.Status;
import org.springframework.data.gemfire.tests.mock.AsyncEventQueueMockObjects;
/**
* Unit tests for {@link GeodeAsyncEventQueuesHealthIndicator}.
*
* @author John Blum
* @see org.junit.Test
* @see org.mockito.Mock
* @see org.mockito.Mockito
* @see org.mockito.junit.MockitoJUnitRunner
* @since 1.0.0
*/
@RunWith(MockitoJUnitRunner.class)
public class GeodeAsyncEventQueuesHealthIndicatorUnitTests {
@Mock
private Cache mockCache;
private GeodeAsyncEventQueuesHealthIndicator asyncEventQueuesHealthIndicator;
@Before
public void setup() {
this.asyncEventQueuesHealthIndicator = new GeodeAsyncEventQueuesHealthIndicator(this.mockCache);
}
@Test
public void healthCheckCapturesDetails() throws Exception {
Set<AsyncEventQueue> mockAsyncEventQueues = new HashSet<>();
mockAsyncEventQueues.add(AsyncEventQueueMockObjects.mockAsyncEventQueue("aeqOne", true,
250, 10000, "testDiskStoreOne", true, 16,
true, 65536, GatewaySender.OrderPolicy.THREAD, true,
true, true, 1024));
mockAsyncEventQueues.add(AsyncEventQueueMockObjects.mockAsyncEventQueue("aeqTwo", false,
100, 1000, "testDiskStoreTwo", false, 8,
false, 32768, GatewaySender.OrderPolicy.KEY, false,
true, false, 8192));
when(this.mockCache.getAsyncEventQueues()).thenReturn(mockAsyncEventQueues);
Health.Builder builder = new Health.Builder();
this.asyncEventQueuesHealthIndicator.doHealthCheck(builder);
Health health = builder.build();
assertThat(health).isNotNull();
assertThat(health.getStatus()).isEqualTo(Status.UP);
Map<String, Object> details = health.getDetails();
assertThat(details).isNotNull();
assertThat(details).isNotEmpty();
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.batch-conflation-enabled", "Yes");
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.batch-size", 250);
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.batch-time-interval", 10000);
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.disk-store-name", "testDiskStoreOne");
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.disk-synchronous", "Yes");
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.dispatcher-threads", 16);
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.forward-expiration-destroy", "Yes");
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.max-queue-memory", 65536);
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.order-policy", GatewaySender.OrderPolicy.THREAD);
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.parallel", "Yes");
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.persistent", "Yes");
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.primary", "Yes");
assertThat(details).containsEntry("geode.async-event-queue.aeqOne.size", 1024);
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.batch-conflation-enabled", "No");
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.batch-size", 100);
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.batch-time-interval", 1000);
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.disk-store-name", "testDiskStoreTwo");
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.disk-synchronous", "No");
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.dispatcher-threads", 8);
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.forward-expiration-destroy", "No");
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.max-queue-memory", 32768);
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.order-policy", GatewaySender.OrderPolicy.KEY);
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.parallel", "No");
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.persistent", "Yes");
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.primary", "No");
assertThat(details).containsEntry("geode.async-event-queue.aeqTwo.size", 8192);
verify(this.mockCache, times(1)).getAsyncEventQueues();
}
}