Merge branch '3.5.x'

Closes gh-48057

Author: wilkinsona

module/spring-boot-cache/src/main/java/org/springframework/boot/cache/autoconfigure/metrics/CacheMeterBinderProvidersConfiguration.java

@@ -24,6 +24,7 @@
 import org.cache2k.extra.spring.SpringCache2kCache;
 
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.cache.metrics.Cache2kCacheMeterBinderProvider;
 import org.springframework.boot.cache.metrics.CacheMeterBinderProvider;
 import org.springframework.boot.cache.metrics.CaffeineCacheMeterBinderProvider;
@@ -80,6 +81,7 @@ HazelcastCacheMeterBinderProvider hazelcastCacheMeterBinderProvider() {
 
 	@Configuration(proxyBeanMethods = false)
 	@ConditionalOnClass({ JCacheCache.class, javax.cache.CacheManager.class })
+	@ConditionalOnMissingBean(JCacheCacheMeterBinderProvider.class)
 	static class JCacheCacheMeterBinderProviderConfiguration {
 
 		@Bean

module/spring-boot-cache/src/main/java/org/springframework/boot/cache/metrics/JCacheCacheMeterBinderProvider.java

@@ -16,6 +16,8 @@
 
 package org.springframework.boot.cache.metrics;
 
+import io.micrometer.core.instrument.FunctionCounter;
+import io.micrometer.core.instrument.Gauge;
 import io.micrometer.core.instrument.Tag;
 import io.micrometer.core.instrument.binder.MeterBinder;
 import io.micrometer.core.instrument.binder.cache.JCacheMetrics;
@@ -30,9 +32,33 @@
  */
 public class JCacheCacheMeterBinderProvider implements CacheMeterBinderProvider<JCacheCache> {
 
+	private final boolean registerCacheRemovalsAsFunctionCounter;
+
+	/**
+	 * Creates a {@code JCacheCacheMeterBinderProvider} that registers cache removals as a
+	 * {@link Gauge}.
+	 */
+	public JCacheCacheMeterBinderProvider() {
+		this(false);
+	}
+
+	/**
+	 * Creates a {@code JCacheCacheMeterBinderProvider} that registers cache removals with
+	 * a meter type that depends on the value of
+	 * {@code registerCacheRemovalsAsFunctionCounter}. When {@code false}, cache removals
+	 * are registered as a {@link Gauge}. When {@code true}, cache removals are registered
+	 * as a {@link FunctionCounter}.
+	 * @param registerCacheRemovalsAsFunctionCounter whether to register removals as a
+	 * gauge or a function counter
+	 * @since 3.4.12
+	 */
+	public JCacheCacheMeterBinderProvider(boolean registerCacheRemovalsAsFunctionCounter) {
+		this.registerCacheRemovalsAsFunctionCounter = registerCacheRemovalsAsFunctionCounter;
+	}
+
 	@Override
 	public MeterBinder getMeterBinder(JCacheCache cache, Iterable<Tag> tags) {
-		return new JCacheMetrics<>(cache.getNativeCache(), tags);
+		return new JCacheMetrics<>(cache.getNativeCache(), tags, this.registerCacheRemovalsAsFunctionCounter);
 	}
 
 }

module/spring-boot-cache/src/test/java/org/springframework/boot/cache/autoconfigure/metrics/CacheMetricsAutoConfigurationTests.java

@@ -26,6 +26,7 @@
 
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.cache.autoconfigure.CacheAutoConfiguration;
+import org.springframework.boot.cache.metrics.JCacheCacheMeterBinderProvider;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
 import org.springframework.cache.CacheManager;
 import org.springframework.cache.annotation.CachingConfigurer;
@@ -114,6 +115,23 @@ void customCacheManagersAreInstrumented() {
 			});
 	}
 
+	@Test
+	void jcacheCacheMeterBinderProviderIsAutoConfigured() {
+		this.contextRunner.withPropertyValues("spring.cache.type=simple", "spring.cache.cache-names=cache1,cache2")
+			.run((context) -> assertThat(context).hasSingleBean(JCacheCacheMeterBinderProvider.class)
+				.hasBean("jCacheCacheMeterBinderProvider"));
+	}
+
+	@Test
+	void jcacheCacheMeterBinderProviderBacksOff() {
+		this.contextRunner.withPropertyValues("spring.cache.type=simple", "spring.cache.cache-names=cache1,cache2")
+			.withBean("customProvider", JCacheCacheMeterBinderProvider.class,
+					() -> new JCacheCacheMeterBinderProvider(true))
+			.run((context) -> assertThat(context).hasSingleBean(JCacheCacheMeterBinderProvider.class)
+				.hasBean("customProvider")
+				.doesNotHaveBean("jCacheCacheMeterBinderProvider"));
+	}
+
 	@Configuration(proxyBeanMethods = false)
 	static class CustomCacheManagersConfiguration implements CachingConfigurer {
 

module/spring-boot-cache/src/test/java/org/springframework/boot/cache/metrics/JCacheCacheMeterBinderProviderTests.java

@@ -54,6 +54,20 @@ void jCacheCacheProvider() throws URISyntaxException {
 		JCacheCache cache = new JCacheCache(this.nativeCache);
 		MeterBinder meterBinder = new JCacheCacheMeterBinderProvider().getMeterBinder(cache, Collections.emptyList());
 		assertThat(meterBinder).isInstanceOf(JCacheMetrics.class);
+		assertThat(meterBinder).extracting("registerCacheRemovalsAsFunctionCounter").isEqualTo(false);
+	}
+
+	@Test
+	void jCacheCacheProviderRegisteringRemovalsAsAFunctionCounter() throws URISyntaxException {
+		javax.cache.CacheManager cacheManager = mock(javax.cache.CacheManager.class);
+		given(cacheManager.getURI()).willReturn(new URI("/test"));
+		given(this.nativeCache.getCacheManager()).willReturn(cacheManager);
+		given(this.nativeCache.getName()).willReturn("test");
+		JCacheCache cache = new JCacheCache(this.nativeCache);
+		MeterBinder meterBinder = new JCacheCacheMeterBinderProvider(true).getMeterBinder(cache,
+				Collections.emptyList());
+		assertThat(meterBinder).isInstanceOf(JCacheMetrics.class);
+		assertThat(meterBinder).extracting("registerCacheRemovalsAsFunctionCounter").isEqualTo(true);
 	}
 
 }