Stephane Nicoll
7 years ago
parent
38ac595615
commit
0515ca0dd0
@ -0,0 +1,88 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.autoconfigure.metrics.cache;
|
||||
|
||||
import com.hazelcast.core.Hazelcast;
|
||||
import com.hazelcast.spring.cache.HazelcastCache;
|
||||
import io.micrometer.core.instrument.binder.MeterBinder;
|
||||
import net.sf.ehcache.Ehcache;
|
||||
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProvider;
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProviders;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.cache.caffeine.CaffeineCache;
|
||||
import org.springframework.cache.ehcache.EhCacheCache;
|
||||
import org.springframework.cache.jcache.JCacheCache;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
/**
|
||||
* {@link Configuration Auto-configuration} for {@link CacheMeterBinderProvider} beans.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
* @see CacheMeterBinderProviders
|
||||
*/
|
||||
@Configuration
|
||||
@ConditionalOnClass(MeterBinder.class)
|
||||
class CacheMeterBinderProvidersConfiguration {
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass({ CaffeineCache.class, com.github.benmanes.caffeine.cache.Cache.class })
|
||||
static class CaffeineCacheMeterBinderProviderConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheMeterBinderProvider caffeineCacheMeterBinderProvider() {
|
||||
return new CacheMeterBinderProviders.CaffeineCacheMeterBinderProvider();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass({ EhCacheCache.class, Ehcache.class })
|
||||
static class EhCache2CacheMeterBinderProviderConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheMeterBinderProvider ehCache2CacheMeterBinderProvider() {
|
||||
return new CacheMeterBinderProviders.EhCache2CacheMeterBinderProvider();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass({ HazelcastCache.class, Hazelcast.class })
|
||||
static class HazelcastCacheMeterBinderProviderConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheMeterBinderProvider hazelcastCacheMeterBinderProvider() {
|
||||
return new CacheMeterBinderProviders.HazelcastCacheMeterBinderProvider();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass({ JCacheCache.class, javax.cache.CacheManager.class })
|
||||
static class JCacheCacheMeterBinderProviderConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheMeterBinderProvider jCacheCacheMeterBinderProvider() {
|
||||
return new CacheMeterBinderProviders.JCacheCacheMeterBinderProvider();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,40 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.autoconfigure.metrics.cache;
|
||||
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.CacheManager;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.Import;
|
||||
|
||||
/**
|
||||
* Configure metrics for all available {@link Cache caches}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
*/
|
||||
@Configuration
|
||||
@ConditionalOnBean(CacheManager.class)
|
||||
@ConditionalOnProperty(value = "management.metrics.cache.instrument-cache", matchIfMissing = true)
|
||||
@EnableConfigurationProperties(CacheMetricsProperties.class)
|
||||
@Import({ CacheMeterBinderProvidersConfiguration.class, CacheMetricsRegistrarConfiguration.class })
|
||||
public class CacheMetricsConfiguration {
|
||||
|
||||
}
|
||||
@ -0,0 +1,43 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.autoconfigure.metrics.cache;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* Configuration properties for Cache-based metrics.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
*/
|
||||
@ConfigurationProperties("management.metrics.cache")
|
||||
public class CacheMetricsProperties {
|
||||
|
||||
/**
|
||||
* Name of the metric for cache usage.
|
||||
*/
|
||||
private String cacheMetricName = "cache";
|
||||
|
||||
public String getCacheMetricName() {
|
||||
return this.cacheMetricName;
|
||||
}
|
||||
|
||||
public void setCacheMetricName(String cacheMetricName) {
|
||||
this.cacheMetricName = cacheMetricName;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,98 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.autoconfigure.metrics.cache;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.Collection;
|
||||
import java.util.List;
|
||||
|
||||
import io.micrometer.core.instrument.MeterRegistry;
|
||||
import io.micrometer.core.instrument.Tag;
|
||||
import io.micrometer.core.instrument.Tags;
|
||||
import io.micrometer.core.instrument.binder.MeterBinder;
|
||||
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProvider;
|
||||
import org.springframework.cache.Cache;
|
||||
|
||||
/**
|
||||
* Register supported {@link Cache} to a {@link MeterRegistry}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public class CacheMetricsRegistrar {
|
||||
|
||||
private final MeterRegistry registry;
|
||||
|
||||
private final String metricName;
|
||||
|
||||
private final Collection<CacheMeterBinderProvider> cacheMeterBinderProviders;
|
||||
|
||||
/**
|
||||
* Creates a new registrar.
|
||||
* @param registry the {@link MeterRegistry} to use
|
||||
* @param metricName the name of the metric
|
||||
* @param binderProviders the {@link CacheMeterBinderProvider} instances that should
|
||||
* be used to detect compatible caches
|
||||
*/
|
||||
public CacheMetricsRegistrar(MeterRegistry registry, String metricName,
|
||||
Collection<CacheMeterBinderProvider> binderProviders) {
|
||||
this.registry = registry;
|
||||
this.metricName = metricName;
|
||||
this.cacheMeterBinderProviders = binderProviders;
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempt to bind the specified {@link Cache} to the registry. Return {@code true}
|
||||
* if the cache is supported and was bound to the registry, {@code false} otherwise.
|
||||
* @param cache the cache to handle
|
||||
* @param tags the tags to associate with the metrics of that cache
|
||||
* @return {@code true} if the {@code cache} is supported and was registered
|
||||
*/
|
||||
public boolean bindCacheToRegistry(Cache cache, Tag... tags) {
|
||||
List<Tag> allTags = new ArrayList(Arrays.asList(tags));
|
||||
MeterBinder meterBinder = getMeterBinder(cache, allTags);
|
||||
if (meterBinder != null) {
|
||||
meterBinder.bindTo(this.registry);
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
private MeterBinder getMeterBinder(Cache cache, List<Tag> tags) {
|
||||
tags.addAll(getAdditionalTags(cache));
|
||||
for (CacheMeterBinderProvider binderProvider : this.cacheMeterBinderProviders) {
|
||||
MeterBinder meterBinder = binderProvider.getMeterBinder(cache,
|
||||
this.metricName, tags);
|
||||
if (meterBinder != null) {
|
||||
return meterBinder;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return additional {@link Tag tags} to be associated with the given {@link Cache}.
|
||||
* @param cache the cache
|
||||
* @return a list of additional tags to associate to that {@code cache}.
|
||||
*/
|
||||
protected List<Tag> getAdditionalTags(Cache cache) {
|
||||
return Tags.zip("name", cache.getName());
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,98 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.autoconfigure.metrics.cache;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.Map;
|
||||
|
||||
import javax.annotation.PostConstruct;
|
||||
|
||||
import io.micrometer.core.instrument.MeterRegistry;
|
||||
import io.micrometer.core.instrument.Tag;
|
||||
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProvider;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.CacheManager;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
/**
|
||||
* Configure a {@link CacheMetricsRegistrar} and register all available
|
||||
* {@link Cache caches}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
*/
|
||||
@Configuration
|
||||
@ConditionalOnBean(CacheMeterBinderProvider.class)
|
||||
class CacheMetricsRegistrarConfiguration {
|
||||
|
||||
private static final String CACHE_MANAGER_SUFFIX = "cacheManager";
|
||||
|
||||
private final MeterRegistry registry;
|
||||
|
||||
private final CacheMetricsProperties properties;
|
||||
|
||||
private final Collection<CacheMeterBinderProvider> cacheMeterBinderProviders;
|
||||
|
||||
private final Map<String, CacheManager> cacheManagers;
|
||||
|
||||
CacheMetricsRegistrarConfiguration(MeterRegistry registry,
|
||||
CacheMetricsProperties properties,
|
||||
Collection<CacheMeterBinderProvider> cacheMeterBinderProviders,
|
||||
Map<String, CacheManager> cacheManagers) {
|
||||
this.registry = registry;
|
||||
this.cacheMeterBinderProviders = cacheMeterBinderProviders;
|
||||
this.properties = properties;
|
||||
this.cacheManagers = cacheManagers;
|
||||
}
|
||||
|
||||
@Bean
|
||||
public CacheMetricsRegistrar cacheMetricsRegistrar() {
|
||||
return new CacheMetricsRegistrar(this.registry,
|
||||
this.properties.getCacheMetricName(), this.cacheMeterBinderProviders);
|
||||
}
|
||||
|
||||
@PostConstruct
|
||||
public void bindCachesToRegistry() {
|
||||
this.cacheManagers.forEach((beanName, cacheManager) -> cacheManager.getCacheNames()
|
||||
.forEach((cacheName) ->
|
||||
bindCacheToRegistry(beanName, cacheManager.getCache(cacheName))));
|
||||
}
|
||||
|
||||
private void bindCacheToRegistry(String beanName, Cache cache) {
|
||||
Tag cacheManagerTag = Tag.of("cacheManager", getCacheManagerName(beanName));
|
||||
cacheMetricsRegistrar().bindCacheToRegistry(cache, cacheManagerTag);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the name of a {@link CacheManager} based on its {@code beanName}.
|
||||
* @param beanName the name of the {@link CacheManager} bean
|
||||
* @return a name for the given cache manager
|
||||
*/
|
||||
private String getCacheManagerName(String beanName) {
|
||||
if (beanName.length() > CACHE_MANAGER_SUFFIX.length()
|
||||
&& StringUtils.endsWithIgnoreCase(beanName, CACHE_MANAGER_SUFFIX)) {
|
||||
return beanName.substring(0,
|
||||
beanName.length() - CACHE_MANAGER_SUFFIX.length());
|
||||
}
|
||||
return beanName;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,124 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.autoconfigure.metrics.cache;
|
||||
|
||||
import io.micrometer.core.instrument.MeterRegistry;
|
||||
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||
import org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration;
|
||||
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
|
||||
import org.springframework.cache.annotation.EnableCaching;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link CacheMetricsConfiguration}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
public class CacheMetricsConfigurationTests {
|
||||
|
||||
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
|
||||
.withUserConfiguration(RegistryConfiguration.class)
|
||||
.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class))
|
||||
.withPropertyValues("management.metrics.use-global-registry=false");
|
||||
|
||||
@Test
|
||||
public void autoConfiguredCacheManagerIsInstrumented() {
|
||||
this.contextRunner
|
||||
.withConfiguration(
|
||||
AutoConfigurations.of(CacheAutoConfiguration.class))
|
||||
.withPropertyValues("spring.cache.type=caffeine",
|
||||
"spring.cache.cache-names=cache1,cache2")
|
||||
.run((context) -> {
|
||||
MeterRegistry registry = context.getBean(MeterRegistry.class);
|
||||
assertThat(registry.find("cache.requests")
|
||||
.tags("name", "cache1")
|
||||
.tags("cacheManager", "cacheManager").meter()).isPresent();
|
||||
assertThat(registry.find("cache.requests")
|
||||
.tags("name", "cache2")
|
||||
.tags("cacheManager", "cacheManager").meter()).isPresent();
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
public void autoConfiguredCacheManagerWithCustomMetricName() {
|
||||
this.contextRunner
|
||||
.withConfiguration(
|
||||
AutoConfigurations.of(CacheAutoConfiguration.class))
|
||||
.withPropertyValues(
|
||||
"management.metrics.cache.cache-metric-name=custom.name",
|
||||
"spring.cache.type=caffeine", "spring.cache.cache-names=cache1")
|
||||
.run((context) -> {
|
||||
MeterRegistry registry = context.getBean(MeterRegistry.class);
|
||||
assertThat(registry.find("custom.name.requests")
|
||||
.tags("name", "cache1")
|
||||
.tags("cacheManager", "cacheManager").meter()).isPresent();
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
public void autoConfiguredNonSupportedCacheManagerIsIgnored() {
|
||||
this.contextRunner
|
||||
.withConfiguration(
|
||||
AutoConfigurations.of(CacheAutoConfiguration.class))
|
||||
.withPropertyValues("spring.cache.type=simple",
|
||||
"spring.cache.cache-names=cache1,cache2")
|
||||
.run((context) -> {
|
||||
MeterRegistry registry = context.getBean(MeterRegistry.class);
|
||||
assertThat(registry.find("cache.requests")
|
||||
.tags("name", "cache1")
|
||||
.tags("cacheManager", "cacheManager").meter()).isNotPresent();
|
||||
assertThat(registry.find("cache.requests")
|
||||
.tags("name", "cache2")
|
||||
.tags("cacheManager", "cacheManager").meter()).isNotPresent();
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
public void cacheInstrumentationCanBeDisabled() {
|
||||
this.contextRunner
|
||||
.withConfiguration(
|
||||
AutoConfigurations.of(CacheAutoConfiguration.class))
|
||||
.withPropertyValues("management.metrics.cache.instrument-cache=false",
|
||||
"spring.cache.type=caffeine", "spring.cache.cache-names=cache1")
|
||||
.run((context) -> {
|
||||
MeterRegistry registry = context.getBean(MeterRegistry.class);
|
||||
assertThat(registry.find("cache.requests")
|
||||
.tags("name", "cache1")
|
||||
.tags("cacheManager", "cacheManager").meter()).isNotPresent();
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
@Configuration
|
||||
@EnableCaching
|
||||
static class RegistryConfiguration {
|
||||
|
||||
@Bean
|
||||
public MeterRegistry meterRegistry() {
|
||||
return new SimpleMeterRegistry();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,61 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.autoconfigure.metrics.cache;
|
||||
|
||||
import java.util.Collections;
|
||||
|
||||
import com.github.benmanes.caffeine.cache.Caffeine;
|
||||
import io.micrometer.core.instrument.MeterRegistry;
|
||||
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProviders;
|
||||
import org.springframework.cache.caffeine.CaffeineCache;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link CacheMetricsRegistrar}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
public class CacheMetricsRegistrarTests {
|
||||
|
||||
private final MeterRegistry meterRegistry = new SimpleMeterRegistry();
|
||||
|
||||
@Test
|
||||
public void bindToSupportedCache() {
|
||||
CacheMetricsRegistrar registrar = new CacheMetricsRegistrar(this.meterRegistry,
|
||||
"root", Collections.singleton(
|
||||
new CacheMeterBinderProviders.CaffeineCacheMeterBinderProvider()));
|
||||
assertThat(registrar.bindCacheToRegistry(
|
||||
new CaffeineCache("test", Caffeine.newBuilder().build()))).isTrue();
|
||||
assertThat(this.meterRegistry.find("root.requests")
|
||||
.tags("name", "test").meter()).isPresent();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void bindToUnsupportedCache() {
|
||||
CacheMetricsRegistrar registrar = new CacheMetricsRegistrar(this.meterRegistry,
|
||||
"root", Collections.EMPTY_LIST);
|
||||
assertThat(registrar.bindCacheToRegistry(
|
||||
new CaffeineCache("test", Caffeine.newBuilder().build()))).isFalse();
|
||||
assertThat(this.meterRegistry.find("root.requests")
|
||||
.tags("name", "test").meter()).isNotPresent();
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,42 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.metrics.cache;
|
||||
|
||||
import io.micrometer.core.instrument.Tag;
|
||||
import io.micrometer.core.instrument.binder.MeterBinder;
|
||||
|
||||
import org.springframework.cache.Cache;
|
||||
|
||||
/**
|
||||
* Provide a {@link MeterBinder} based on a {@link Cache}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public interface CacheMeterBinderProvider {
|
||||
|
||||
/**
|
||||
* Return the {@link MeterBinder} managing the specified {@link Cache} or {@code null}
|
||||
* if the specified {@link Cache} is not supported.
|
||||
* @param cache the cache to instrument
|
||||
* @param name the name prefix of the metrics
|
||||
* @param tags tags to apply to all recorded metrics
|
||||
* @return a {@link MeterBinder} handling the specified {@link Cache} or {@code null}
|
||||
*/
|
||||
MeterBinder getMeterBinder(Cache cache, String name, Iterable<Tag> tags);
|
||||
|
||||
}
|
||||
@ -0,0 +1,104 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.metrics.cache;
|
||||
|
||||
import com.hazelcast.core.IMap;
|
||||
import com.hazelcast.spring.cache.HazelcastCache;
|
||||
import io.micrometer.core.instrument.Tag;
|
||||
import io.micrometer.core.instrument.binder.MeterBinder;
|
||||
import io.micrometer.core.instrument.binder.cache.CaffeineCacheMetrics;
|
||||
import io.micrometer.core.instrument.binder.cache.EhCache2Metrics;
|
||||
import io.micrometer.core.instrument.binder.cache.HazelcastCacheMetrics;
|
||||
import io.micrometer.core.instrument.binder.cache.JCacheMetrics;
|
||||
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.caffeine.CaffeineCache;
|
||||
import org.springframework.cache.ehcache.EhCacheCache;
|
||||
import org.springframework.cache.jcache.JCacheCache;
|
||||
|
||||
/**
|
||||
* Common {@link CacheMeterBinderProvider} implementations.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 2.0.0
|
||||
*/
|
||||
public abstract class CacheMeterBinderProviders {
|
||||
|
||||
/**
|
||||
* {@link CacheMeterBinderProvider} implementation for Caffeine.
|
||||
*/
|
||||
public static class CaffeineCacheMeterBinderProvider
|
||||
implements CacheMeterBinderProvider {
|
||||
|
||||
@Override
|
||||
public MeterBinder getMeterBinder(Cache cache, String name, Iterable<Tag> tags) {
|
||||
if (cache instanceof CaffeineCache) {
|
||||
return new CaffeineCacheMetrics(
|
||||
((CaffeineCache) cache).getNativeCache(), tags, name);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link CacheMeterBinderProvider} implementation for EhCache2.
|
||||
*/
|
||||
public static class EhCache2CacheMeterBinderProvider
|
||||
implements CacheMeterBinderProvider {
|
||||
|
||||
@Override
|
||||
public MeterBinder getMeterBinder(Cache cache, String name, Iterable<Tag> tags) {
|
||||
if (cache instanceof EhCacheCache) {
|
||||
return new EhCache2Metrics(((EhCacheCache) cache).getNativeCache(),
|
||||
name, tags);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link CacheMeterBinderProvider} implementation for Hazelcast.
|
||||
*/
|
||||
public static class HazelcastCacheMeterBinderProvider
|
||||
implements CacheMeterBinderProvider {
|
||||
|
||||
@Override
|
||||
public MeterBinder getMeterBinder(Cache cache, String name, Iterable<Tag> tags) {
|
||||
if (cache instanceof HazelcastCache) {
|
||||
IMap<Object, Object> nativeCache = (IMap<Object, Object>) ((HazelcastCache) cache).getNativeCache();
|
||||
return new HazelcastCacheMetrics(nativeCache, name, tags);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@link CacheMeterBinderProvider} implementation for JCache.
|
||||
*/
|
||||
public static class JCacheCacheMeterBinderProvider
|
||||
implements CacheMeterBinderProvider {
|
||||
@Override
|
||||
public MeterBinder getMeterBinder(Cache cache, String name, Iterable<Tag> tags) {
|
||||
if (cache instanceof JCacheCache) {
|
||||
return new JCacheMetrics(((JCacheCache) cache).getNativeCache(),
|
||||
name, tags);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,135 @@
|
||||
/*
|
||||
* Copyright 2012-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.boot.actuate.metrics.cache;
|
||||
|
||||
import java.net.URI;
|
||||
import java.net.URISyntaxException;
|
||||
import java.util.Collections;
|
||||
|
||||
import com.github.benmanes.caffeine.cache.Caffeine;
|
||||
import com.hazelcast.core.IMap;
|
||||
import com.hazelcast.spring.cache.HazelcastCache;
|
||||
import io.micrometer.core.instrument.binder.MeterBinder;
|
||||
import io.micrometer.core.instrument.binder.cache.CaffeineCacheMetrics;
|
||||
import io.micrometer.core.instrument.binder.cache.EhCache2Metrics;
|
||||
import io.micrometer.core.instrument.binder.cache.HazelcastCacheMetrics;
|
||||
import io.micrometer.core.instrument.binder.cache.JCacheMetrics;
|
||||
import net.sf.ehcache.Cache;
|
||||
import net.sf.ehcache.CacheManager;
|
||||
import net.sf.ehcache.config.CacheConfiguration;
|
||||
import net.sf.ehcache.config.Configuration;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProviders.CaffeineCacheMeterBinderProvider;
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProviders.EhCache2CacheMeterBinderProvider;
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProviders.HazelcastCacheMeterBinderProvider;
|
||||
import org.springframework.boot.actuate.metrics.cache.CacheMeterBinderProviders.JCacheCacheMeterBinderProvider;
|
||||
import org.springframework.cache.caffeine.CaffeineCache;
|
||||
import org.springframework.cache.concurrent.ConcurrentMapCache;
|
||||
import org.springframework.cache.ehcache.EhCacheCache;
|
||||
import org.springframework.cache.jcache.JCacheCache;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.BDDMockito.given;
|
||||
import static org.mockito.Mockito.mock;
|
||||
|
||||
/**
|
||||
* Tests for {@link CacheMeterBinderProviders}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
public class CacheMeterBinderProvidersTests {
|
||||
|
||||
@Test
|
||||
public void caffeineCacheProvider() {
|
||||
CaffeineCache cache = new CaffeineCache("test", Caffeine.newBuilder().build());
|
||||
MeterBinder meterBinder = new CaffeineCacheMeterBinderProvider().getMeterBinder(
|
||||
cache, "test", Collections.EMPTY_LIST);
|
||||
assertThat(meterBinder).isInstanceOf(CaffeineCacheMetrics.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void caffeineCacheProviderWithUnsupportedCache() {
|
||||
MeterBinder meterBinder = new CaffeineCacheMeterBinderProvider().getMeterBinder(
|
||||
new ConcurrentMapCache("test"), "test", Collections.EMPTY_LIST);
|
||||
assertThat(meterBinder).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ehCache2CacheProvider() {
|
||||
CacheManager cacheManager = new CacheManager(
|
||||
new Configuration().name("EhCacheCacheTests").defaultCache(
|
||||
new CacheConfiguration("default", 100)));
|
||||
try {
|
||||
Cache nativeCache = new Cache(
|
||||
new CacheConfiguration("test", 100));
|
||||
cacheManager.addCache(nativeCache);
|
||||
EhCacheCache cache = new EhCacheCache(nativeCache);
|
||||
MeterBinder meterBinder = new EhCache2CacheMeterBinderProvider().getMeterBinder(
|
||||
cache, "test", Collections.EMPTY_LIST);
|
||||
assertThat(meterBinder).isInstanceOf(EhCache2Metrics.class);
|
||||
}
|
||||
finally {
|
||||
cacheManager.shutdown();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void ehCache2CacheProviderWithUnsupportedCache() {
|
||||
MeterBinder meterBinder = new EhCache2CacheMeterBinderProvider().getMeterBinder(
|
||||
new ConcurrentMapCache("test"), "test", Collections.EMPTY_LIST);
|
||||
assertThat(meterBinder).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void hazelcastCacheProvider() {
|
||||
IMap<Object, Object> nativeCache = mock(IMap.class);
|
||||
given(nativeCache.getName()).willReturn("test");
|
||||
HazelcastCache cache = new HazelcastCache(nativeCache);
|
||||
MeterBinder meterBinder = new HazelcastCacheMeterBinderProvider().getMeterBinder(
|
||||
cache, "test", Collections.EMPTY_LIST);
|
||||
assertThat(meterBinder).isInstanceOf(HazelcastCacheMetrics.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void hazelcastCacheProviderWithUnsupportedCache() {
|
||||
MeterBinder meterBinder = new HazelcastCacheMeterBinderProvider().getMeterBinder(
|
||||
new ConcurrentMapCache("test"), "test", Collections.EMPTY_LIST);
|
||||
assertThat(meterBinder).isNull();
|
||||
}
|
||||
|
||||
@Test
|
||||
public void jCacheCacheProvider() throws URISyntaxException {
|
||||
javax.cache.CacheManager cacheManager = mock(javax.cache.CacheManager.class);
|
||||
given(cacheManager.getURI()).willReturn(new URI("/test"));
|
||||
javax.cache.Cache<Object, Object> nativeCache = mock(javax.cache.Cache.class);
|
||||
given(nativeCache.getCacheManager()).willReturn(cacheManager);
|
||||
given(nativeCache.getName()).willReturn("test");
|
||||
JCacheCache cache = new JCacheCache(nativeCache);
|
||||
MeterBinder meterBinder = new JCacheCacheMeterBinderProvider().getMeterBinder(
|
||||
cache, "test", Collections.EMPTY_LIST);
|
||||
assertThat(meterBinder).isInstanceOf(JCacheMetrics.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void jCacheCacheWithUnsupportedCache() {
|
||||
MeterBinder meterBinder = new JCacheCacheMeterBinderProvider().getMeterBinder(
|
||||
new ConcurrentMapCache("test"), "test", Collections.EMPTY_LIST);
|
||||
assertThat(meterBinder).isNull();
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue