tests

Author: simon622

hivemq-edge/src/main/java/com/hivemq/bridge/metrics/PerBridgeMetrics.java

@@ -40,6 +40,7 @@ public class PerBridgeMetrics {
     private final @NotNull Counter loopPreventionForwardDropCounter;
     private final @NotNull Counter loopPreventionRemoteDropCounter;
     private final @NotNull Set<String> metricNames = new HashSet<>();
+    private final @NotNull Object mutex = new Object();
 
     public PerBridgeMetrics(final @NotNull String bridgeName, final @NotNull MetricRegistry metricRegistry) {
 
@@ -96,7 +97,9 @@ public PerBridgeMetrics(final @NotNull String bridgeName, final @NotNull MetricR
 
     private Counter createBridgeCounter(final @NotNull MetricRegistry metricRegistry, @NotNull final String... names){
         final String metricName = MetricRegistry.name(BRIDGE_PREFIX, names);
-        metricNames.add(metricName);
+        synchronized (mutex){
+            metricNames.add(metricName);
+        }
         return metricRegistry.counter(metricName);
     }
 
@@ -142,7 +145,9 @@ private Counter createBridgeCounter(final @NotNull MetricRegistry metricRegistry
 
     public void clearAll(final @NotNull MetricRegistry metricRegistry){
         Preconditions.checkNotNull(metricRegistry);
-        metricNames.forEach(metricRegistry::remove);
-        metricNames.clear();
+        synchronized (mutex){
+            metricNames.forEach(metricRegistry::remove);
+            metricNames.clear();
+        }
     }
 }

hivemq-edge/src/main/java/com/hivemq/edge/modules/adapters/metrics/ProtocolAdapterMetricsHelper.java

@@ -39,6 +39,7 @@ public class ProtocolAdapterMetricsHelper {
     private @NotNull String protocolAdapterId;
     private @NotNull MetricRegistry metricRegistry;
     private final @NotNull Set<String> metricNames = new HashSet<>();
+    private final Object mutex = new Object();
     static final String SUCCESS_COUNT = "success.count";
     static final String FAILED_COUNT = "failed.count";
     static final String PERIOD = ".";
@@ -61,10 +62,10 @@ public ProtocolAdapterMetricsHelper(final @NotNull String protocolAdapterType,
     }
 
     protected void initRegistry(){
-        publishSuccessCounter = metricRegistry.counter(createAdapterMetricsNamespace("read.publish", true) + SUCCESS_COUNT);
-        publishFailedCounter = metricRegistry.counter(createAdapterMetricsNamespace("read.publish", true) + FAILED_COUNT);
-        connectionSuccessCounter = metricRegistry.counter(createAdapterMetricsNamespace("connection", true) + SUCCESS_COUNT);
-        connectionFailedCounter = metricRegistry.counter(createAdapterMetricsNamespace("connection", true) + FAILED_COUNT);
+        publishSuccessCounter = metricRegistry.counter(createAdapterMetricsNamespace("read.publish" + SUCCESS_COUNT));
+        publishFailedCounter = metricRegistry.counter(createAdapterMetricsNamespace("read.publish" + FAILED_COUNT) );
+        connectionSuccessCounter = metricRegistry.counter(createAdapterMetricsNamespace("connection" + SUCCESS_COUNT));
+        connectionFailedCounter = metricRegistry.counter(createAdapterMetricsNamespace("connection" + FAILED_COUNT));
     }
 
     /**
@@ -102,14 +103,19 @@ public void incrementConnectionSuccess(){
      */
     public void increment(final @NotNull String metricName){
         Preconditions.checkNotNull(metricName);
-        metricRegistry.counter(createAdapterMetricsNamespace(metricName, false)).inc();
+        metricRegistry.counter(createAdapterMetricsNamespace(metricName)).inc();
     }
 
+    /**
+     * Will clear down all metrics in the registry created by this metrics helper.
+     * NB: metrics created outside the context of this helper will not be touched.
+     */
     public void clearAll(){
         Preconditions.checkNotNull(metricRegistry);
-        LoggerFactory.getLogger(ProtocolAdapterMetricsHelper.class).info("Clearing all protocol adapter metrics");
-        metricNames.forEach(metricRegistry::remove);
-        metricNames.clear();
+        synchronized (mutex){
+            metricNames.forEach(metricRegistry::remove);
+            metricNames.clear();
+        }
     }
 
     /**
@@ -118,22 +124,20 @@ public void clearAll(){
      * Example format of the namespace:
      * com.hivemq.edge.protocol-adapters.[test-type].[test-id].[suffix](.) with optional trailing period
      * @param suffix - the suffix to append to the namespace
-     * @param trailingPeriod - should the namespace by suffixed with a trailing period
      * @return a namespace string for use in the metrics registry
      */
-    protected String createAdapterMetricsNamespace(@NotNull final String suffix, final boolean trailingPeriod){
+    protected String createAdapterMetricsNamespace(@NotNull final String suffix){
         StringBuilder stringBuilder = new StringBuilder();
         stringBuilder.append(HiveMQMetrics.PROTOCOL_ADAPTER_PREFIX);
         stringBuilder.append(protocolAdapterType);
         stringBuilder.append(PERIOD);
         stringBuilder.append(protocolAdapterId);
         stringBuilder.append(PERIOD);
         stringBuilder.append(suffix);
-        if(trailingPeriod){
-            stringBuilder.append(PERIOD);
-        }
         String metricName = stringBuilder.toString();
-        metricNames.add(metricName);
+        synchronized (mutex){
+            metricNames.add(metricName);
+        }
         return metricName;
     }
 }

hivemq-edge/src/test/java/com/hivemq/adapter/ProtocolMetricsHelperTest.java

@@ -26,6 +26,8 @@
  */
 public class ProtocolMetricsHelperTest {
 
+    static final String ARBITRARY_METRIC = "arbitrary-metric";
+
     @Test
     void testMetricsAdapterWrapperUpdatesRegistry() {
 
@@ -38,8 +40,29 @@ void testMetricsAdapterWrapperUpdatesRegistry() {
         assertEquals(1, registry.getCounters().get("com.hivemq.edge.protocol-adapters.test-adapter-name.test-adapter-id.read.publish.failed.count").getCount(), "Matching failed data point should be incremented");
         assertEquals(1, registry.getCounters().get("com.hivemq.edge.protocol-adapters.test-adapter-name.test-adapter-id.read.publish.success.count").getCount(), "Matching success data point should be incremented");
 
-        helper.increment("arbitrary-metric");
+        helper.increment(ARBITRARY_METRIC);
         assertEquals(1, registry.getCounters().get("com.hivemq.edge.protocol-adapters.test-adapter-name.test-adapter-id.arbitrary-metric").getCount(), "Matching arbitrary data point should be incremented");
 
     }
+
+    @Test
+    void testTearDownMetrics() {
+
+        MetricRegistry registry = new MetricRegistry();
+
+        //adapter helper creates 4 metrics
+        ProtocolAdapterMetricsHelper helper1 =
+                new ProtocolAdapterMetricsHelper("tear-down-name1","test-adapter-id", registry);
+
+        //add an arbitrary fifth
+        registry.counter(ARBITRARY_METRIC).inc();
+
+        assertEquals(5, registry.getMetrics().size(), "Number of metrics should match");
+
+        helper1.clearAll();
+
+        assertEquals(1, registry.getMetrics().size(), "Number of metrics should match");
+        assertEquals(1, registry.getCounters().get(ARBITRARY_METRIC).getCount(), "Matching success data point should be incremented");
+
+    }
 }

hivemq-edge/src/test/java/com/hivemq/bridge/BridgeMetricsTest.java

@@ -0,0 +1,46 @@
+package com.hivemq.bridge;
+
+import com.codahale.metrics.MetricRegistry;
+import com.hivemq.bridge.metrics.PerBridgeMetrics;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+/**
+ * @author Simon L Johnson
+ */
+public class BridgeMetricsTest {
+
+    static final String ARBITRARY_METRIC = "arbitrary-metric";
+    @Test
+    void testTearDownMetrics() {
+
+        MetricRegistry registry = new MetricRegistry();
+
+        //adapter helper creates 10 metrics
+        PerBridgeMetrics perBridgeMetrics = new PerBridgeMetrics("bridge-name", registry);
+
+        assertEquals(10, registry.getMetrics().size(), "Number of metrics should match");
+
+        PerBridgeMetrics perBridgeMetrics2 = new PerBridgeMetrics("bridge-name2", registry);
+
+        assertEquals(20, registry.getMetrics().size(), "Number of metrics should match");
+
+        //add an arbitrary fifth
+        registry.counter(ARBITRARY_METRIC).inc();
+
+        assertEquals(21, registry.getMetrics().size(), "Number of metrics should match");
+
+        perBridgeMetrics.clearAll(registry);
+
+        assertEquals(11, registry.getMetrics().size(), "Number of metrics should match");
+
+        perBridgeMetrics2.clearAll(registry);
+
+        assertEquals(1, registry.getMetrics().size(), "Number of metrics should match");
+
+        assertEquals(1, registry.getCounters().get(ARBITRARY_METRIC).getCount(), "Matching success data point should be incremented");
+
+    }
+
+}