Skip to content

Auto-configure meter conventions for JVM and system metrics #48068

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
+121 −8
Closed

Auto-configure meter conventions for JVM and system metrics #48068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions ...pringframework/boot/micrometer/metrics/autoconfigure/jvm/JvmMetricsAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
package org.springframework.boot.micrometer.metrics.autoconfigure.jvm;

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.binder.MeterBinder;
import io.micrometer.core.instrument.binder.jvm.ClassLoaderMetrics;
import io.micrometer.core.instrument.binder.jvm.JvmCompilationMetrics;
Expand All @@ -25,12 +26,16 @@
import io.micrometer.core.instrument.binder.jvm.JvmInfoMetrics;
import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics;
import io.micrometer.core.instrument.binder.jvm.JvmThreadMetrics;
import io.micrometer.core.instrument.binder.jvm.convention.JvmClassLoadingMeterConventions;
import io.micrometer.core.instrument.binder.jvm.convention.JvmMemoryMeterConventions;
import io.micrometer.core.instrument.binder.jvm.convention.JvmThreadMeterConventions;
import org.jspecify.annotations.Nullable;

import org.springframework.aot.hint.MemberCategory;
import org.springframework.aot.hint.RuntimeHints;
import org.springframework.aot.hint.RuntimeHintsRegistrar;
import org.springframework.beans.BeanUtils;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
Expand Down Expand Up @@ -71,20 +76,23 @@ JvmHeapPressureMetrics jvmHeapPressureMetrics() {

@Bean
@ConditionalOnMissingBean
JvmMemoryMetrics jvmMemoryMetrics() {
return new JvmMemoryMetrics();
JvmMemoryMetrics jvmMemoryMetrics(ObjectProvider<JvmMemoryMeterConventions> jvmMemoryMeterConventions) {
JvmMemoryMeterConventions conventions = jvmMemoryMeterConventions.getIfAvailable();
return (conventions != null) ? new JvmMemoryMetrics(Tags.empty(), conventions) : new JvmMemoryMetrics();
}

@Bean
@ConditionalOnMissingBean
JvmThreadMetrics jvmThreadMetrics() {
return new JvmThreadMetrics();
JvmThreadMetrics jvmThreadMetrics(ObjectProvider<JvmThreadMeterConventions> jvmThreadMeterConventions) {
JvmThreadMeterConventions conventions = jvmThreadMeterConventions.getIfAvailable();
return (conventions != null) ? new JvmThreadMetrics(Tags.empty(), conventions) : new JvmThreadMetrics();
}

@Bean
@ConditionalOnMissingBean
ClassLoaderMetrics classLoaderMetrics() {
return new ClassLoaderMetrics();
ClassLoaderMetrics classLoaderMetrics(ObjectProvider<JvmClassLoadingMeterConventions> jvmClassLoadingMeterConventions) {
JvmClassLoadingMeterConventions conventions = jvmClassLoadingMeterConventions.getIfAvailable();
return (conventions != null) ? new ClassLoaderMetrics(conventions) : new ClassLoaderMetrics();
}

@Bean
Expand Down
7 changes: 5 additions & 2 deletions ...ramework/boot/micrometer/metrics/autoconfigure/system/SystemMetricsAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,12 @@

import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.binder.jvm.convention.JvmCpuMeterConventions;
import io.micrometer.core.instrument.binder.system.FileDescriptorMetrics;
import io.micrometer.core.instrument.binder.system.ProcessorMetrics;
import io.micrometer.core.instrument.binder.system.UptimeMetrics;

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
Expand Down Expand Up @@ -58,8 +60,9 @@ UptimeMetrics uptimeMetrics() {

@Bean
@ConditionalOnMissingBean
ProcessorMetrics processorMetrics() {
return new ProcessorMetrics();
ProcessorMetrics processorMetrics(ObjectProvider<JvmCpuMeterConventions> jvmCpuMeterConventions) {
JvmCpuMeterConventions conventions = jvmCpuMeterConventions.getIfAvailable();
return (conventions != null) ? new ProcessorMetrics(Tags.empty(), conventions) : new ProcessorMetrics();
}

@Bean
Expand Down
80 changes: 80 additions & 0 deletions ...framework/boot/micrometer/metrics/autoconfigure/jvm/JvmMetricsAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@
import io.micrometer.core.instrument.binder.jvm.JvmInfoMetrics;
import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics;
import io.micrometer.core.instrument.binder.jvm.JvmThreadMetrics;
import io.micrometer.core.instrument.binder.jvm.convention.JvmClassLoadingMeterConventions;
import io.micrometer.core.instrument.binder.jvm.convention.JvmMemoryMeterConventions;
import io.micrometer.core.instrument.binder.jvm.convention.JvmThreadMeterConventions;
import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.EnabledForJreRange;
Expand All @@ -44,6 +47,7 @@
import org.springframework.util.ClassUtils;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;

/**
* Tests for {@link JvmMetricsAutoConfiguration}.
Expand Down Expand Up @@ -82,18 +86,64 @@ void allowsCustomJvmMemoryMetricsToBeUsed() {
.run(assertMetricsBeans().andThen((context) -> assertThat(context).hasBean("customJvmMemoryMetrics")));
}

@Test
void autoConfiguresJvmMemoryMetrics() {
this.contextRunner.run((context) -> assertThat(context).hasSingleBean(JvmMemoryMetrics.class));
}

@Test
void autoConfiguresJvmMemoryMetricsWithCustomJvmMemoryMeterConventions() {
this.contextRunner.withUserConfiguration(CustomJvmMemoryMeterConventionsConfiguration.class).run((context) -> {
assertThat(context).hasSingleBean(JvmMemoryMetrics.class);
JvmMemoryMetrics jvmMemoryMetrics = context.getBean(JvmMemoryMetrics.class);
assertThat(jvmMemoryMetrics).extracting("conventions")
.isSameAs(context.getBean(JvmMemoryMeterConventions.class));
});
}

@Test
void allowsCustomJvmThreadMetricsToBeUsed() {
this.contextRunner.withUserConfiguration(CustomJvmThreadMetricsConfiguration.class)
.run(assertMetricsBeans().andThen((context) -> assertThat(context).hasBean("customJvmThreadMetrics")));
}

@Test
void autoConfiguresJvmThreadMetrics() {
this.contextRunner.run((context) -> assertThat(context).hasSingleBean(JvmThreadMetrics.class));
}

@Test
void autoConfiguresJvmThreadMetricsWithCustomCustomJvmThreadMeterConventions() {
this.contextRunner.withUserConfiguration(CustomJvmThreadMeterConventionsConfiguration.class).run((context) -> {
assertThat(context).hasSingleBean(JvmThreadMetrics.class);
JvmThreadMetrics jvmThreadMetrics = context.getBean(JvmThreadMetrics.class);
assertThat(jvmThreadMetrics).extracting("conventions")
.isSameAs(context.getBean(JvmThreadMeterConventions.class));
});
}

@Test
void allowsCustomClassLoaderMetricsToBeUsed() {
this.contextRunner.withUserConfiguration(CustomClassLoaderMetricsConfiguration.class)
.run(assertMetricsBeans().andThen((context) -> assertThat(context).hasBean("customClassLoaderMetrics")));
}

@Test
void autoConfiguresClassLoaderMetrics() {
this.contextRunner.run((context) -> assertThat(context).hasSingleBean(ClassLoaderMetrics.class));
}

@Test
void autoConfiguresClassLoaderMetricsWithCustomJvmClassLoadingMeterConventions() {
this.contextRunner.withUserConfiguration(CustomJvmClassLoadingMeterConventionsConfiguration.class)
.run((context) -> {
assertThat(context).hasSingleBean(ClassLoaderMetrics.class);
ClassLoaderMetrics classLoaderMetrics = context.getBean(ClassLoaderMetrics.class);
assertThat(classLoaderMetrics).extracting("conventions")
.isSameAs(context.getBean(JvmClassLoadingMeterConventions.class));
});
}

@Test
void allowsCustomJvmInfoMetricsToBeUsed() {
this.contextRunner.withUserConfiguration(CustomJvmInfoMetricsConfiguration.class)
Expand Down Expand Up @@ -222,4 +272,34 @@ JvmCompilationMetrics customJvmCompilationMetrics() {

}

@Configuration(proxyBeanMethods = false)
static class CustomJvmThreadMeterConventionsConfiguration {

@Bean
JvmThreadMeterConventions customJvmThreadMeterConventions() {
return mock(JvmThreadMeterConventions.class);
}

}

@Configuration(proxyBeanMethods = false)
static class CustomJvmMemoryMeterConventionsConfiguration {

@Bean
JvmMemoryMeterConventions customJvmMemoryMeterConventions() {
return mock(JvmMemoryMeterConventions.class);
}

}

@Configuration(proxyBeanMethods = false)
static class CustomJvmClassLoadingMeterConventionsConfiguration {

@Bean
JvmClassLoadingMeterConventions customJvmClassLoadingMeterConventions() {
return mock(JvmClassLoadingMeterConventions.class);
}

}

}
22 changes: 22 additions & 0 deletions ...ork/boot/micrometer/metrics/autoconfigure/system/SystemMetricsAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import java.util.Collections;

import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.binder.jvm.convention.JvmCpuMeterConventions;
import io.micrometer.core.instrument.binder.system.FileDescriptorMetrics;
import io.micrometer.core.instrument.binder.system.ProcessorMetrics;
import io.micrometer.core.instrument.binder.system.UptimeMetrics;
Expand All @@ -34,6 +35,7 @@
import org.springframework.context.annotation.Configuration;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;

/**
* Tests for {@link SystemMetricsAutoConfiguration}.
Expand Down Expand Up @@ -64,6 +66,16 @@ void autoConfiguresProcessorMetrics() {
this.contextRunner.run((context) -> assertThat(context).hasSingleBean(ProcessorMetrics.class));
}

@Test
void autoConfiguresProcessorMetricsWithCustomJvmCpuMeterConventions() {
this.contextRunner.withUserConfiguration(JvmCpuMeterConventionsConfiguration.class).run((context) -> {
assertThat(context).hasSingleBean(ProcessorMetrics.class);
ProcessorMetrics processorMetrics = context.getBean(ProcessorMetrics.class);
assertThat(processorMetrics).extracting("conventions")
.isSameAs(context.getBean(JvmCpuMeterConventions.class));
});
}

@Test
void allowsCustomProcessorMetricsToBeUsed() {
this.contextRunner.withUserConfiguration(CustomProcessorMetricsConfiguration.class)
Expand Down Expand Up @@ -138,6 +150,16 @@ ProcessorMetrics customProcessorMetrics() {

}

@Configuration(proxyBeanMethods = false)
static class JvmCpuMeterConventionsConfiguration {

@Bean
JvmCpuMeterConventions customJvmCpuMeterConventions() {
return mock(JvmCpuMeterConventions.class);
}

}

@Configuration(proxyBeanMethods = false)
static class CustomFileDescriptorMetricsConfiguration {

Expand Down