RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.

pom.xml

@@ -85,6 +85,7 @@
     <module>ratis-replicated-map</module>
     <module>ratis-metrics-api</module>
     <module>ratis-metrics-default</module>
+    <module>ratis-metrics-dropwizard3</module>
     <module>ratis-tools</module>
     <module>ratis-shell</module>
     <module>ratis-assembly</module>
@@ -281,6 +282,11 @@
         <groupId>org.apache.ratis</groupId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <artifactId>ratis-metrics-dropwizard3</artifactId>
+        <groupId>org.apache.ratis</groupId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <artifactId>ratis-metrics-default</artifactId>
         <groupId>org.apache.ratis</groupId>

ratis-assembly/src/main/assembly/bin.xml

@@ -41,6 +41,7 @@
         <include>org.apache.ratis:ratis-test</include>
         <include>org.apache.ratis:ratis-metrics-api</include>
         <include>org.apache.ratis:ratis-metrics-default</include>
+        <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
         <include>org.apache.ratis:ratis-tools</include>
         <include>org.apache.ratis:ratis-resource-bundle</include>
       </includes>

ratis-assembly/src/main/assembly/src.xml

@@ -44,6 +44,7 @@
         <include>org.apache.ratis:ratis-test</include>
         <include>org.apache.ratis:ratis-metrics-api</include>
         <include>org.apache.ratis:ratis-metrics-default</include>
+        <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
         <include>org.apache.ratis:ratis-tools</include>
         <include>org.apache.ratis:ratis-resource-bundle</include>
       </includes>

ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java

@@ -21,20 +21,21 @@
 import static org.junit.Assert.assertNotEquals;
 import static org.mockito.Mockito.mock;
 
-import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
+import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
+import org.junit.Assert;
 import org.junit.Test;
 
+import java.util.Arrays;
+import java.util.Collections;
 
 /**
  * Test class for {@link MetricRegistriesLoader}.
  */
 public class TestMetricRegistriesLoader {
-
-
   @Test
-  public void testLoadSinleInstance() {
+  public void testLoadSingleInstance() {
     MetricRegistries loader = mock(MetricRegistries.class);
-    MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
+    MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
     assertEquals(loader, instance);
   }
 
@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
     MetricRegistries loader1 = mock(MetricRegistries.class);
     MetricRegistries loader2 = mock(MetricRegistries.class);
     MetricRegistries loader3 = mock(MetricRegistries.class);
-    MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
-        loader3));
+    MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));
 
     // the load() returns the first instance
     assertEquals(loader1, instance);
     assertNotEquals(loader2, instance);
     assertNotEquals(loader3, instance);
   }
+
+  @Test
+  public void testLoadDefault() {
+    final MetricRegistries r = MetricRegistriesLoader.load();
+    Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
+  }
+
 }

ratis-metrics-dropwizard3/pom.xml

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  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. See accompanying LICENSE file.
+-->
+<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>
+    <artifactId>ratis</artifactId>
+    <groupId>org.apache.ratis</groupId>
+    <version>3.0.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>ratis-metrics-dropwizard3</artifactId>
+  <name>Apache Ratis Metrics Dropwizard 3 Implementation</name>
+
+  <properties>
+    <dropwizard3.version>3.2.5</dropwizard3.version>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <artifactId>ratis-metrics-api</artifactId>
+      <groupId>org.apache.ratis</groupId>
+    </dependency>
+    <dependency>
+      <artifactId>ratis-proto</artifactId>
+      <groupId>org.apache.ratis</groupId>
+    </dependency>
+    <dependency>
+      <artifactId>ratis-common</artifactId>
+      <groupId>org.apache.ratis</groupId>
+    </dependency>
+    <dependency>
+      <artifactId>ratis-common</artifactId>
+      <groupId>org.apache.ratis</groupId>
+      <scope>test</scope>
+      <type>test-jar</type>
+    </dependency>
+
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>io.dropwizard.metrics</groupId>
+      <artifactId>metrics-core</artifactId>
+      <version>${dropwizard3.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>io.dropwizard.metrics</groupId>
+      <artifactId>metrics-jvm</artifactId>
+      <version>${dropwizard3.version}</version>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>io.dropwizard.metrics</groupId>
+      <artifactId>metrics-ganglia</artifactId>
+      <version>${dropwizard3.version}</version>
+      <exclusions>
+        <exclusion>
+          <groupId>org.acplt</groupId>
+          <artifactId>oncrpc</artifactId>
+        </exclusion>
+      </exclusions>
+      <optional>true</optional>
+    </dependency>
+
+  </dependencies>
+</project>

ratis-metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java

@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 org.apache.ratis.metrics.dropwizard3;
+
+import org.apache.ratis.metrics.MetricRegistries;
+import org.apache.ratis.metrics.MetricRegistryInfo;
+import org.apache.ratis.metrics.RatisMetricRegistry;
+import org.apache.ratis.util.TimeDuration;
+import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
+import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
+import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
+import com.codahale.metrics.jvm.ThreadStatesGaugeSet;
+
+/**
+ * Helper class to add JVM metrics.
+ */
+public interface Dm3JvmMetrics {
+  static void initJvmMetrics(TimeDuration consoleReportRate) {
+    final MetricRegistries registries = MetricRegistries.global();
+    Dm3JvmMetrics.addJvmMetrics(registries);
+    registries.enableConsoleReporter(consoleReportRate);
+    registries.enableJmxReporter();
+  }
+
+  static void addJvmMetrics(MetricRegistries registries) {
+    MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");
+
+    RatisMetricRegistry registry = registries.create(info);
+
+    final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
+    impl.registerAll("gc", new GarbageCollectorMetricSet());
+    impl.registerAll("memory", new MemoryUsageGaugeSet());
+    impl.registerAll("threads", new ThreadStatesGaugeSet());
+    impl.registerAll("classLoading", new ClassLoadingGaugeSet());
+  }
+}

ratis-metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java

@@ -0,0 +1,129 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 org.apache.ratis.metrics.dropwizard3;
+
+import java.util.Collection;
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+import java.util.concurrent.CopyOnWriteArrayList;
+import java.util.function.Consumer;
+
+import org.apache.ratis.metrics.MetricRegistries;
+import org.apache.ratis.metrics.MetricRegistryInfo;
+import org.apache.ratis.metrics.RatisMetricRegistry;
+import org.apache.ratis.util.TimeDuration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Implementation of MetricRegistries that does ref-counting.
+ */
+public class Dm3MetricRegistriesImpl extends MetricRegistries {
+
+  private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);
+
+  private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();
+
+  private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();
+
+  private final Dm3MetricRegistryFactoryImpl factory;
+
+  private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;
+
+  public Dm3MetricRegistriesImpl() {
+    this(new Dm3MetricRegistryFactoryImpl());
+  }
+
+  Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
+    this.factory = factory;
+    this.registries = new RefCountingMap<>();
+  }
+
+  @Override
+  public RatisMetricRegistry create(MetricRegistryInfo info) {
+    return registries.put(info, () -> {
+      if (reporterRegistrations.isEmpty()) {
+        if (LOG.isDebugEnabled()) {
+          LOG.debug("First MetricRegistry has been created without registering reporters. " +
+              "Hence registering JMX reporter by default.");
+        }
+        enableJmxReporter();
+      }
+      RatisMetricRegistry registry = factory.create(info);
+      reporterRegistrations.forEach(reg -> reg.accept(registry));
+      return registry;
+    });
+  }
+
+  @Override
+  public boolean remove(MetricRegistryInfo key) {
+    RatisMetricRegistry registry = registries.get(key);
+    if (registry != null) {
+      stopReporters.forEach(reg -> reg.accept(registry));
+    }
+
+    return registries.remove(key) == null;
+  }
+
+  @Override
+  public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
+    return Optional.ofNullable(registries.get(info));
+  }
+
+  @Override
+  public Collection<RatisMetricRegistry> getMetricRegistries() {
+    return Collections.unmodifiableCollection(registries.values());
+  }
+
+  @Override
+  public void clear() {
+    registries.clear();
+  }
+
+  @Override
+  public Set<MetricRegistryInfo> getMetricRegistryInfos() {
+    return Collections.unmodifiableSet(registries.keySet());
+  }
+
+  @Override
+  public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
+      Consumer<RatisMetricRegistry> stopReporter) {
+    if (registries.size() > 0) {
+      LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
+          + "Please add reporter before adding any new registry.");
+    }
+    this.reporterRegistrations.add(reporterRegistration);
+    this.stopReporters.add(stopReporter);
+  }
+
+  @Override
+  public void enableJmxReporter() {
+    addReporterRegistration(
+        Dm3MetricsReporting.jmxReporter(),
+        Dm3MetricsReporting.stopJmxReporter());
+  }
+
+  @Override
+  public void enableConsoleReporter(TimeDuration consoleReportRate) {
+    addReporterRegistration(
+        Dm3MetricsReporting.consoleReporter(consoleReportRate),
+        Dm3MetricsReporting.stopConsoleReporter());
+  }
+}

ratis-metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java

@@ -0,0 +1,28 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 org.apache.ratis.metrics.dropwizard3;
+
+import org.apache.ratis.metrics.MetricRegistryFactory;
+import org.apache.ratis.metrics.MetricRegistryInfo;
+
+public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
+  @Override
+  public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
+    return new Dm3RatisMetricRegistryImpl(info);
+  }
+}