Refactoring and cleanup in the Metrics module:

 * Removed logging related code inside class MetricsManager
 * Removed @Component related code, because it is not suppose to be used
   as an component.
 * Added a new class-wrapper so the Metrics can be used as a loadable service:
   MetricsManagerComponent. The name and the location of this class
   will be refactored in the future.
 * Added new method MetricsManager.removeMetric()
 * Line formatting
 * Changed "interface MetricsService" to public

@@ -68,7 +68,6 @@ private static Logger log = LoggerFactory.getLogger(SimpleNettyClient.class);
         metrics = new MetricsManager();
         metrics = new MetricsManager();
         Endpoint endpoint = new Endpoint(host, port);
         Endpoint endpoint = new Endpoint(host, port);
         messaging.activate();
         messaging.activate();
-        metrics.activate();
         MetricsFeature feature = new MetricsFeature("latency");
         MetricsFeature feature = new MetricsFeature("latency");
         MetricsComponent component = metrics.registerComponent("NettyMessaging");
         MetricsComponent component = metrics.registerComponent("NettyMessaging");
         log.info("connecting " + host + ":" + port + " warmup:" + warmup + " iterations:" + iterations);
         log.info("connecting " + host + ":" + port + " warmup:" + warmup + " iterations:" + iterations);
@@ -117,7 +116,6 @@ private static Logger log = LoggerFactory.getLogger(SimpleNettyClient.class);
     public static void stop() {
     public static void stop() {
         try {
         try {
             messaging.deactivate();
             messaging.deactivate();
-            metrics.deactivate();
         } catch (Exception e) {
         } catch (Exception e) {
             log.info("Unable to stop client %s", e);
             log.info("Unable to stop client %s", e);
         }
         }

+package org.onlab.onos.impl;
+
+import org.apache.felix.scr.annotations.Activate;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Service;
+
+import org.onlab.metrics.MetricsManager;
+
+/**
+ * Metrics service implementation.
+ */
+@Component(immediate = true)
+@Service
+public class MetricsManagerComponent extends MetricsManager {
+
+    @Activate
+    protected void activate() {
+        super.clear();
+    }
+
+    @Deactivate
+    protected void deactivate() {
+        super.clear();
+    }
+}

@@ -3,15 +3,7 @@ package org.onlab.metrics;
 import java.util.Map;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.ConcurrentMap;
-import java.util.concurrent.TimeUnit;
 
 
-import org.apache.felix.scr.annotations.Activate;
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Deactivate;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import com.codahale.metrics.ConsoleReporter;
 import com.codahale.metrics.Counter;
 import com.codahale.metrics.Counter;
 import com.codahale.metrics.Gauge;
 import com.codahale.metrics.Gauge;
 import com.codahale.metrics.Histogram;
 import com.codahale.metrics.Histogram;
@@ -53,48 +45,25 @@ import com.codahale.metrics.Timer;
  *   </code>
  *   </code>
  * </pre>
  * </pre>
  */
  */
-@Component(immediate = true)
-public final class MetricsManager implements MetricsService {
+public class MetricsManager implements MetricsService {
 
 
-    private final Logger log = LoggerFactory.getLogger(getClass());
     /**
     /**
      * Registry to hold the Components defined in the system.
      * Registry to hold the Components defined in the system.
      */
      */
-    private ConcurrentMap<String, MetricsComponent> componentsRegistry;
+    private ConcurrentMap<String, MetricsComponent> componentsRegistry =
+        new ConcurrentHashMap<>();
 
 
     /**
     /**
      * Registry for the Metrics objects created in the system.
      * Registry for the Metrics objects created in the system.
      */
      */
-    private final MetricRegistry metricsRegistry;
+    private MetricRegistry metricsRegistry = new MetricRegistry();
 
 
     /**
     /**
-     * Default Reporter for this metrics manager.
+     * Clears the internal state.
      */
      */
-    //private final Slf4jReporter reporter;
-    private final ConsoleReporter reporter;
-
-    public MetricsManager() {
-        this.metricsRegistry = new MetricRegistry();
-//        this.reporter = Slf4jReporter.forRegistry(this.metricsRegistry)
-//                .outputTo(log)
-//                .convertRatesTo(TimeUnit.SECONDS)
-//                .convertDurationsTo(TimeUnit.MICROSECONDS)
-//                .build();
-        this.reporter = ConsoleReporter.forRegistry(this.metricsRegistry)
-                .convertRatesTo(TimeUnit.SECONDS)
-                .convertDurationsTo(TimeUnit.MICROSECONDS)
-                .build();
-    }
-
-    @Activate
-    public void activate() {
+    protected void clear() {
         this.componentsRegistry = new ConcurrentHashMap<>();
         this.componentsRegistry = new ConcurrentHashMap<>();
-        reporter.start(10, TimeUnit.SECONDS);
-    }
-
-    @Deactivate
-    public void deactivate() {
-        reporter.stop();
+        this.metricsRegistry = new MetricRegistry();
     }
     }
 
 
     /**
     /**
@@ -103,11 +72,12 @@ public final class MetricsManager implements MetricsService {
      * @param name name of the Component to register
      * @param name name of the Component to register
      * @return MetricsComponent object that can be used to create Metrics.
      * @return MetricsComponent object that can be used to create Metrics.
      */
      */
-  @Override
-  public MetricsComponent registerComponent(final String name) {
+    @Override
+    public MetricsComponent registerComponent(final String name) {
         MetricsComponent component = componentsRegistry.get(name);
         MetricsComponent component = componentsRegistry.get(name);
         if (component == null) {
         if (component == null) {
-            final MetricsComponent createdComponent = new MetricsComponent(name);
+            final MetricsComponent createdComponent =
+                new MetricsComponent(name);
             component = componentsRegistry.putIfAbsent(name, createdComponent);
             component = componentsRegistry.putIfAbsent(name, createdComponent);
             if (component == null) {
             if (component == null) {
                 component = createdComponent;
                 component = createdComponent;
@@ -125,9 +95,9 @@ public final class MetricsManager implements MetricsService {
      *
      *
      * @return full name of the metric
      * @return full name of the metric
      */
      */
-  private String generateName(final MetricsComponent component,
-                                      final MetricsFeature feature,
-                                      final String metricName) {
+    private String generateName(final MetricsComponent component,
+                                final MetricsFeature feature,
+                                final String metricName) {
         return MetricRegistry.name(component.getName(),
         return MetricRegistry.name(component.getName(),
                                    feature.getName(),
                                    feature.getName(),
                                    metricName);
                                    metricName);
@@ -141,10 +111,10 @@ public final class MetricsManager implements MetricsService {
      * @param metricName local name of the metric
      * @param metricName local name of the metric
      * @return the created Counter Meteric
      * @return the created Counter Meteric
      */
      */
-  @Override
-  public Counter createCounter(final MetricsComponent component,
-                                        final MetricsFeature feature,
-                                        final String metricName) {
+    @Override
+    public Counter createCounter(final MetricsComponent component,
+                                 final MetricsFeature feature,
+                                 final String metricName) {
         final String name = generateName(component, feature, metricName);
         final String name = generateName(component, feature, metricName);
         return metricsRegistry.counter(name);
         return metricsRegistry.counter(name);
     }
     }
@@ -157,10 +127,10 @@ public final class MetricsManager implements MetricsService {
      * @param metricName local name of the metric
      * @param metricName local name of the metric
      * @return the created Histogram Metric
      * @return the created Histogram Metric
      */
      */
-  @Override
-  public Histogram createHistogram(final MetricsComponent component,
-                                            final MetricsFeature feature,
-                                            final String metricName) {
+    @Override
+    public Histogram createHistogram(final MetricsComponent component,
+                                     final MetricsFeature feature,
+                                     final String metricName) {
         final String name = generateName(component, feature, metricName);
         final String name = generateName(component, feature, metricName);
         return metricsRegistry.histogram(name);
         return metricsRegistry.histogram(name);
     }
     }
@@ -173,10 +143,10 @@ public final class MetricsManager implements MetricsService {
      * @param metricName local name of the metric
      * @param metricName local name of the metric
      * @return the created Timer Metric
      * @return the created Timer Metric
      */
      */
-  @Override
-  public Timer createTimer(final MetricsComponent component,
-                                    final MetricsFeature feature,
-                                    final String metricName) {
+    @Override
+    public Timer createTimer(final MetricsComponent component,
+                             final MetricsFeature feature,
+                             final String metricName) {
         final String name = generateName(component, feature, metricName);
         final String name = generateName(component, feature, metricName);
         return metricsRegistry.timer(name);
         return metricsRegistry.timer(name);
     }
     }
@@ -189,10 +159,10 @@ public final class MetricsManager implements MetricsService {
      * @param metricName local name of the metric
      * @param metricName local name of the metric
      * @return the created Meter Metric
      * @return the created Meter Metric
      */
      */
-  @Override
-  public Meter createMeter(final MetricsComponent component,
-                                    final MetricsFeature feature,
-                                    final String metricName) {
+    @Override
+    public Meter createMeter(final MetricsComponent component,
+                             final MetricsFeature feature,
+                             final String metricName) {
         final String name = generateName(component, feature, metricName);
         final String name = generateName(component, feature, metricName);
         return metricsRegistry.meter(name);
         return metricsRegistry.meter(name);
     }
     }
@@ -209,8 +179,8 @@ public final class MetricsManager implements MetricsService {
      * @param metric Metric to register
      * @param metric Metric to register
      * @return the registered Metric
      * @return the registered Metric
      */
      */
-  @Override
-  public <T extends Metric> T registerMetric(
+    @Override
+    public <T extends Metric> T registerMetric(
                                         final MetricsComponent component,
                                         final MetricsComponent component,
                                         final MetricsFeature feature,
                                         final MetricsFeature feature,
                                         final String metricName,
                                         final String metricName,
@@ -221,14 +191,30 @@ public final class MetricsManager implements MetricsService {
     }
     }
 
 
     /**
     /**
+     * Removes the metric with the given name.
+     *
+     * @param component component the Metric is defined in
+     * @param feature feature the Metric is defined in
+     * @param metricName local name of the metric
+     * @return true if the metric existed and was removed, otherwise false
+     */
+    @Override
+    public boolean removeMetric(final MetricsComponent component,
+                                final MetricsFeature feature,
+                                final String metricName) {
+        final String name = generateName(component, feature, metricName);
+        return metricsRegistry.remove(name);
+    }
+
+    /**
      * Fetches the existing Timers.
      * Fetches the existing Timers.
      *
      *
      * @param filter filter to use to select Timers
      * @param filter filter to use to select Timers
      * @return a map of the Timers that match the filter, with the key as the
      * @return a map of the Timers that match the filter, with the key as the
      *         name String to the Timer.
      *         name String to the Timer.
      */
      */
-  @Override
-  public Map<String, Timer> getTimers(final MetricFilter filter) {
+    @Override
+    public Map<String, Timer> getTimers(final MetricFilter filter) {
         return metricsRegistry.getTimers(filter);
         return metricsRegistry.getTimers(filter);
     }
     }
 
 
@@ -239,8 +225,8 @@ public final class MetricsManager implements MetricsService {
      * @return a map of the Gauges that match the filter, with the key as the
      * @return a map of the Gauges that match the filter, with the key as the
      *         name String to the Gauge.
      *         name String to the Gauge.
      */
      */
-  @Override
-  public Map<String, Gauge> getGauges(final MetricFilter filter) {
+    @Override
+    public Map<String, Gauge> getGauges(final MetricFilter filter) {
         return metricsRegistry.getGauges(filter);
         return metricsRegistry.getGauges(filter);
     }
     }
 
 
@@ -251,8 +237,8 @@ public final class MetricsManager implements MetricsService {
      * @return a map of the Counters that match the filter, with the key as the
      * @return a map of the Counters that match the filter, with the key as the
      *         name String to the Counter.
      *         name String to the Counter.
      */
      */
-  @Override
-  public Map<String, Counter> getCounters(final MetricFilter filter) {
+    @Override
+    public Map<String, Counter> getCounters(final MetricFilter filter) {
         return metricsRegistry.getCounters(filter);
         return metricsRegistry.getCounters(filter);
     }
     }
 
 
@@ -263,8 +249,8 @@ public final class MetricsManager implements MetricsService {
      * @return a map of the Meters that match the filter, with the key as the
      * @return a map of the Meters that match the filter, with the key as the
      *         name String to the Meter.
      *         name String to the Meter.
      */
      */
-  @Override
-  public Map<String, Meter> getMeters(final MetricFilter filter) {
+    @Override
+    public Map<String, Meter> getMeters(final MetricFilter filter) {
         return metricsRegistry.getMeters(filter);
         return metricsRegistry.getMeters(filter);
     }
     }
 
 
@@ -272,11 +258,11 @@ public final class MetricsManager implements MetricsService {
      * Fetches the existing Histograms.
      * Fetches the existing Histograms.
      *
      *
      * @param filter filter to use to select Histograms
      * @param filter filter to use to select Histograms
-     * @return a map of the Histograms that match the filter, with the key as the
-     *         name String to the Histogram.
+     * @return a map of the Histograms that match the filter, with the key as
+     *         the name String to the Histogram.
      */
      */
-  @Override
-  public Map<String, Histogram> getHistograms(final MetricFilter filter) {
+    @Override
+    public Map<String, Histogram> getHistograms(final MetricFilter filter) {
         return metricsRegistry.getHistograms(filter);
         return metricsRegistry.getHistograms(filter);
     }
     }
 
 
@@ -285,9 +271,8 @@ public final class MetricsManager implements MetricsService {
      *
      *
      * @param filter filter to use to select the Metrics to remove.
      * @param filter filter to use to select the Metrics to remove.
      */
      */
-  @Override
-  public void removeMatching(final MetricFilter filter) {
+    @Override
+    public void removeMatching(final MetricFilter filter) {
         metricsRegistry.removeMatching(filter);
         metricsRegistry.removeMatching(filter);
     }
     }
 }
 }
-

@@ -13,7 +13,7 @@ import com.codahale.metrics.Timer;
 /**
 /**
  * Metrics Service to collect metrics.
  * Metrics Service to collect metrics.
  */
  */
-interface MetricsService {
+public interface MetricsService {
 
 
     /**
     /**
      * Registers a component.
      * Registers a component.
@@ -90,6 +90,18 @@ interface MetricsService {
              T metric);
              T metric);
 
 
     /**
     /**
+     * Removes the metric with the given name.
+     *
+     * @param component component the Metric is defined in
+     * @param feature feature the Metric is defined in
+     * @param metricName local name of the metric
+     * @return true if the metric existed and was removed, otherwise false
+     */
+    boolean removeMetric(MetricsComponent component,
+                         MetricsFeature feature,
+                         String metricName);
+
+    /**
      * Fetches the existing Timers.
      * Fetches the existing Timers.
      *
      *
      * @param filter filter to use to select Timers
      * @param filter filter to use to select Timers
@@ -129,15 +141,15 @@ interface MetricsService {
      * Fetches the existing Histograms.
      * Fetches the existing Histograms.
      *
      *
      * @param filter filter to use to select Histograms
      * @param filter filter to use to select Histograms
-     * @return a map of the Histograms that match the filter, with the key as the
-     *         name String to the Histogram.
+     * @return a map of the Histograms that match the filter, with the key as
+     *         the name String to the Histogram.
      */
      */
      Map<String, Histogram> getHistograms(MetricFilter filter);
      Map<String, Histogram> getHistograms(MetricFilter filter);
+
     /**
     /**
      * Removes all Metrics that match a given filter.
      * Removes all Metrics that match a given filter.
      *
      *
      * @param filter filter to use to select the Metrics to remove.
      * @param filter filter to use to select the Metrics to remove.
      */
      */
      void removeMatching(MetricFilter filter);
      void removeMatching(MetricFilter filter);
-
 }
 }