Augment metrics model to monitor more # of control metrics

Existing implementation only monitors OpenFlow messages.
This commit augments the metrics model in a way to monitor more
number of control metrics including
- CPU Load, total CPU time, sys CPU time, user CPU time, etc.
- Used memory percentage, free memory percentage
- Disk read/write bytes
- Network incoming/outgoing bytes/packets

Change-Id: I9e8eee163c3033132eb202f3c75bad246c87f133

@@ -34,8 +34,7 @@
         <onos.app.name>org.onosproject.cpman</onos.app.name>
         <onos.app.category>default</onos.app.category>
         <onos.app.url>http://onosproject.org</onos.app.url>
-        <onos.app.readme>Control plane management application.
-        </onos.app.readme>
+        <onos.app.readme>Control plane management application.</onos.app.readme>
     </properties>
 
     <dependencies>

 /*
- * Copyright 2015 Open Networking Laboratory
+ * Copyright 2015-2016 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.
@@ -20,27 +20,78 @@ package org.onosproject.cpman;
  */
 public enum ControlMetricType {
 
-    /** Mapped to PACKET-IN message of OpenFlow. */
+    /* Mapped to PACKET-IN message of OpenFlow. */
     INBOUND_PACKET,
 
-    /** Mapped to PACKET-OUT message of OpenFlow. */
+    /* Mapped to PACKET-OUT message of OpenFlow. */
     OUTBOUND_PACKET,
 
-    /** Mapped to FLOW-MOD message of OpenFlow. */
+    /* Mapped to FLOW-MOD message of OpenFlow. */
     FLOW_MOD_PACKET,
 
-    /** Mapped to FLOW-REMOVED message of OpenFlow. */
+    /* Mapped to FLOW-REMOVED message of OpenFlow. */
     FLOW_REMOVED_PACKET,
 
-    /** Mapped to STATS-REQUEST message of OpenFlow. */
+    /* Mapped to STATS-REQUEST message of OpenFlow. */
     REQUEST_PACKET,
 
-    /** Mapped to STATS-REPLY message of OpenFlow. */
+    /* Mapped to STATS-REPLY message of OpenFlow. */
     REPLY_PACKET,
 
-    /** Cpu Utilization. */
-    CPU_INFO,
+    /* Number of CPU cores. */
+    NUM_OF_CORES,
 
-    /** Memory Utilization. */
-    MEMORY_INFO
+    /* Number of CPUs. **/
+    NUM_OF_CPUS,
+
+    /* CPU Speed. **/
+    CPU_SPEED,
+
+    /* CPU Load. **/
+    CPU_LOAD,
+
+    /* Total Amount of CPU Up Time. **/
+    TOTAL_CPU_TIME,
+
+    /* System CPU Up Time. **/
+    SYS_CPU_TIME,
+
+    /* User CPU Up Time. **/
+    USER_CPU_TIME,
+
+    /* CPU Idle Time. **/
+    CPU_IDLE_TIME,
+
+    /* Percentage of Used Memory Amount. */
+    MEMORY_USED_PERCENTAGE,
+
+    /* Percentage of Free Memory Amount. **/
+    MEMORY_FREE_PERCENTAGE,
+
+    /* Used Memory Amount. **/
+    MEMORY_USED,
+
+    /* Free Memory Amount. **/
+    MEMORY_FREE,
+
+    /* Total Amount of Memory. **/
+    MEMORY_TOTAL,
+
+    /* Disk Read Bytes. **/
+    DISK_READ_BYTES,
+
+    /* Disk Write Bytes. **/
+    DISK_WRITE_BYTES,
+
+    /* Network Incoming Bytes. **/
+    NW_INCOMING_BYTES,
+
+    /* Network Outgoing Bytes. **/
+    NW_OUTGOING_BYTES,
+
+    /* Network Incoming Packets. **/
+    NW_INCOMING_PACKETS,
+
+    /* Network Outgoing Packets. **/
+    NW_OUTGOING_PACKETS
 }

 /*
- * Copyright 2015 Open Networking Laboratory
+ * Copyright 2015-2016 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.
@@ -31,4 +31,12 @@ public interface ControlMetricsObserver {
      * @param deviceId          device id {@link org.onosproject.net.DeviceId}
      */
     void feedMetrics(MetricsAggregator metricsAggregator, Optional<DeviceId> deviceId);
+
+    /**
+     * Feeds the extracted value from MetricAggregator to back-end storage.
+     *
+     * @param metricsAggregator metric aggregator
+     * @param resourceName      resource name
+     */
+    void feedMetrics(MetricsAggregator metricsAggregator, String resourceName);
 }

+/*
+ * Copyright 2016 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.onosproject.cpman;
+
+/**
+ * Control metrics class for storing system specification.
+ */
+public final class ControlMetricsSystemSpec {
+    private int numOfCores;
+    private int numOfCpus;
+    private int cpuSpeed;               // in MHz
+    private long totalMemory;           // in bytes
+
+    private ControlMetricsSystemSpec(int numOfCores, int numOfCpus,
+                                     int cpuSpeed, long totalMemory) {
+        this.numOfCores = numOfCores;
+        this.numOfCpus = numOfCpus;
+        this.cpuSpeed = cpuSpeed;
+        this.totalMemory = totalMemory;
+    }
+
+    /**
+     * Returns number of CPU cores.
+     *
+     * @return number of CPU cores
+     */
+    public int numOfCores() {
+        return this.numOfCores;
+    }
+
+    /**
+     * Returns number of CPUs.
+     *
+     * @return number of CPUs
+     */
+    public int numOfCpus() {
+        return this.numOfCpus;
+    }
+
+    /**
+     * Returns CPU speed in MHz.
+     *
+     * @return CPU speed
+     */
+    public int cpuSpeed() {
+        return this.cpuSpeed;
+    }
+
+    /**
+     * Returns the total amount of memory.
+     *
+     * @return memory size
+     */
+    public long totalMemory() {
+        return this.totalMemory;
+    }
+
+    /**
+     * ControlMetricsSystemSpec builder class.
+     */
+    public static final class Builder {
+        private int numOfCores;
+        private int numOfCpus;
+        private int cpuSpeed;               // in MHz
+        private long totalMemory;           // in bytes
+
+        /**
+         * Sets number of CPU cores.
+         *
+         * @param numOfCores number of CPU cores
+         * @return Builder object
+         */
+        public Builder numOfCores(int numOfCores) {
+            this.numOfCores = numOfCores;
+            return this;
+        }
+
+        /**
+         * Sets number of CPUs.
+         * @param numOfCpus number of CPUs
+         * @return Builder object
+         */
+        public Builder numOfCpus(int numOfCpus) {
+            this.numOfCpus = numOfCpus;
+            return this;
+        }
+
+        /**
+         * Sets CPU speed.
+         *
+         * @param cpuSpeed CPU speed
+         * @return Builder object
+         */
+        public Builder cpuSpeed(int cpuSpeed) {
+            this.cpuSpeed = cpuSpeed;
+            return this;
+        }
+
+        /**
+         * Sets total amount of memory.
+         *
+         * @param totalMemory memory size
+         * @return Builder object
+         */
+        public Builder totalMemory(long totalMemory) {
+            this.totalMemory = totalMemory;
+            return this;
+        }
+
+        /**
+         * Builds a ControlMetricsSystemSpec object.
+         *
+         * @return ControlMetricsSystemSpec object
+         */
+        public ControlMetricsSystemSpec build() {
+            return new ControlMetricsSystemSpec(numOfCores, numOfCpus, cpuSpeed, totalMemory);
+        }
+    }
+}

 /*
- * Copyright 2015 Open Networking Laboratory
+ * Copyright 2015-2016 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.
@@ -95,18 +95,18 @@ public class ControlPlaneManager {
         if (cmf.isMonitor()) {
             controlMetricsObservers.forEach(observer -> {
 
-                // try to feed the CPU and memory stats
-                observer.feedMetrics(cmf.cpuInfoMetric(), Optional.ofNullable(null));
-                observer.feedMetrics(cmf.memoryInfoMetric(), Optional.ofNullable(null));
+                // only OpenFlow messages are spontaneously monitored with
+                // 1 minute period. Other system metrics will be pushed from
+                // external monitoring agent through REST API
 
-                // try to feed the control message stats
+                // feed the control message stats
                 cmf.getDeviceIds().forEach(v -> {
-                    observer.feedMetrics(cmf.inboundPacketMetrics(v), Optional.of(v));
-                    observer.feedMetrics(cmf.outboundPacketMetrics(v), Optional.of(v));
-                    observer.feedMetrics(cmf.flowmodPacketMetrics(v), Optional.of(v));
-                    observer.feedMetrics(cmf.flowrmvPacketMetrics(v), Optional.of(v));
-                    observer.feedMetrics(cmf.requestPacketMetrics(v), Optional.of(v));
-                    observer.feedMetrics(cmf.replyPacketMetrics(v), Optional.of(v));
+                    observer.feedMetrics(cmf.inboundPacket(v), Optional.of(v));
+                    observer.feedMetrics(cmf.outboundPacket(v), Optional.of(v));
+                    observer.feedMetrics(cmf.flowmodPacket(v), Optional.of(v));
+                    observer.feedMetrics(cmf.flowrmvPacket(v), Optional.of(v));
+                    observer.feedMetrics(cmf.requestPacket(v), Optional.of(v));
+                    observer.feedMetrics(cmf.replyPacket(v), Optional.of(v));
                 });
             });
         }

 /*
- * Copyright 2015 Open Networking Laboratory
+ * Copyright 2015-2016 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.
@@ -57,6 +57,12 @@ public class ControlPlaneMonitor implements ControlPlaneMonitorService {
     }
 
     @Override
+    public void updateMetric(ControlMetric controlMetric, int updateInterval,
+                             String resourceName) {
+
+    }
+
+    @Override
     public ControlLoad getLoad(NodeId nodeId, ControlMetricType type,
                                Optional<DeviceId> deviceId) {
         return null;

 /*
- * Copyright 2015 Open Networking Laboratory
+ * Copyright 2015-2016 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.
@@ -36,6 +36,15 @@ public interface ControlPlaneMonitorService {
     void updateMetric(ControlMetric controlMetric, int updateInterval, Optional<DeviceId> deviceId);
 
     /**
+     * Adds a new control metric value with a certain update interval.
+     *
+     * @param controlMetric     control plane metric (e.g., disk and network metrics)
+     * @param updateInterval    value update interval (time unit will be in minute)
+     * @param resourceName      resource name
+     */
+    void updateMetric(ControlMetric controlMetric, int updateInterval, String resourceName);
+
+    /**
      * Obtains the control plane load of a specific device.
      *
      * @param nodeId   node id {@link org.onosproject.cluster.NodeId}

 /*
- * Copyright 2015 Open Networking Laboratory
+ * Copyright 2015-2016 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.
@@ -32,7 +32,14 @@ public class DefaultControlMetricsObserver implements ControlMetricsObserver {
     @Override
     public void feedMetrics(MetricsAggregator ma, Optional<DeviceId> deviceId) {
         MetricValue mv = new MetricValue((long) ma.getRate(), (long) ma.getLoad(), (long) ma.getCount());
-        ControlMetric cpm = new ControlMetric(ma.getMetricsType(), mv);
-        controlPlaneMonitorService.updateMetric(cpm, 1, deviceId);
+        ControlMetric cm = new ControlMetric(ma.getMetricsType(), mv);
+        controlPlaneMonitorService.updateMetric(cm, 1, deviceId);
+    }
+
+    @Override
+    public void feedMetrics(MetricsAggregator ma, String resourceName) {
+        MetricValue mv = new MetricValue((long) ma.getRate(), (long) ma.getLoad(), (long) ma.getCount());
+        ControlMetric cm = new ControlMetric(ma.getMetricsType(), mv);
+        controlPlaneMonitorService.updateMetric(cm, 1, resourceName);
     }
 }
\ No newline at end of file

 /*
- * Copyright 2015 Open Networking Laboratory
+ * Copyright 2015-2016 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.
@@ -16,6 +16,7 @@
 package org.onosproject.cpman;
 
 import com.codahale.metrics.Meter;
+import org.apache.commons.lang3.StringUtils;
 import org.onlab.metrics.MetricsComponent;
 import org.onlab.metrics.MetricsFeature;
 import org.onlab.metrics.MetricsService;
@@ -49,13 +50,58 @@ public class MetricsAggregator {
      * @param type           Control metric type
      * @param deviceId       DeviceId
      */
-    MetricsAggregator(MetricsService metricsService, ControlMetricType type, Optional<DeviceId> deviceId) {
+    MetricsAggregator(MetricsService metricsService, ControlMetricType type,
+                      Optional<DeviceId> deviceId) {
+        init(metricsService, type, deviceId, null);
+    }
+
+    /**
+     * Constructs a new MetricAggregator for aggregating a metric.
+     * Instantiates the metrics service
+     * Initializes all the general metrics for that object
+     *
+     * @param metricsService MetricsService reference
+     * @param type           Control metric type
+     * @param resourceName   resource name (e.g., ethernet interface name)
+     */
+    MetricsAggregator(MetricsService metricsService, ControlMetricType type,
+                      String resourceName) {
+        init(metricsService, type, Optional.ofNullable(null), resourceName);
+
+    }
+
+    /**
+     * Constructs a new MetricAggregator for aggregating a metric.
+     * Instantiates the metrics service
+     * Initializes all the general metrics for that object
+     *
+     * @param metricsService MetricsService reference
+     * @param type           Control metric type
+     */
+    MetricsAggregator(MetricsService metricsService, ControlMetricType type) {
+        init(metricsService, type, Optional.ofNullable(null), null);
+    }
+
+    /**
+     * Base method of the constructor of this class.
+     *
+     * @param metricsService MetricsService reference
+     * @param type           Control metric type
+     * @param deviceId       DeviceId
+     * @param resourceName   resource name
+     */
+    private void init(MetricsService metricsService, ControlMetricType type,
+                      Optional<DeviceId> deviceId, String resourceName) {
         String primitiveName = type.toString();
         String objName = "all";
         if (deviceId.isPresent()) {
             objName = deviceId.toString();
         }
 
+        if (StringUtils.isNotEmpty(resourceName)) {
+            objName = resourceName;
+        }
+
         checkNotNull(primitiveName, "Component name cannot be null");
         checkNotNull(objName, "Feature name cannot be null");
 
@@ -74,14 +120,6 @@ public class MetricsAggregator {
     }
 
     /**
-     * Removes both rate and count metrics.
-     */
-    protected void removeMetrics() {
-        metricsService.removeMetric(metricsComponent, metricsFeature, RATE_NAME);
-        metricsService.removeMetric(metricsComponent, metricsFeature, COUNT_NAME);
-    }
-
-    /**
      * Increments the meter rate by {@code n}, and the meter counter by 1.
      *
      * @param n Increment the meter rate by {@code n}.