Expose cache statistics as metrics
Add an abstraction that provides a standard manner to retrieve a statistics snapshot of a cache. Specific implementations for JSR-107, ehcache, hazelcast, guava and concurrent map are provided. At the moment the size of the cache and the hit/miss ratios are recorded. Cache metrics are exposed via the `cache.` prefix followed by the name of the cache. In case of conflict, the name of the cache manager is added as a qualifier. It is possible to easily register a new CacheStatisticsProvider for an unsupported cache system and the CacheStatistics object itself can be extended to provide additional metrics. See gh-2633 Closes gh-2770pull/2141/merge
Stephane Nicoll
10 years ago
committed by
Andy Wilkinson
parent
578bd5dc37
commit
bbbb34a690
@ -0,0 +1,66 @@
|
||||
/*
|
||||
* 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.cache;
|
||||
|
||||
import java.util.Collection;
|
||||
|
||||
import org.springframework.boot.actuate.metrics.Metric;
|
||||
|
||||
/**
|
||||
* Snapshot of the statistics of a given cache. {@code CacheStatistics} instances have a
|
||||
* very short life as it represents the statistics of a cache at one particular point in
|
||||
* time.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 1.3.0
|
||||
*/
|
||||
public interface CacheStatistics {
|
||||
|
||||
/**
|
||||
* Generate the relevant {@link Metric} instances based on the specified prefix.
|
||||
* @param prefix the metrics prefix (ends with '.')
|
||||
* @return the metrics corresponding to this instance
|
||||
*/
|
||||
Collection<Metric<?>> toMetrics(String prefix);
|
||||
|
||||
/**
|
||||
* Return the size of the cache or {@code null} if that information is not available.
|
||||
* @return the size of the cache or {@code null}
|
||||
*/
|
||||
Long getSize();
|
||||
|
||||
/**
|
||||
* Return the ratio of cache requests which were hits as a value between 0 and 1 where
|
||||
* 0 means that the hit ratio is 0% and 1 means it is 100%.
|
||||
* <p>
|
||||
* This may also return {@code null} if the cache-specifics statistics does not
|
||||
* provide the necessary information
|
||||
* @return the hit ratio or {@code null}
|
||||
*/
|
||||
Double getHitRatio();
|
||||
|
||||
/**
|
||||
* Return the ratio of cache requests which were misses as value between 0 and 1 where
|
||||
* 0 means that the miss ratio is 0% and 1 means it is 100%.
|
||||
* <p>
|
||||
* This may also return {@code null} if the cache-specifics statistics does not
|
||||
* provide the necessary information
|
||||
* @return the miss ratio or {@code null}
|
||||
*/
|
||||
Double getMissRatio();
|
||||
|
||||
}
|
||||
@ -0,0 +1,39 @@
|
||||
/*
|
||||
* 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.cache;
|
||||
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.CacheManager;
|
||||
|
||||
/**
|
||||
* Provide a {@link CacheStatistics} based on a {@link Cache}.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 1.3.0
|
||||
*/
|
||||
public interface CacheStatisticsProvider {
|
||||
|
||||
/**
|
||||
* Return the current {@link CacheStatistics} snapshot for the specified {@link Cache}
|
||||
* or {@code null} if the given cache could not be handled.
|
||||
* @param cache the cache to handle
|
||||
* @param cacheManager the {@link CacheManager} handling this cache
|
||||
* @return the current cache statistics or {@code null}
|
||||
*/
|
||||
CacheStatistics getCacheStatistics(Cache cache, CacheManager cacheManager);
|
||||
|
||||
}
|
||||
@ -0,0 +1,62 @@
|
||||
/*
|
||||
* 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.cache;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.CacheManager;
|
||||
|
||||
/**
|
||||
* A {@link CacheStatisticsProvider} that returns the first {@link CacheStatistics} that
|
||||
* can be retrieved by one of its delegates.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 1.3.0
|
||||
*/
|
||||
public class CacheStatisticsProviders implements CacheStatisticsProvider {
|
||||
|
||||
private final List<CacheStatisticsProvider> providers;
|
||||
|
||||
/**
|
||||
* Create a {@link CacheStatisticsProviders} instance with the collection of delegates
|
||||
* to use.
|
||||
* @param providers the cache statistics providers
|
||||
*/
|
||||
public CacheStatisticsProviders(
|
||||
Collection<? extends CacheStatisticsProvider> providers) {
|
||||
this.providers = (providers == null ? Collections
|
||||
.<CacheStatisticsProvider> emptyList()
|
||||
: new ArrayList<CacheStatisticsProvider>(providers));
|
||||
}
|
||||
|
||||
@Override
|
||||
public CacheStatistics getCacheStatistics(Cache cache, CacheManager cacheManager) {
|
||||
for (CacheStatisticsProvider provider : this.providers) {
|
||||
CacheStatistics cacheStatistics = provider.getCacheStatistics(cache,
|
||||
cacheManager);
|
||||
if (cacheStatistics != null) {
|
||||
return cacheStatistics;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,204 @@
|
||||
/*
|
||||
* 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.cache;
|
||||
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
import javax.cache.Caching;
|
||||
|
||||
import net.sf.ehcache.Ehcache;
|
||||
import net.sf.ehcache.statistics.StatisticsGateway;
|
||||
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.CacheManager;
|
||||
import org.springframework.cache.concurrent.ConcurrentMapCache;
|
||||
import org.springframework.cache.ehcache.EhCacheCache;
|
||||
import org.springframework.cache.guava.GuavaCache;
|
||||
import org.springframework.cache.jcache.JCacheCache;
|
||||
import org.springframework.cache.support.NoOpCacheManager;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
import com.google.common.cache.CacheStats;
|
||||
import com.hazelcast.core.IMap;
|
||||
import com.hazelcast.monitor.LocalMapStats;
|
||||
import com.hazelcast.spring.cache.HazelcastCache;
|
||||
|
||||
/**
|
||||
* Register the {@link CacheStatisticsProvider} instances for the supported cache
|
||||
* libraries.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 1.3.0
|
||||
*/
|
||||
@Configuration
|
||||
@ConditionalOnBean(CacheManager.class)
|
||||
public class CacheStatisticsProvidersConfiguration {
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass({ Caching.class, JCacheCache.class })
|
||||
static class JCacheCacheStatisticsProviderConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheStatisticsProvider jCacheCacheStatisticsProvider() {
|
||||
return new JCacheCacheStatisticsProvider();
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass(Ehcache.class)
|
||||
static class EhCacheCacheStatisticsProviderConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheStatisticsProvider ehCacheCacheStatisticsProvider() {
|
||||
return new CacheStatisticsProvider() {
|
||||
@Override
|
||||
public CacheStatistics getCacheStatistics(Cache cache,
|
||||
CacheManager cacheManager) {
|
||||
if (cache instanceof EhCacheCache) {
|
||||
return getEhCacheStatistics((Ehcache) cache.getNativeCache());
|
||||
}
|
||||
return null;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private CacheStatistics getEhCacheStatistics(Ehcache cache) {
|
||||
StatisticsGateway statistics = cache.getStatistics();
|
||||
DefaultCacheStatistics stats = new DefaultCacheStatistics();
|
||||
stats.setSize(statistics.getSize());
|
||||
Double hitRatio = statistics.cacheHitRatio();
|
||||
if (!hitRatio.isNaN()) {
|
||||
stats.setHitRatio(hitRatio);
|
||||
stats.setMissRatio(1 - hitRatio);
|
||||
}
|
||||
return stats;
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass(IMap.class)
|
||||
static class HazelcastCacheStatisticsConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheStatisticsProvider hazelcastCacheStatisticsProvider() {
|
||||
return new CacheStatisticsProvider() {
|
||||
@Override
|
||||
public CacheStatistics getCacheStatistics(Cache cache,
|
||||
CacheManager cacheManager) {
|
||||
if (cache instanceof HazelcastCache) {
|
||||
return getHazelcastStatistics((IMap<?, ?>) cache.getNativeCache());
|
||||
}
|
||||
return null;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private CacheStatistics getHazelcastStatistics(IMap<?, ?> cache) {
|
||||
DefaultCacheStatistics stats = new DefaultCacheStatistics();
|
||||
LocalMapStats mapStats = cache.getLocalMapStats();
|
||||
stats.setSize(mapStats.getOwnedEntryCount());
|
||||
stats.setGetCacheCounts(mapStats.getHits(), mapStats.getGetOperationCount()
|
||||
- mapStats.getHits());
|
||||
return stats;
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass(com.google.common.cache.Cache.class)
|
||||
static class GuavaCacheStatisticsConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheStatisticsProvider guavaCacheStatisticsProvider() {
|
||||
return new CacheStatisticsProvider() {
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public CacheStatistics getCacheStatistics(Cache cache,
|
||||
CacheManager cacheManager) {
|
||||
if (cache instanceof GuavaCache) {
|
||||
return getGuavaStatistics((com.google.common.cache.Cache<Object, Object>) cache
|
||||
.getNativeCache());
|
||||
}
|
||||
return null;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private CacheStatistics getGuavaStatistics(
|
||||
com.google.common.cache.Cache<Object, Object> cache) {
|
||||
DefaultCacheStatistics stats = new DefaultCacheStatistics();
|
||||
stats.setSize(cache.size());
|
||||
CacheStats guavaStats = cache.stats();
|
||||
if (guavaStats.requestCount() > 0) {
|
||||
stats.setHitRatio(guavaStats.hitRate());
|
||||
stats.setMissRatio(guavaStats.missRate());
|
||||
}
|
||||
return stats;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass(ConcurrentMapCache.class)
|
||||
static class ConcurrentMapCacheStatisticsConfiguration {
|
||||
|
||||
@Bean
|
||||
public CacheStatisticsProvider concurrentMapCacheStatisticsProvider() {
|
||||
return new CacheStatisticsProvider() {
|
||||
@Override
|
||||
public CacheStatistics getCacheStatistics(Cache cache,
|
||||
CacheManager cacheManager) {
|
||||
if (cache instanceof ConcurrentMapCache) {
|
||||
return getConcurrentMapStatistics((ConcurrentHashMap<?, ?>) cache
|
||||
.getNativeCache());
|
||||
}
|
||||
return null;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
private CacheStatistics getConcurrentMapStatistics(ConcurrentHashMap<?, ?> map) {
|
||||
DefaultCacheStatistics stats = new DefaultCacheStatistics();
|
||||
stats.setSize((long) map.size());
|
||||
return stats;
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
@ConditionalOnClass(NoOpCacheManager.class)
|
||||
static class NoOpCacheStatisticsConfiguration {
|
||||
|
||||
private static final CacheStatistics NO_OP_STATS = new DefaultCacheStatistics();
|
||||
|
||||
@Bean
|
||||
public CacheStatisticsProvider noOpCacheStatisticsProvider() {
|
||||
return new CacheStatisticsProvider() {
|
||||
@Override
|
||||
public CacheStatistics getCacheStatistics(Cache cache,
|
||||
CacheManager cacheManager) {
|
||||
if (cacheManager instanceof NoOpCacheManager) {
|
||||
return NO_OP_STATS;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,89 @@
|
||||
/*
|
||||
* 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.cache;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collection;
|
||||
|
||||
import org.springframework.boot.actuate.metrics.Metric;
|
||||
|
||||
/**
|
||||
* A default {@link CacheStatistics} implementation.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 1.3.0
|
||||
*/
|
||||
public class DefaultCacheStatistics implements CacheStatistics {
|
||||
|
||||
private Long size;
|
||||
|
||||
private Double hitRatio;
|
||||
|
||||
private Double missRatio;
|
||||
|
||||
@Override
|
||||
public Collection<Metric<?>> toMetrics(String prefix) {
|
||||
Collection<Metric<?>> result = new ArrayList<Metric<?>>();
|
||||
addMetric(result, prefix + "size", getSize());
|
||||
addMetric(result, prefix + "hit.ratio", getHitRatio());
|
||||
addMetric(result, prefix + "miss.ratio", getMissRatio());
|
||||
return result;
|
||||
}
|
||||
|
||||
public void setGetCacheCounts(long hitCount, long missCount) {
|
||||
long total = hitCount + missCount;
|
||||
if (total > 0) {
|
||||
double hitRatio = hitCount / (double) total;
|
||||
setHitRatio(hitRatio);
|
||||
setMissRatio(1 - hitRatio);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public Long getSize() {
|
||||
return this.size;
|
||||
}
|
||||
|
||||
public void setSize(Long size) {
|
||||
this.size = size;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Double getHitRatio() {
|
||||
return this.hitRatio;
|
||||
}
|
||||
|
||||
public void setHitRatio(Double hitRatio) {
|
||||
this.hitRatio = hitRatio;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Double getMissRatio() {
|
||||
return this.missRatio;
|
||||
}
|
||||
|
||||
public void setMissRatio(Double missRatio) {
|
||||
this.missRatio = missRatio;
|
||||
}
|
||||
|
||||
private <T extends Number> void addMetric(Collection<Metric<?>> metrics, String name,
|
||||
T value) {
|
||||
if (value != null) {
|
||||
metrics.add(new Metric<T>(name, value));
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,136 @@
|
||||
/*
|
||||
* 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.cache;
|
||||
|
||||
import java.lang.management.ManagementFactory;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
import javax.management.AttributeNotFoundException;
|
||||
import javax.management.InstanceNotFoundException;
|
||||
import javax.management.MBeanException;
|
||||
import javax.management.MBeanServer;
|
||||
import javax.management.MalformedObjectNameException;
|
||||
import javax.management.ObjectInstance;
|
||||
import javax.management.ObjectName;
|
||||
import javax.management.ReflectionException;
|
||||
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.CacheManager;
|
||||
import org.springframework.cache.jcache.JCacheCache;
|
||||
|
||||
/**
|
||||
* {@link CacheStatisticsProvider} implementation for a JSR-107 compliant cache.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 1.3.0
|
||||
*/
|
||||
class JCacheCacheStatisticsProvider implements CacheStatisticsProvider {
|
||||
|
||||
private static final Logger logger = LoggerFactory
|
||||
.getLogger(JCacheCacheStatisticsProvider.class);
|
||||
|
||||
private MBeanServer mBeanServer;
|
||||
|
||||
private Map<JCacheCache, ObjectName> caches = new ConcurrentHashMap<JCacheCache, ObjectName>();
|
||||
|
||||
@Override
|
||||
public CacheStatistics getCacheStatistics(Cache cache, CacheManager cacheManager) {
|
||||
if (cache instanceof JCacheCache) {
|
||||
return getCacheStatistics((JCacheCache) cache);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
protected CacheStatistics getCacheStatistics(JCacheCache cache) {
|
||||
try {
|
||||
ObjectName objectName = getObjectName(cache);
|
||||
if (objectName != null) {
|
||||
return getCacheStatistics(objectName);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
catch (MalformedObjectNameException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
}
|
||||
|
||||
protected CacheStatistics getCacheStatistics(ObjectName objectName) {
|
||||
MBeanServer mBeanServer = getMBeanServer();
|
||||
DefaultCacheStatistics stats = new DefaultCacheStatistics();
|
||||
Float hitPercentage = getAttribute(mBeanServer, objectName, "CacheHitPercentage",
|
||||
Float.class);
|
||||
Float missPercentage = getAttribute(mBeanServer, objectName,
|
||||
"CacheMissPercentage", Float.class);
|
||||
if ((hitPercentage != null && missPercentage != null)
|
||||
&& (hitPercentage > 0 || missPercentage > 0)) {
|
||||
stats.setHitRatio(hitPercentage / (double) 100);
|
||||
stats.setMissRatio(missPercentage / (double) 100);
|
||||
}
|
||||
return stats;
|
||||
}
|
||||
|
||||
protected ObjectName getObjectName(JCacheCache cache)
|
||||
throws MalformedObjectNameException {
|
||||
if (this.caches.containsKey(cache)) {
|
||||
return this.caches.get(cache);
|
||||
}
|
||||
|
||||
Set<ObjectInstance> instances = getMBeanServer().queryMBeans(
|
||||
new ObjectName("javax.cache:type=CacheStatistics,Cache="
|
||||
+ cache.getName() + ",*"), null);
|
||||
if (instances.size() == 1) {
|
||||
ObjectName objectName = instances.iterator().next().getObjectName();
|
||||
this.caches.put(cache, objectName);
|
||||
return objectName;
|
||||
}
|
||||
return null; // None or more than one
|
||||
}
|
||||
|
||||
protected MBeanServer getMBeanServer() {
|
||||
if (this.mBeanServer == null) {
|
||||
this.mBeanServer = ManagementFactory.getPlatformMBeanServer();
|
||||
}
|
||||
return this.mBeanServer;
|
||||
}
|
||||
|
||||
private static <T> T getAttribute(MBeanServer mBeanServer, ObjectName objectName,
|
||||
String attributeName, Class<T> type) {
|
||||
try {
|
||||
Object attribute = mBeanServer.getAttribute(objectName, attributeName);
|
||||
return type.cast(attribute);
|
||||
}
|
||||
catch (MBeanException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
catch (AttributeNotFoundException e) {
|
||||
throw new IllegalStateException("Unexpected: jcache provider does not "
|
||||
+ "expose standard attribute " + attributeName, e);
|
||||
}
|
||||
catch (InstanceNotFoundException e) {
|
||||
logger.warn("Cache statistics are no longer available", e);
|
||||
}
|
||||
catch (ReflectionException e) {
|
||||
throw new IllegalStateException(e);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,104 @@
|
||||
/*
|
||||
* 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.endpoint;
|
||||
|
||||
import java.util.Collection;
|
||||
import java.util.HashSet;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
|
||||
import javax.annotation.PostConstruct;
|
||||
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.actuate.cache.CacheStatistics;
|
||||
import org.springframework.boot.actuate.cache.CacheStatisticsProvider;
|
||||
import org.springframework.boot.actuate.cache.CacheStatisticsProviders;
|
||||
import org.springframework.boot.actuate.metrics.Metric;
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.CacheManager;
|
||||
|
||||
/**
|
||||
* A {@link PublicMetrics} implementation that provides cache statistics.
|
||||
*
|
||||
* @author Stephane Nicoll
|
||||
* @since 1.3.0
|
||||
*/
|
||||
public class CachePublicMetrics implements PublicMetrics {
|
||||
|
||||
@Autowired
|
||||
private Collection<CacheStatisticsProvider> providers;
|
||||
|
||||
@Autowired
|
||||
private Map<String, CacheManager> cacheManagers;
|
||||
|
||||
private CacheStatisticsProvider cacheStatisticsProvider;
|
||||
|
||||
@PostConstruct
|
||||
public void initialize() {
|
||||
this.cacheStatisticsProvider = new CacheStatisticsProviders(this.providers);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Collection<Metric<?>> metrics() {
|
||||
Set<String> targetNames = new HashSet<String>();
|
||||
Collection<Metric<?>> metrics = new HashSet<Metric<?>>();
|
||||
for (Map.Entry<String, CacheManager> entry : this.cacheManagers.entrySet()) {
|
||||
String cacheManagerName = entry.getKey();
|
||||
CacheManager cacheManager = entry.getValue();
|
||||
for (String cacheName : cacheManager.getCacheNames()) {
|
||||
Cache cache = cacheManager.getCache(cacheName);
|
||||
CacheStatistics cacheStatistics = this.cacheStatisticsProvider
|
||||
.getCacheStatistics(cache, cacheManager);
|
||||
if (cacheStatistics != null) {
|
||||
String prefix = cleanPrefix(createPrefix(targetNames, cacheName,
|
||||
cacheManagerName));
|
||||
metrics.addAll(cacheStatistics.toMetrics(prefix));
|
||||
}
|
||||
}
|
||||
}
|
||||
return metrics;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the prefix to use for the specified cache. The specified {@code targetNames}
|
||||
* set contains the names that have been acquired so far.
|
||||
* @param targetNames the target names that have been used for other caches
|
||||
* @param cacheName the name of the cache
|
||||
* @param cacheManagerName the name of its cache manager
|
||||
* @return a prefix to use for the specified cache
|
||||
*/
|
||||
protected String createPrefix(Set<String> targetNames, String cacheName,
|
||||
String cacheManagerName) {
|
||||
if (targetNames.contains(cacheName)) {
|
||||
String target = cacheManagerName + "_" + cacheName;
|
||||
return createPrefixFor(target);
|
||||
}
|
||||
else {
|
||||
targetNames.add(cacheName);
|
||||
return createPrefixFor(cacheName);
|
||||
}
|
||||
}
|
||||
|
||||
protected String createPrefixFor(String name) {
|
||||
return "cache." + name;
|
||||
}
|
||||
|
||||
private String cleanPrefix(String prefix) {
|
||||
return (prefix.endsWith(".") ? prefix : prefix + ".");
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,270 @@
|
||||
/*
|
||||
* 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.cache;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.Arrays;
|
||||
|
||||
import javax.cache.Caching;
|
||||
import javax.cache.configuration.MutableConfiguration;
|
||||
|
||||
import org.junit.After;
|
||||
import org.junit.Test;
|
||||
import org.springframework.cache.Cache;
|
||||
import org.springframework.cache.CacheManager;
|
||||
import org.springframework.cache.concurrent.ConcurrentMapCacheManager;
|
||||
import org.springframework.cache.ehcache.EhCacheCacheManager;
|
||||
import org.springframework.cache.ehcache.EhCacheManagerUtils;
|
||||
import org.springframework.cache.guava.GuavaCacheManager;
|
||||
import org.springframework.cache.jcache.JCacheCacheManager;
|
||||
import org.springframework.cache.support.NoOpCacheManager;
|
||||
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.io.ClassPathResource;
|
||||
import org.springframework.core.io.Resource;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
import com.google.common.cache.CacheBuilder;
|
||||
import com.hazelcast.cache.HazelcastCachingProvider;
|
||||
import com.hazelcast.config.Config;
|
||||
import com.hazelcast.config.XmlConfigBuilder;
|
||||
import com.hazelcast.core.Hazelcast;
|
||||
import com.hazelcast.core.HazelcastInstance;
|
||||
import com.hazelcast.spring.cache.HazelcastCacheManager;
|
||||
|
||||
import static org.junit.Assert.assertEquals;
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
|
||||
/**
|
||||
* @author Stephane Nicoll
|
||||
*/
|
||||
public class CacheStatisticsProviderTests {
|
||||
|
||||
private AnnotationConfigApplicationContext context;
|
||||
|
||||
private CacheManager cacheManager;
|
||||
|
||||
@After
|
||||
public void after() {
|
||||
if (this.context != null) {
|
||||
this.context.close();
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void basicJCacheCacheStatistics() {
|
||||
load(JCacheCacheConfig.class);
|
||||
CacheStatisticsProvider provider = this.context.getBean(
|
||||
"jCacheCacheStatisticsProvider", CacheStatisticsProvider.class);
|
||||
doTestCoreStatistics(provider, false);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void basicEhCacheCacheStatistics() {
|
||||
load(EhCacheConfig.class);
|
||||
CacheStatisticsProvider provider = this.context.getBean(
|
||||
"ehCacheCacheStatisticsProvider", CacheStatisticsProvider.class);
|
||||
doTestCoreStatistics(provider, true);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void basicHazelcastCacheStatistics() {
|
||||
load(HazelcastConfig.class);
|
||||
CacheStatisticsProvider provider = this.context.getBean(
|
||||
"hazelcastCacheStatisticsProvider", CacheStatisticsProvider.class);
|
||||
doTestCoreStatistics(provider, true);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void basicGuavaCacheStatistics() {
|
||||
load(GuavaConfig.class);
|
||||
CacheStatisticsProvider provider = this.context.getBean(
|
||||
"guavaCacheStatisticsProvider", CacheStatisticsProvider.class);
|
||||
doTestCoreStatistics(provider, true);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void concurrentMapCacheStatistics() {
|
||||
load(ConcurrentMapConfig.class);
|
||||
CacheStatisticsProvider provider = this.context.getBean(
|
||||
"concurrentMapCacheStatisticsProvider", CacheStatisticsProvider.class);
|
||||
Cache books = getCache("books");
|
||||
CacheStatistics cacheStatistics = provider.getCacheStatistics(books,
|
||||
this.cacheManager);
|
||||
assertCoreStatistics(cacheStatistics, 0L, null, null);
|
||||
getOrCreate(books, "a", "b", "b", "a", "a");
|
||||
CacheStatistics updatedCacheStatistics = provider.getCacheStatistics(books,
|
||||
this.cacheManager);
|
||||
assertCoreStatistics(updatedCacheStatistics, 2L, null, null);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void noOpCacheStatistics() {
|
||||
load(NoOpCacheConfig.class);
|
||||
CacheStatisticsProvider provider = this.context.getBean(
|
||||
"noOpCacheStatisticsProvider", CacheStatisticsProvider.class);
|
||||
Cache books = getCache("books");
|
||||
CacheStatistics cacheStatistics = provider.getCacheStatistics(books,
|
||||
this.cacheManager);
|
||||
assertCoreStatistics(cacheStatistics, null, null, null);
|
||||
getOrCreate(books, "a", "b", "b", "a", "a");
|
||||
CacheStatistics updatedCacheStatistics = provider.getCacheStatistics(books,
|
||||
this.cacheManager);
|
||||
assertCoreStatistics(updatedCacheStatistics, null, null, null);
|
||||
}
|
||||
|
||||
private void doTestCoreStatistics(CacheStatisticsProvider provider,
|
||||
boolean supportSize) {
|
||||
Cache books = getCache("books");
|
||||
CacheStatistics cacheStatistics = provider.getCacheStatistics(books,
|
||||
this.cacheManager);
|
||||
assertCoreStatistics(cacheStatistics, (supportSize ? 0L : null), null, null);
|
||||
getOrCreate(books, "a", "b", "b", "a", "a", "a");
|
||||
CacheStatistics updatedCacheStatistics = provider.getCacheStatistics(books,
|
||||
this.cacheManager);
|
||||
assertCoreStatistics(updatedCacheStatistics, (supportSize ? 2L : null), 0.66D,
|
||||
0.33D);
|
||||
}
|
||||
|
||||
private void assertCoreStatistics(CacheStatistics metrics, Long size,
|
||||
Double hitRatio, Double missRatio) {
|
||||
assertNotNull("Cache metrics must not be null", metrics);
|
||||
assertEquals("Wrong size for metrics " + metrics, size, metrics.getSize());
|
||||
checkRatio("Wrong hit ratio for metrics " + metrics, hitRatio,
|
||||
metrics.getHitRatio());
|
||||
checkRatio("Wrong miss ratio for metrics " + metrics, missRatio,
|
||||
metrics.getMissRatio());
|
||||
}
|
||||
|
||||
private void checkRatio(String message, Double expected, Double actual) {
|
||||
if (expected == null || actual == null) {
|
||||
assertEquals(message, expected, actual);
|
||||
}
|
||||
else {
|
||||
assertEquals(message, expected, actual, 0.01D);
|
||||
}
|
||||
}
|
||||
|
||||
private void getOrCreate(Cache cache, String... ids) {
|
||||
for (String id : ids) {
|
||||
Cache.ValueWrapper wrapper = cache.get(id);
|
||||
if (wrapper == null) {
|
||||
cache.put(id, id);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private Cache getCache(String cacheName) {
|
||||
Cache cache = this.cacheManager.getCache(cacheName);
|
||||
Assert.notNull("No cache with name '" + cacheName + "' found.");
|
||||
return cache;
|
||||
}
|
||||
|
||||
private void load(Class<?>... config) {
|
||||
this.context = new AnnotationConfigApplicationContext();
|
||||
if (config.length > 0) {
|
||||
this.context.register(config);
|
||||
}
|
||||
this.context.register(CacheStatisticsProvidersConfiguration.class);
|
||||
this.context.refresh();
|
||||
this.cacheManager = this.context.getBean(CacheManager.class);
|
||||
}
|
||||
|
||||
@Configuration
|
||||
static class JCacheCacheConfig {
|
||||
|
||||
@Bean
|
||||
public JCacheCacheManager cacheManager() {
|
||||
javax.cache.CacheManager cacheManager = jCacheCacheManager();
|
||||
return new JCacheCacheManager(cacheManager);
|
||||
}
|
||||
|
||||
@Bean
|
||||
public javax.cache.CacheManager jCacheCacheManager() {
|
||||
javax.cache.CacheManager cacheManager = Caching.getCachingProvider(
|
||||
HazelcastCachingProvider.class.getName()).getCacheManager();
|
||||
MutableConfiguration<Object, Object> config = new MutableConfiguration<Object, Object>();
|
||||
config.setStatisticsEnabled(true);
|
||||
cacheManager.createCache("books", config);
|
||||
cacheManager.createCache("speakers", config);
|
||||
return cacheManager;
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
static class EhCacheConfig {
|
||||
|
||||
@Bean
|
||||
public EhCacheCacheManager cacheManager() {
|
||||
return new EhCacheCacheManager(ehCacheCacheManager());
|
||||
}
|
||||
|
||||
@Bean
|
||||
public net.sf.ehcache.CacheManager ehCacheCacheManager() {
|
||||
return EhCacheManagerUtils.buildCacheManager(new ClassPathResource(
|
||||
"cache/test-ehcache.xml"));
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
static class HazelcastConfig {
|
||||
|
||||
@Bean
|
||||
public HazelcastCacheManager cacheManager() throws IOException {
|
||||
return new HazelcastCacheManager(hazelcastInstance());
|
||||
}
|
||||
|
||||
@Bean
|
||||
public HazelcastInstance hazelcastInstance() throws IOException {
|
||||
Resource resource = new ClassPathResource("cache/test-hazelcast.xml");
|
||||
Config cfg = new XmlConfigBuilder(resource.getURL()).build();
|
||||
return Hazelcast.newHazelcastInstance(cfg);
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
static class GuavaConfig {
|
||||
|
||||
@Bean
|
||||
public GuavaCacheManager cacheManager() throws IOException {
|
||||
GuavaCacheManager cacheManager = new GuavaCacheManager();
|
||||
cacheManager.setCacheBuilder(CacheBuilder.newBuilder().recordStats());
|
||||
cacheManager.setCacheNames(Arrays.asList("books", "speakers"));
|
||||
return cacheManager;
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
static class ConcurrentMapConfig {
|
||||
|
||||
@Bean
|
||||
public ConcurrentMapCacheManager cacheManager() {
|
||||
return new ConcurrentMapCacheManager("books", "speakers");
|
||||
}
|
||||
}
|
||||
|
||||
@Configuration
|
||||
static class NoOpCacheConfig {
|
||||
|
||||
@Bean
|
||||
public NoOpCacheManager cacheManager() {
|
||||
return new NoOpCacheManager();
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,10 @@
|
||||
<ehcache>
|
||||
<diskStore path="java.io.tmpdir"/>
|
||||
|
||||
<defaultCache/>
|
||||
|
||||
<cache name="books" maxEntriesLocalHeap="50"/>
|
||||
|
||||
<cache name="players" maxEntriesLocalHeap="50"/>
|
||||
|
||||
</ehcache>
|
||||
@ -0,0 +1,4 @@
|
||||
<hazelcast>
|
||||
<map name="books"/>
|
||||
<map name="players"/>
|
||||
</hazelcast>
|
||||
@ -0,0 +1,8 @@
|
||||
<hazelcast
|
||||
xsi:schemaLocation="http://www.hazelcast.com/schema/config hazelcast-config-3.4.xsd"
|
||||
xmlns="http://www.hazelcast.com/schema/config"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||
|
||||
<map name="defaultCache" />
|
||||
|
||||
</hazelcast>
|
||||
Loading…
Reference in New Issue