Skip to content

Add support for @ObservationKeyValue #47637

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
+42 −10
Closed

Add support for @ObservationKeyValue #47637

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
16 changes: 14 additions & 2 deletions ...ringframework/boot/micrometer/observation/autoconfigure/ObservationAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@
import io.micrometer.observation.ObservationHandler;
import io.micrometer.observation.ObservationPredicate;
import io.micrometer.observation.ObservationRegistry;
import io.micrometer.observation.aop.ObservationKeyValueAnnotationHandler;
import io.micrometer.observation.aop.ObservedAspect;
import org.aspectj.weaver.Advice;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
Expand Down Expand Up @@ -87,8 +89,18 @@ static class ObservedAspectConfiguration {

@Bean
@ConditionalOnMissingBean
ObservedAspect observedAspect(ObservationRegistry observationRegistry) {
return new ObservedAspect(observationRegistry);
ObservedAspect observedAspect(ObservationRegistry observationRegistry,
ObjectProvider<ObservationKeyValueAnnotationHandler> observationKeyValueAnnotationHandler) {
ObservedAspect observedAspect = new ObservedAspect(observationRegistry);
observationKeyValueAnnotationHandler.ifAvailable(observedAspect::setObservationKeyValueAnnotationHandler);
return observedAspect;
}

@Bean
@ConditionalOnMissingBean
ObservationKeyValueAnnotationHandler observationKeyValueAnnotationHandler(BeanFactory beanFactory,
ValueExpressionResolver valueExpressionResolver) {
return new ObservationKeyValueAnnotationHandler(beanFactory::getBean, (ignored) -> valueExpressionResolver);
}

}
Expand Down
36 changes: 28 additions & 8 deletions ...ramework/boot/micrometer/observation/autoconfigure/ObservationAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@
import io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler;
import io.micrometer.observation.ObservationPredicate;
import io.micrometer.observation.ObservationRegistry;
import io.micrometer.observation.aop.ObservationKeyValueAnnotationHandler;
import io.micrometer.observation.aop.ObservedAspect;
import org.aspectj.weaver.Advice;
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.FilteredClassLoader;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
Expand Down Expand Up @@ -61,36 +63,48 @@ void beansShouldNotBeSuppliedWhenMicrometerObservationIsNotOnClassPath() {
this.contextRunner.withClassLoader(new FilteredClassLoader("io.micrometer.observation")).run((context) -> {
assertThat(context).doesNotHaveBean(ObservationRegistry.class);
assertThat(context).doesNotHaveBean(ObservedAspect.class);
assertThat(context).doesNotHaveBean(ObservationKeyValueAnnotationHandler.class);
});
}

@Test
void supplyObservationRegistry() {
void supplyObservationRegistryAndAspect() {
this.contextRunner.run((context) -> {
ObservationRegistry observationRegistry = context.getBean(ObservationRegistry.class);
Observation.start("test-observation", observationRegistry).stop();
assertThat(context).hasSingleBean(ObservedAspect.class);
assertThat(context).hasSingleBean(ObservationKeyValueAnnotationHandler.class);
assertThat(context.getBean(ObservedAspect.class)).extracting("observationKeyValueAnnotationHandler")
.isSameAs(context.getBean(ObservationKeyValueAnnotationHandler.class));
});
}

@Test
void allowsObservedAspectToBeDisabled() {
this.contextRunner.withClassLoader(new FilteredClassLoader(Advice.class))
.run((context) -> assertThat(context).doesNotHaveBean(ObservedAspect.class));
this.contextRunner.withClassLoader(new FilteredClassLoader(Advice.class)).run((context) -> {
assertThat(context).doesNotHaveBean(ObservedAspect.class);
assertThat(context).doesNotHaveBean(ObservationKeyValueAnnotationHandler.class);
});
}

@Test
void allowsObservedAspectToBeDisabledWithProperty() {
this.contextRunner.withPropertyValues("management.observations.annotations.enabled=false")
.run((context) -> assertThat(context).doesNotHaveBean(ObservedAspect.class));
this.contextRunner.withPropertyValues("management.observations.annotations.enabled=false").run((context) -> {
assertThat(context).doesNotHaveBean(ObservedAspect.class);
assertThat(context).doesNotHaveBean(ObservationKeyValueAnnotationHandler.class);
});
}

@Test
void allowsObservedAspectToBeCustomized() {
this.contextRunner.withUserConfiguration(CustomObservedAspectConfiguration.class)
.run((context) -> assertThat(context).hasSingleBean(ObservedAspect.class)
this.contextRunner.withUserConfiguration(CustomObservedAspectConfiguration.class).run((context) -> {
assertThat(context).hasSingleBean(ObservedAspect.class)
.getBean(ObservedAspect.class)
.isSameAs(context.getBean("customObservedAspect")));
.isSameAs(context.getBean("customObservedAspect"));
assertThat(context).hasSingleBean(ObservationKeyValueAnnotationHandler.class)
.getBean(ObservationKeyValueAnnotationHandler.class)
.isSameAs(context.getBean("customObservationKeyValueAnnotationHandler"));
});
}

@Test
Expand Down Expand Up @@ -216,6 +230,12 @@ ObservedAspect customObservedAspect(ObservationRegistry observationRegistry) {
return new ObservedAspect(observationRegistry);
}

@Bean
ObservationKeyValueAnnotationHandler customObservationKeyValueAnnotationHandler(BeanFactory beanFactory,
ValueExpressionResolver valueExpressionResolver) {
return new ObservationKeyValueAnnotationHandler(beanFactory::getBean, (ignored) -> valueExpressionResolver);
}

}

@Configuration(proxyBeanMethods = false)
Expand Down