Auto configure micrometer cache metrics

Closes gh-11221

Author: snicoll

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsAutoConfiguration.java

@@ -27,6 +27,7 @@
 
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnEnabledEndpoint;
+import org.springframework.boot.actuate.autoconfigure.metrics.cache.CacheMetricsConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.MetricsExporter;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.atlas.AtlasExportConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.datadog.DatadogExportConfiguration;
@@ -45,6 +46,7 @@
 import org.springframework.boot.actuate.metrics.integration.SpringIntegrationMetrics;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -68,12 +70,13 @@
 @EnableConfigurationProperties(MetricsProperties.class)
 @Import({ MeterBindersConfiguration.class, WebMvcMetricsConfiguration.class,
 		WebFluxMetricsConfiguration.class, RestTemplateMetricsConfiguration.class,
-		DataSourcePoolMetricsConfiguration.class, AtlasExportConfiguration.class,
-		DatadogExportConfiguration.class, GangliaExportConfiguration.class,
-		GraphiteExportConfiguration.class, InfluxExportConfiguration.class,
-		JmxExportConfiguration.class, PrometheusExportConfiguration.class,
-		SimpleExportConfiguration.class, StatsdExportConfiguration.class })
-@AutoConfigureAfter(DataSourceAutoConfiguration.class)
+		CacheMetricsConfiguration.class, DataSourcePoolMetricsConfiguration.class,
+		AtlasExportConfiguration.class, DatadogExportConfiguration.class,
+		GangliaExportConfiguration.class, GraphiteExportConfiguration.class,
+		InfluxExportConfiguration.class, JmxExportConfiguration.class,
+		PrometheusExportConfiguration.class, SimpleExportConfiguration.class,
+		StatsdExportConfiguration.class })
+@AutoConfigureAfter({ CacheAutoConfiguration.class, DataSourceAutoConfiguration.class })
 public class MetricsAutoConfiguration {
 
 	@Bean

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/cache/CacheMeterBinderProvidersConfiguration.java

@@ -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();
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/cache/CacheMetricsConfiguration.java

@@ -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 {
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/cache/CacheMetricsProperties.java

@@ -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;
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/cache/CacheMetricsRegistrar.java

@@ -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());
+	}
+
+}