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

Prevent repository metrics from causing a circular reference

Browse Source 
Fixes gh-27591
This commit is contained in:
Andy Wilkinson
2021-08-12 10:05:31 +01:00
parent f2c3c0d207
commit 35ea3b234d
5 changed files with 56 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/data/RepositoryMetricsAutoConfiguration.java
View File

@@ -64,11 +64,11 @@ public class RepositoryMetricsAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public MetricsRepositoryMethodInvocationListener metricsRepositoryMethodInvocationListener(MeterRegistry registry,
RepositoryTagsProvider tagsProvider) {
public MetricsRepositoryMethodInvocationListener metricsRepositoryMethodInvocationListener(
ObjectProvider<MeterRegistry> registry, RepositoryTagsProvider tagsProvider) {
Repository properties = this.properties.getData().getRepository();
return new MetricsRepositoryMethodInvocationListener(registry, tagsProvider, properties.getMetricName(),
properties.getAutotime());
return new MetricsRepositoryMethodInvocationListener(registry::getObject, tagsProvider,
properties.getMetricName(), properties.getAutotime());
}
@Bean

19
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/data/RepositoryMetricsAutoConfigurationIntegrationTests.java
View File

@@ -16,7 +16,9 @@
package org.springframework.boot.actuate.autoconfigure.metrics.data;
import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.binder.MeterBinder;
import org.junit.jupiter.api.Test;
import org.springframework.boot.actuate.autoconfigure.metrics.data.city.CityRepository;
@@ -28,6 +30,7 @@ import org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfig
import org.springframework.boot.autoconfigure.jdbc.EmbeddedDataSourceConfiguration;
import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import static org.assertj.core.api.Assertions.assertThat;
@@ -55,10 +58,26 @@ class RepositoryMetricsAutoConfigurationIntegrationTests {
});
}
@Test
void doesNotPreventMeterBindersFromDependingUponSpringDataRepositories() {
this.contextRunner.withUserConfiguration(SpringDataRepositoryMeterBinderConfiguration.class)
.run((context) -> assertThat(context).hasNotFailed());
}
@Configuration(proxyBeanMethods = false)
@AutoConfigurationPackage
static class TestConfig {
}
@Configuration(proxyBeanMethods = false)
static class SpringDataRepositoryMeterBinderConfiguration {
@Bean
MeterBinder meterBinder(CityRepository repository) {
return (registry) -> Gauge.builder("city.count", repository::count);
}
}
}

13
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/data/RepositoryMetricsAutoConfigurationTests.java
View File

@@ -18,6 +18,7 @@ package org.springframework.boot.actuate.autoconfigure.metrics.data;
import java.util.Collection;
import java.util.Collections;
import java.util.function.Supplier;
import io.micrometer.core.annotation.Timed;
import io.micrometer.core.instrument.Meter;
@@ -28,6 +29,7 @@ import io.micrometer.core.instrument.binder.MeterBinder;
import io.micrometer.core.instrument.distribution.HistogramSnapshot;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.ObjectFactory;
import org.springframework.boot.actuate.autoconfigure.metrics.test.MetricsRun;
import org.springframework.boot.actuate.metrics.AutoTimer;
import org.springframework.boot.actuate.metrics.data.DefaultRepositoryTagsProvider;
@@ -180,17 +182,18 @@ class RepositoryMetricsAutoConfigurationTests {
static class MetricsRepositoryMethodInvocationListenerConfiguration {
@Bean
MetricsRepositoryMethodInvocationListener metricsRepositoryMethodInvocationListener(MeterRegistry registry,
RepositoryTagsProvider tagsProvider) {
return new TestMetricsRepositoryMethodInvocationListener(registry, tagsProvider);
MetricsRepositoryMethodInvocationListener metricsRepositoryMethodInvocationListener(
ObjectFactory<MeterRegistry> registry, RepositoryTagsProvider tagsProvider) {
return new TestMetricsRepositoryMethodInvocationListener(registry::getObject, tagsProvider);
}
}
static class TestMetricsRepositoryMethodInvocationListener extends MetricsRepositoryMethodInvocationListener {
TestMetricsRepositoryMethodInvocationListener(MeterRegistry registry, RepositoryTagsProvider tagsProvider) {
super(registry, tagsProvider, "test", AutoTimer.DISABLED);
TestMetricsRepositoryMethodInvocationListener(Supplier<MeterRegistry> registrySupplier,
RepositoryTagsProvider tagsProvider) {
super(registrySupplier, tagsProvider, "test", AutoTimer.DISABLED);
}
}