Add Micrometer Observation support to Spring Dapr Messaging

Signed-off-by: Artur Ciocanu <[email protected]>

Author: Artur Ciocanu

dapr-spring/dapr-spring-boot-autoconfigure/pom.xml

@@ -28,8 +28,8 @@
       <optional>true</optional>
     </dependency>
     <dependency>
-        <groupId>org.springframework.boot</groupId>
-        <artifactId>spring-boot-starter</artifactId>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter</artifactId>
     </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
@@ -41,6 +41,10 @@
       <artifactId>spring-data-keyvalue</artifactId>
       <optional>true</optional>
     </dependency>
+    <dependency>
+      <groupId>io.micrometer</groupId>
+      <artifactId>micrometer-tracing-bridge-otel</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>

dapr-spring/dapr-spring-boot-autoconfigure/src/main/java/io/dapr/spring/boot/autoconfigure/pubsub/DaprPubSubProperties.java

@@ -25,6 +25,7 @@ public class DaprPubSubProperties {
    * Name of the PubSub Dapr component.
    */
   private String name;
+  private boolean observationEnabled;
 
   public String getName() {
     return name;
@@ -34,4 +35,11 @@ public void setName(String name) {
     this.name = name;
   }
 
+  public boolean isObservationEnabled() {
+    return observationEnabled;
+  }
+
+  public void setObservationEnabled(boolean observationEnabled) {
+    this.observationEnabled = observationEnabled;
+  }
 }

dapr-spring/dapr-spring-messaging/pom.xml

@@ -12,6 +12,13 @@
   <artifactId>dapr-spring-messaging</artifactId>
   <name>dapr-spring-messaging</name>
   <description>Dapr Spring Messaging</description>
-    <packaging>jar</packaging>
+  <packaging>jar</packaging>
+
+  <dependencies>
+    <dependency>
+      <groupId>io.micrometer</groupId>
+      <artifactId>micrometer-tracing</artifactId>
+    </dependency>
+  </dependencies>
 
 </project>

dapr-spring/dapr-spring-messaging/src/main/java/io/dapr/spring/messaging/DaprMessagingTemplate.java

@@ -15,20 +15,96 @@
 
 import io.dapr.client.DaprClient;
 import io.dapr.client.domain.Metadata;
+import io.dapr.spring.messaging.observation.DaprMessagingObservationConvention;
+import io.dapr.spring.messaging.observation.DaprMessagingObservationDocumentation;
+import io.dapr.spring.messaging.observation.DaprMessagingSenderContext;
+import io.dapr.spring.messaging.observation.DefaultDaprMessagingObservationConvention;
+import io.micrometer.observation.Observation;
+import io.micrometer.observation.ObservationRegistry;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.BeanNameAware;
+import org.springframework.beans.factory.SmartInitializingSingleton;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
 import reactor.core.publisher.Mono;
 
+import javax.annotation.Nullable;
+
 import java.util.Map;
 
-public class DaprMessagingTemplate<T> implements DaprMessagingOperations<T> {
+/**
+ * Create a new DaprMessagingTemplate.
+ * @param <T> templated message type
+ */
+public class DaprMessagingTemplate<T> implements DaprMessagingOperations<T>, ApplicationContextAware, BeanNameAware,
+    SmartInitializingSingleton {
 
+  private static final Logger LOGGER = LoggerFactory.getLogger(DaprMessagingTemplate.class);
   private static final String MESSAGE_TTL_IN_SECONDS = "10";
+  private static final DaprMessagingObservationConvention DEFAULT_OBSERVATION_CONVENTION =
+      DefaultDaprMessagingObservationConvention.INSTANCE;
 
   private final DaprClient daprClient;
   private final String pubsubName;
+  private final Map<String, String> metadata;
+  private final boolean observationEnabled;
+
+  @Nullable
+  private ApplicationContext applicationContext;
+
+  @Nullable
+  private String beanName;
+
+  @Nullable
+  private ObservationRegistry observationRegistry;
 
-  public DaprMessagingTemplate(DaprClient daprClient, String pubsubName) {
+  @Nullable
+  private DaprMessagingObservationConvention observationConvention;
+
+  /**
+   * Constructs a new DaprMessagingTemplate.
+   * @param daprClient Dapr client
+   * @param pubsubName pubsub name
+   * @param observationEnabled whether to enable observations
+   */
+  public DaprMessagingTemplate(DaprClient daprClient, String pubsubName, boolean observationEnabled) {
     this.daprClient = daprClient;
     this.pubsubName = pubsubName;
+    this.metadata = Map.of(Metadata.TTL_IN_SECONDS, MESSAGE_TTL_IN_SECONDS);
+    this.observationEnabled = observationEnabled;
+  }
+
+  @Override
+  public void setApplicationContext(ApplicationContext applicationContext) {
+    this.applicationContext = applicationContext;
+  }
+
+  @Override
+  public void setBeanName(String beanName) {
+    this.beanName = beanName;
+  }
+
+  /**
+   * If observations are enabled, attempt to obtain the Observation registry and
+   * convention.
+   */
+  @Override
+  public void afterSingletonsInstantiated() {
+    if (!observationEnabled) {
+      LOGGER.debug("Observations are not enabled - not recording");
+      return;
+    }
+
+    if (applicationContext == null) {
+      LOGGER.warn("Observations enabled but application context null - not recording");
+      return;
+    }
+
+    observationRegistry = applicationContext.getBeanProvider(ObservationRegistry.class)
+        .getIfUnique(() -> observationRegistry);
+    observationConvention = applicationContext.getBeanProvider(DaprMessagingObservationConvention.class)
+        .getIfUnique(() -> observationConvention);
   }
 
   @Override
@@ -38,29 +114,72 @@ public void send(String topic, T message) {
 
   @Override
   public SendMessageBuilder<T> newMessage(T message) {
-    return new SendMessageBuilderImpl<>(this, message);
+    return new DeefaultSendMessageBuilder<>(this, message);
   }
 
   private void doSend(String topic, T message) {
     doSendAsync(topic, message).block();
   }
 
   private Mono<Void> doSendAsync(String topic, T message) {
-    return daprClient.publishEvent(pubsubName,
-        topic,
-        message,
-        Map.of(Metadata.TTL_IN_SECONDS, MESSAGE_TTL_IN_SECONDS));
+    LOGGER.trace("Sending message to '{}' topic", topic);
+
+    if (canUseObservation()) {
+      return publishEventWithObservation(pubsubName, topic, message);
+    }
+
+    return publishEvent(pubsubName, topic, message);
+  }
+
+  private boolean canUseObservation() {
+    return observationEnabled
+        && observationRegistry != null
+        && observationConvention != null
+        && beanName != null;
+  }
+
+  private Mono<Void> publishEvent(String pubsubName, String topic, T message) {
+    return daprClient.publishEvent(pubsubName, topic, message, metadata);
+  }
+
+  private Mono<Void> publishEventWithObservation(String pubsubName, String topic, T message) {
+    DaprMessagingSenderContext senderContext = DaprMessagingSenderContext.newContext(topic, this.beanName);
+    Observation observation = createObservation(senderContext);
+
+    return observation.observe(() ->
+      publishEvent(pubsubName, topic, message)
+        .doOnError(err -> {
+          LOGGER.error("Failed to send msg to '{}' topic", topic, err);
+
+          observation.error(err);
+          observation.stop();
+        })
+        .doOnSuccess(ignore -> {
+          LOGGER.trace("Sent msg to '{}' topic", topic);
+
+          observation.stop();
+        })
+    );
+  }
+
+  private Observation createObservation(DaprMessagingSenderContext senderContext) {
+    return DaprMessagingObservationDocumentation.TEMPLATE_OBSERVATION.observation(
+        observationConvention,
+        DEFAULT_OBSERVATION_CONVENTION,
+        () -> senderContext,
+        observationRegistry
+    );
   }
 
-  private static class SendMessageBuilderImpl<T> implements SendMessageBuilder<T> {
+  private static class DeefaultSendMessageBuilder<T> implements SendMessageBuilder<T> {
 
     private final DaprMessagingTemplate<T> template;
 
     private final T message;
 
     private String topic;
 
-    SendMessageBuilderImpl(DaprMessagingTemplate<T> template, T message) {
+    DeefaultSendMessageBuilder(DaprMessagingTemplate<T> template, T message) {
       this.template = template;
       this.message = message;
     }
@@ -74,12 +193,12 @@ public SendMessageBuilder<T> withTopic(String topic) {
 
     @Override
     public void send() {
-      this.template.doSend(this.topic, this.message);
+      template.doSend(topic, message);
     }
 
     @Override
     public Mono<Void> sendAsync() {
-      return this.template.doSendAsync(this.topic, this.message);
+      return template.doSendAsync(topic, message);
     }
 
   }

dapr-spring/dapr-spring-messaging/src/main/java/io/dapr/spring/messaging/observation/DaprMessagingObservationConvention.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2024 The Dapr Authors
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package io.dapr.spring.messaging.observation;
+
+import io.micrometer.observation.Observation.Context;
+import io.micrometer.observation.ObservationConvention;
+
+/**
+ * {@link ObservationConvention} for Dapr Messaging.
+ *
+ */
+public interface DaprMessagingObservationConvention extends ObservationConvention<DaprMessagingSenderContext> {
+
+  @Override
+  default boolean supportsContext(Context context) {
+    return context instanceof DaprMessagingSenderContext;
+  }
+
+  @Override
+  default String getName() {
+    return "spring.dapr.messaging.template";
+  }
+
+}

dapr-spring/dapr-spring-messaging/src/main/java/io/dapr/spring/messaging/observation/DaprMessagingObservationDocumentation.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2024 The Dapr Authors
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package io.dapr.spring.messaging.observation;
+
+import io.micrometer.common.docs.KeyName;
+import io.micrometer.observation.Observation;
+import io.micrometer.observation.Observation.Context;
+import io.micrometer.observation.ObservationConvention;
+import io.micrometer.observation.docs.ObservationDocumentation;
+
+/**
+ * An {@link Observation} for {@link io.dapr.spring.messaging.DaprMessagingTemplate}.
+ *
+ */
+public enum DaprMessagingObservationDocumentation implements ObservationDocumentation {
+
+  /**
+   * Observation created when a Dapr template sends a message.
+   */
+  TEMPLATE_OBSERVATION {
+
+    @Override
+    public Class<? extends ObservationConvention<? extends Context>> getDefaultConvention() {
+      return DefaultDaprMessagingObservationConvention.class;
+    }
+
+    @Override
+    public String getPrefix() {
+      return "spring.dapr.messaging.template";
+    }
+
+    @Override
+    public KeyName[] getLowCardinalityKeyNames() {
+      return TemplateLowCardinalityTags.values();
+    }
+  };
+
+  /**
+   * Low cardinality tags.
+   */
+  public enum TemplateLowCardinalityTags implements KeyName {
+    /**
+     * Bean name of the template that sent the message.
+     */
+    BEAN_NAME {
+
+      @Override
+      public String asString() {
+        return "spring.dapr.messaging.template.name";
+      }
+    }
+  }
+}