Added waggledance metrics with tags for enabling filtering in datadog

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [3.11.4] - 2023-08-15
+### Changed
+- Metrics have been incorporated into Waggle Dance with the inclusion of tags, which will facilitate filtering within Datadog.
+
 ## [3.11.3] - TBD
 ### Fixed
 - Exclude Junit5 dependencies as they clashed with Junit4 and caused maven to stop running the tests.

pom.xml

@@ -1,5 +1,4 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
@@ -10,7 +9,7 @@
 
   <groupId>com.hotels</groupId>
   <artifactId>waggle-dance-parent</artifactId>
-  <version>3.11.3-SNAPSHOT</version>
+  <version>3.11.4-SNAPSHOT</version>
   <packaging>pom</packaging>
   <name>Waggle Dance Parent</name>
   <description>Hive Metastore federation service.</description>

waggle-dance-api/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.hotels</groupId>
     <artifactId>waggle-dance-parent</artifactId>
-    <version>3.11.3-SNAPSHOT</version>
+    <version>3.11.4-SNAPSHOT</version>
   </parent>
 
   <artifactId>waggle-dance-api</artifactId>

waggle-dance-boot/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.hotels</groupId>
     <artifactId>waggle-dance-parent</artifactId>
-    <version>3.11.3-SNAPSHOT</version>
+    <version>3.11.4-SNAPSHOT</version>
   </parent>
 
   <artifactId>waggle-dance-boot</artifactId>

waggle-dance-core/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.hotels</groupId>
     <artifactId>waggle-dance-parent</artifactId>
-    <version>3.11.3-SNAPSHOT</version>
+    <version>3.11.4-SNAPSHOT</version>
   </parent>
 
   <artifactId>waggle-dance-core</artifactId>

waggle-dance-core/src/main/java/com/hotels/bdp/waggledance/metrics/MonitoredAspect.java

@@ -27,6 +27,8 @@
 import org.springframework.beans.factory.annotation.Configurable;
 
 import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Tag;
+import io.micrometer.core.instrument.Tags;
 
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Joiner;
@@ -51,6 +53,8 @@ public Object monitor(ProceedingJoinPoint pjp) throws Throwable {
   public Object monitor(ProceedingJoinPoint pjp, Monitored monitored) throws Throwable {
 
     String metricBasePath = buildMetricBasePath(pjp);
+    String newMetricBasePath = buildMetricWithTagsBasePath(pjp);
+    String methodName = getMethodName(pjp);
 
     String result = null;
     Stopwatch stopwatch = Stopwatch.createStarted();
@@ -67,6 +71,12 @@ public Object monitor(ProceedingJoinPoint pjp, Monitored monitored) throws Throw
       increment(buildMetricPath(COUNTER, metricBasePath, getMonitorMetastore(), result));
       submit(buildMetricPath(TIMER, metricBasePath, getMonitorMetastore(), "duration"),
           stopwatch.elapsed(TimeUnit.MILLISECONDS));
+
+      // Sends metrics with Tags: federation_namespace and method_name
+      incrementWithTags(buildMetricPath(COUNTER, newMetricBasePath, "calls"), methodName);
+      incrementWithTags(buildMetricPath(COUNTER, newMetricBasePath, result), methodName);
+      submitWithTags(buildMetricPath(TIMER, newMetricBasePath, "duration"),
+          stopwatch.elapsed(TimeUnit.MILLISECONDS), methodName);
     }
   }
 
@@ -75,21 +85,56 @@ void setMeterRegistry(MeterRegistry meterRegistry) {
     this.meterRegistry = meterRegistry;
   }
 
+  private void incrementWithTags(String metricName, String methodName) {
+    if (meterRegistry != null) {
+      Iterable<Tag> tags = getMetricsTags(methodName);
+      meterRegistry.counter(metricName, tags).increment();
+    }
+  }
+
   private void increment(String metricName) {
     if (meterRegistry != null) {
       meterRegistry.counter(metricName).increment();
     }
   }
 
+  private void submitWithTags(String metricName, long value, String methodName) {
+    if (meterRegistry != null) {
+      Iterable<Tag> tags = getMetricsTags(methodName);
+      meterRegistry.timer(metricName, tags).record(Duration.ofMillis(value));
+    }
+  }
+
   private void submit(String metricName, long value) {
     if (meterRegistry != null) {
       meterRegistry.timer(metricName).record(Duration.ofMillis(value));
     }
   }
 
-  private String buildMetricBasePath(ProceedingJoinPoint pjp) {
-    String className = clean(pjp.getSignature().getDeclaringTypeName());
+  private Tags getMetricsTags(String methodName) {
+    Tag federationTag = Tag.of("federation_namespace", getMonitorMetastore());
+    Tag methodTag = Tag.of("method_name", methodName);
+    return Tags.of(federationTag).and(methodTag);
+  }
+
+  private String getMethodName(ProceedingJoinPoint pjp) {
     String methodName = clean(pjp.getSignature().getName());
+    return new StringBuilder(methodName).toString();
+  }
+
+  private String getClassName(ProceedingJoinPoint pjp) {
+    String className = clean(pjp.getSignature().getDeclaringTypeName());
+    return new StringBuilder(className).toString();
+  }
+
+  private String buildMetricWithTagsBasePath(ProceedingJoinPoint pjp) {
+    String className = getClassName(pjp);
+    return new StringBuilder(className).toString();
+  }
+
+  private String buildMetricBasePath(ProceedingJoinPoint pjp) {
+    String className = getClassName(pjp);
+    String methodName = getMethodName(pjp);
     return new StringBuilder(className).append(".").append(methodName).toString();
   }
 
@@ -101,5 +146,4 @@ private String clean(String string) {
   private String buildMetricPath(String... parts) {
     return DOT_JOINER.join(parts);
   }
-
 }

waggle-dance-core/src/test/java/com/hotels/bdp/waggledance/metrics/MonitoredAspectTest.java

@@ -1,5 +1,5 @@
 /**
- * Copyright (C) 2016-2020 Expedia, Inc.
+ * Copyright (C) 2016-2023 Expedia, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,6 +20,9 @@
 import static org.mockito.Mockito.reset;
 import static org.mockito.Mockito.when;
 
+import java.util.ArrayList;
+import java.util.Collection;
+
 import org.aspectj.lang.ProceedingJoinPoint;
 import org.aspectj.lang.Signature;
 import org.junit.Before;
@@ -28,7 +31,10 @@
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
 
+import io.micrometer.core.instrument.Meter;
 import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.cumulative.CumulativeCounter;
+import io.micrometer.core.instrument.cumulative.CumulativeTimer;
 import io.micrometer.core.instrument.search.RequiredSearch;
 import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
 
@@ -109,6 +115,23 @@ public void monitorSuccesses() throws Throwable {
     assertThat(rs.timer().count(), is(1L));
   }
 
+  @Test
+  public void monitorSuccessWithTags() throws Throwable {
+    aspect.monitor(pjp, monitored);
+
+    Collection<Meter> meters = meterRegistry.get("counter.Type_Anonymous.success").meters();
+    assertThat(meters.size(), is(1));
+    assertThat(((CumulativeCounter) ((ArrayList) meters).get(0)).count(), is(1.0));
+
+    meters = meterRegistry.get("counter.Type_Anonymous.calls").meters();
+    assertThat(meters.size(), is(1));
+    assertThat(((CumulativeCounter) ((ArrayList) meters).get(0)).count(), is(1.0));
+
+    meters = meterRegistry.get("timer.Type_Anonymous.duration").meters();
+    assertThat(meters.size(), is(1));
+    assertThat(((CumulativeTimer) ((ArrayList) meters).get(0)).count(), is(1L));
+  }
+
   @Test
   public void monitorFailuresForSpecificMetastore() throws Throwable {
     CurrentMonitoredMetaStoreHolder.monitorMetastore("metastoreName");

waggle-dance-integration-tests/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.hotels</groupId>
     <artifactId>waggle-dance-parent</artifactId>
-    <version>3.11.3-SNAPSHOT</version>
+    <version>3.11.4-SNAPSHOT</version>
   </parent>
 
   <artifactId>waggle-dance-integration-tests</artifactId>

waggle-dance-rest/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.hotels</groupId>
     <artifactId>waggle-dance-parent</artifactId>
-    <version>3.11.3-SNAPSHOT</version>
+    <version>3.11.4-SNAPSHOT</version>
   </parent>
 
   <artifactId>waggle-dance-rest</artifactId>

waggle-dance-rpm/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.hotels</groupId>
     <artifactId>waggle-dance-parent</artifactId>
-    <version>3.11.3-SNAPSHOT</version>
+    <version>3.11.4-SNAPSHOT</version>
   </parent>
 
   <artifactId>waggle-dance-rpm</artifactId>

waggle-dance/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>com.hotels</groupId>
     <artifactId>waggle-dance-parent</artifactId>
-    <version>3.11.3-SNAPSHOT</version>
+    <version>3.11.4-SNAPSHOT</version>
   </parent>
 
   <artifactId>waggle-dance</artifactId>