Skip to content

Add support for custom GrpcServerObservationConvention #49730

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

Merged
snicoll merged 2 commits into from
Mar 25, 2026
Merged

Add support for custom GrpcServerObservationConvention #49730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c26811
Add server-side support for custom gRPC conventions
therepanic Mar 24, 2026
3ebc865
Polish "Add server-side support for custom gRPC conventions"
snicoll Mar 25, 2026
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
12 changes: 10 additions & 2 deletions ...pringframework/boot/grpc/server/autoconfigure/GrpcServerObservationAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,18 @@
package org.springframework.boot.grpc.server.autoconfigure;

import io.grpc.BindableService;
import io.micrometer.core.instrument.binder.grpc.GrpcServerObservationConvention;
import io.micrometer.core.instrument.binder.grpc.ObservationGrpcServerInterceptor;
import io.micrometer.core.instrument.kotlin.ObservationCoroutineContextServerInterceptor;
import io.micrometer.observation.ObservationRegistry;

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;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBooleanProperty;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
Expand All @@ -38,6 +41,7 @@
* @author Sunny Tang
* @author Chris Bono
* @author Dave Syer
* @author Andrey Litvitski
* @since 1.0.0
*/
@AutoConfiguration(
Expand All @@ -52,8 +56,12 @@ public final class GrpcServerObservationAutoConfiguration {
@Bean
@Order(0)
@GlobalServerInterceptor
ObservationGrpcServerInterceptor grpcServerObservationInterceptor(ObservationRegistry observationRegistry) {
return new ObservationGrpcServerInterceptor(observationRegistry);
@ConditionalOnMissingBean
ObservationGrpcServerInterceptor grpcServerObservationInterceptor(ObservationRegistry observationRegistry,
ObjectProvider<GrpcServerObservationConvention> convention) {
ObservationGrpcServerInterceptor interceptor = new ObservationGrpcServerInterceptor(observationRegistry);
convention.ifAvailable(interceptor::setCustomConvention);
return interceptor;
}

@Configuration(proxyBeanMethods = false)
Expand Down
10 changes: 10 additions & 0 deletions ...framework/boot/grpc/server/autoconfigure/GrpcServerObservationAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import io.grpc.BindableService;
import io.grpc.ServerInterceptor;
import io.micrometer.context.ContextRegistry;
import io.micrometer.core.instrument.binder.grpc.GrpcServerObservationConvention;
import io.micrometer.core.instrument.binder.grpc.ObservationGrpcServerInterceptor;
import io.micrometer.core.instrument.kotlin.ObservationCoroutineContextServerInterceptor;
import io.micrometer.observation.ObservationRegistry;
Expand All @@ -35,6 +36,7 @@
import org.springframework.grpc.server.GrpcServerFactory;

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

/**
* Tests for the {@link GrpcServerObservationAutoConfiguration}.
Expand Down Expand Up @@ -123,6 +125,14 @@ void whenAllConditionsAreMetThenInterceptorConfiguredAsExpected() {
});
}

@Test
void whenCustomConventionBeanIsPresentThenInterceptorUsesIt() {
GrpcServerObservationConvention customConvention = mock(GrpcServerObservationConvention.class);
this.contextRunner.withBean(GrpcServerObservationConvention.class, () -> customConvention)
.run((context) -> assertThat(context.getBean(ObservationGrpcServerInterceptor.class))
.hasFieldOrPropertyWithValue("customConvention", customConvention));
}

@Test
void whenMicrometerContextPropagationIsNotOnClasspathCoroutineInterceptorIsNotCreated() {
this.contextRunner.withClassLoader(new FilteredClassLoader(ContextRegistry.class))
Expand Down
Loading