* Add custom observation convention support for the AbstractMessageHandler

* Use more meaningful prefix for Spring Integration tags

Author: artembilan

spring-integration-core/src/main/java/org/springframework/integration/handler/AbstractMessageHandler.java

@@ -21,8 +21,12 @@
 import org.springframework.integration.history.MessageHistory;
 import org.springframework.integration.support.management.metrics.MetricsCaptor;
 import org.springframework.integration.support.management.metrics.SampleFacade;
-import org.springframework.integration.support.management.observation.IntegrationObservations;
+import org.springframework.integration.support.management.observation.DefaultMessageReceiverObservationConvention;
+import org.springframework.integration.support.management.observation.IntegrationObservation;
+import org.springframework.integration.support.management.observation.MessageReceiverContext;
+import org.springframework.integration.support.management.observation.MessageReceiverObservationConvention;
 import org.springframework.integration.support.utils.IntegrationUtils;
+import org.springframework.lang.Nullable;
 import org.springframework.messaging.Message;
 import org.springframework.messaging.MessageHandler;
 import org.springframework.util.Assert;
@@ -39,6 +43,22 @@
 public abstract class AbstractMessageHandler extends MessageHandlerSupport
 		implements MessageHandler, CoreSubscriber<Message<?>> {
 
+	private static final DefaultMessageReceiverObservationConvention DEFAULT_MESSAGE_RECEIVER_OBSERVATION_CONVENTION =
+			new DefaultMessageReceiverObservationConvention();
+
+	@Nullable
+	private MessageReceiverObservationConvention observationConvention;
+
+	/**
+	 * Set a custom {@link MessageReceiverObservationConvention} for {@link IntegrationObservation#HANDLER}.
+	 * Ignored if an {@link ObservationRegistry} is not configured for this component.
+	 * @param observationConvention the {@link MessageReceiverObservationConvention} to use.
+	 * @since 6.0
+	 */
+	public void setObservationConvention(@Nullable MessageReceiverObservationConvention observationConvention) {
+		this.observationConvention = observationConvention;
+	}
+
 	@Override // NOSONAR
 	public void handleMessage(Message<?> message) {
 		Assert.notNull(message, "Message must not be null");
@@ -61,7 +81,10 @@ public void handleMessage(Message<?> message) {
 	}
 
 	private void handleWithObservation(Message<?> message, ObservationRegistry observationRegistry) {
-		IntegrationObservations.handlerObservation(observationRegistry, message, getComponentName())
+		IntegrationObservation.HANDLER.observation(this.observationConvention,
+						DEFAULT_MESSAGE_RECEIVER_OBSERVATION_CONVENTION,
+						new MessageReceiverContext(message, getComponentName()),
+						observationRegistry)
 				.observe(() -> doHandleMessage(message));
 	}
 

spring-integration-core/src/main/java/org/springframework/integration/support/management/observation/DefaultMessageReceiverObservationConvention.java

@@ -26,7 +26,7 @@
  *
  * @since 6.0
  */
-class DefaultMessageReceiverObservationConvention implements MessageReceiverObservationConvention {
+public class DefaultMessageReceiverObservationConvention implements MessageReceiverObservationConvention {
 
 	@Override
 	public KeyValues getLowCardinalityKeyValues(MessageReceiverContext context) {

spring-integration-core/src/main/java/org/springframework/integration/support/management/observation/IntegrationObservation.java

@@ -37,6 +37,11 @@ public String getName() {
 			return "spring.integration.handler";
 		}
 
+		@Override
+		public String getPrefix() {
+			return "spring.integration.";
+		}
+
 		@Override
 		public Class<DefaultMessageReceiverObservationConvention> getDefaultConvention() {
 			return DefaultMessageReceiverObservationConvention.class;
@@ -60,7 +65,7 @@ enum HandlerTags implements KeyName {
 		COMPONENT_NAME {
 			@Override
 			public String asString() {
-				return "name";
+				return "spring.integration.name";
 			}
 
 		},
@@ -71,7 +76,7 @@ public String asString() {
 		COMPONENT_TYPE {
 			@Override
 			public String asString() {
-				return "type";
+				return "spring.integration.type";
 			}
 
 		}

spring-integration-core/src/main/java/org/springframework/integration/support/management/observation/IntegrationObservations.java

@@ -242,13 +242,13 @@ void observationContextPropagatedOverExecutorChannel() {
 						.assertThatASpanWithNameEqualTo("testBridge receive")
 						.hasTag("foo", "some foo value")
 						.hasTag("bar", "some bar value")
-						.hasTag("type", "handler")
-						.hasTag("name", "testBridge")
+						.hasTag("spring.integration.type", "handler")
+						.hasTag("spring.integration.name", "testBridge")
 						.hasKindEqualTo(Span.Kind.CONSUMER));
 
 		assertThat(this.meterRegistry.get("spring.integration.handler")
-				.tag("name", "testBridge")
-				.tag("type", "handler")
+				.tag("spring.integration.name", "testBridge")
+				.tag("spring.integration.type", "handler")
 				.tag("error", "none")
 				.timer().count()).isEqualTo(1);
 	}