Notify all metric reporters when metric registry has been changed
With existing implementation, it is difficult to notify the
metric reports on metric registry changes. With this commit,
we can spontaneously notify all reporters about the metric
registry changes, so that newly added metrics can be automatically
reported to third party monitoring system.
Change-Id: I1273194553900f6bb03e2ef6bb1b54838af1da00
diff --git a/utils/misc/src/main/java/org/onlab/metrics/MetricsManager.java b/utils/misc/src/main/java/org/onlab/metrics/MetricsManager.java
index e8644cc..433311f 100644
--- a/utils/misc/src/main/java/org/onlab/metrics/MetricsManager.java
+++ b/utils/misc/src/main/java/org/onlab/metrics/MetricsManager.java
@@ -15,10 +15,6 @@
*/
package org.onlab.metrics;
-import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
-import java.util.concurrent.ConcurrentMap;
-
import com.codahale.metrics.Counter;
import com.codahale.metrics.Gauge;
import com.codahale.metrics.Histogram;
@@ -27,6 +23,12 @@
import com.codahale.metrics.MetricFilter;
import com.codahale.metrics.MetricRegistry;
import com.codahale.metrics.Timer;
+import com.google.common.collect.Sets;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
/**
* This class holds the Metrics registry for ONOS.
@@ -74,6 +76,11 @@
private MetricRegistry metricsRegistry = new MetricRegistry();
/**
+ * Reporter for exposing metrics objects to third party persistent system.
+ */
+ private Set<MetricsReporter> reporters = Sets.newConcurrentHashSet();
+
+ /**
* Clears the internal state.
*/
protected void clear() {
@@ -216,6 +223,34 @@
}
/**
+ * Registers a reporter to receive any changes on metric registry.
+ *
+ * @param reporter metric reporter
+ */
+ @Override
+ public void registerReporter(MetricsReporter reporter) {
+ reporters.add(reporter);
+ }
+
+ /**
+ * Unregisters the given metric reporter.
+ *
+ * @param reporter metric reporter
+ */
+ @Override
+ public void unregisterReporter(MetricsReporter reporter) {
+ reporters.remove(reporter);
+ }
+
+ /**
+ * Notifies the changes on metric registry to all registered reporters.
+ */
+ @Override
+ public void notifyReporters() {
+ reporters.forEach(MetricsReporter::notifyMetricsChange);
+ }
+
+ /**
* Removes the metric with the given name.
*
* @param component component the Metric is defined in
diff --git a/utils/misc/src/main/java/org/onlab/metrics/MetricsReporter.java b/utils/misc/src/main/java/org/onlab/metrics/MetricsReporter.java
new file mode 100644
index 0000000..68088a5
--- /dev/null
+++ b/utils/misc/src/main/java/org/onlab/metrics/MetricsReporter.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2016-present Open Networking Laboratory
+ *
+ * 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 org.onlab.metrics;
+
+/**
+ * Interface of reporter that reports all metrics value to third party monitor.
+ */
+public interface MetricsReporter {
+
+ /**
+ * Starts to report a set of metrics to the monitoring server.
+ */
+ void startReport();
+
+ /**
+ * Stops reporting metrics.
+ */
+ void stopReport();
+
+ /**
+ * Restarts metrics reporter.
+ */
+ void restartReport();
+
+ /**
+ * Notifies the changes on metric registry.
+ */
+ void notifyMetricsChange();
+}
diff --git a/utils/misc/src/main/java/org/onlab/metrics/MetricsService.java b/utils/misc/src/main/java/org/onlab/metrics/MetricsService.java
index e2e223e..f207803 100644
--- a/utils/misc/src/main/java/org/onlab/metrics/MetricsService.java
+++ b/utils/misc/src/main/java/org/onlab/metrics/MetricsService.java
@@ -113,6 +113,25 @@
T metric);
/**
+ * Registers a reporter to receive any changes on metric registry.
+ *
+ * @param reporter metric reporter
+ */
+ void registerReporter(MetricsReporter reporter);
+
+ /**
+ * Unregisters the given metric reporter.
+ *
+ * @param reporter metric reporter
+ */
+ void unregisterReporter(MetricsReporter reporter);
+
+ /**
+ * Notifies the changes on metric registry to all registered reporters.
+ */
+ void notifyReporters();
+
+ /**
* Removes the metric with the given name.
*
* @param component component the Metric is defined in
diff --git a/utils/misc/src/test/java/org/onlab/metrics/MetricsServiceAdapter.java b/utils/misc/src/test/java/org/onlab/metrics/MetricsServiceAdapter.java
index d92fc4b..bdaea63 100644
--- a/utils/misc/src/test/java/org/onlab/metrics/MetricsServiceAdapter.java
+++ b/utils/misc/src/test/java/org/onlab/metrics/MetricsServiceAdapter.java
@@ -75,6 +75,18 @@
}
@Override
+ public void registerReporter(MetricsReporter reporter) {
+ }
+
+ @Override
+ public void unregisterReporter(MetricsReporter reporter) {
+ }
+
+ @Override
+ public void notifyReporters() {
+ }
+
+ @Override
public boolean removeMetric(MetricsComponent component,
MetricsFeature feature, String metricName) {
return false;