start cadvisor and prometheus docker container at startup
[osm/vim-emu.git] / src / emuvim / dcemulator / monitoring.py
index 094c09b..7fa5e18 100755 (executable)
@@ -4,23 +4,100 @@ import urllib2
 import logging\r
 from mininet.node import  OVSSwitch\r
 import ast\r
+import time\r
+from prometheus_client import start_http_server, Summary, Histogram, Gauge, Counter\r
+import threading\r
+from subprocess import Popen, PIPE\r
+import os\r
+\r
 logging.basicConfig(level=logging.INFO)\r
 \r
 """\r
-class to read openflow stats from the Ryu controller of the DCNEtwork\r
+class to read openflow stats from the Ryu controller of the DCNetwork\r
 """\r
 \r
 class DCNetworkMonitor():\r
     def __init__(self, net):\r
         self.net = net\r
-        # link to REST_API\r
+        # link to Ryu REST_API\r
         self.ip = '0.0.0.0'\r
         self.port = '8080'\r
         self.REST_api = 'http://{0}:{1}'.format(self.ip,self.port)\r
 \r
+        # helper variables to calculate the metrics\r
+        # Start up the server to expose the metrics to Prometheus.\r
+        start_http_server(8000)\r
+        # supported Prometheus metrics\r
+        self.prom_tx_packet_count = Gauge('sonemu_tx_count_packets', 'Total number of packets sent',\r
+                                          ['vnf_name', 'vnf_interface'])\r
+        self.prom_rx_packet_count = Gauge('sonemu_rx_count_packets', 'Total number of packets received',\r
+                                          ['vnf_name', 'vnf_interface'])\r
+        self.prom_tx_byte_count = Gauge('sonemu_tx_count_bytes', 'Total number of bytes sent',\r
+                                        ['vnf_name', 'vnf_interface'])\r
+        self.prom_rx_byte_count = Gauge('sonemu_rx_count_bytes', 'Total number of bytes received',\r
+                                        ['vnf_name', 'vnf_interface'])\r
+\r
+        self.prom_metrics={'tx_packets':self.prom_tx_packet_count, 'rx_packets':self.prom_rx_packet_count,\r
+                           'tx_bytes':self.prom_tx_byte_count,'rx_bytes':self.prom_rx_byte_count}\r
+\r
+        # list of installed metrics to monitor\r
+        # each entry can contain this data\r
+        '''\r
+        {\r
+        switch_dpid = 0\r
+        vnf_name = None\r
+        vnf_interface = None\r
+        previous_measurement = 0\r
+        previous_monitor_time = 0\r
+        metric_key = None\r
+        mon_port = None\r
+        }\r
+        '''\r
+        self.network_metrics = []\r
+\r
+        # start monitoring thread\r
+        self.start_monitoring = True\r
+        self.monitor_thread = threading.Thread(target=self.get_network_metrics)\r
+        self.monitor_thread.start()\r
+\r
+        # helper tools\r
+        self.prometheus_process = self.start_Prometheus()\r
+        self.cadvisor_process = self.start_cadvisor()\r
+\r
+    # first set some parameters, before measurement can start\r
+    def setup_metric(self, vnf_name, vnf_interface=None, metric='tx_packets'):\r
+\r
+        network_metric = {}\r
+\r
+        # check if port is specified (vnf:port)\r
+        if vnf_interface is None:\r
+            # take first interface by default\r
+            connected_sw = self.net.DCNetwork_graph.neighbors(vnf_name)[0]\r
+            link_dict = self.net.DCNetwork_graph[vnf_name][connected_sw]\r
+            vnf_interface = link_dict[0]['src_port_id']\r
+\r
+        network_metric['vnf_name'] = vnf_name\r
+        network_metric['vnf_interface'] = vnf_interface\r
+\r
+        for connected_sw in self.net.DCNetwork_graph.neighbors(vnf_name):\r
+            link_dict = self.net.DCNetwork_graph[vnf_name][connected_sw]\r
+            for link in link_dict:\r
+                # logging.info("{0},{1}".format(link_dict[link],vnf_interface))\r
+                if link_dict[link]['src_port_id'] == vnf_interface:\r
+                    # found the right link and connected switch\r
+                    # logging.info("{0},{1}".format(link_dict[link]['src_port_id'], vnf_source_interface))\r
+                    network_metric['mon_port'] = link_dict[link]['dst_port']\r
+                    break\r
+\r
+        if 'mon_port' not in network_metric:\r
+            logging.exception("vnf interface {0}:{1} not found!".format(vnf_name,vnf_interface))\r
+            return "vnf interface {0}:{1} not found!".format(vnf_name,vnf_interface)\r
 \r
-    def get_rate(self, vnf_name, direction='tx'):\r
         try:\r
+            # default port direction to monitor\r
+            if metric is None:\r
+                metric = 'tx_packets'\r
+\r
             vnf_switch = self.net.DCNetwork_graph.neighbors(str(vnf_name))\r
 \r
             if len(vnf_switch) > 1:\r
@@ -33,30 +110,168 @@ class DCNetworkMonitor():
                 vnf_switch = vnf_switch[0]\r
             next_node = self.net.getNodeByName(vnf_switch)\r
 \r
-            if not isinstance( next_node, OVSSwitch ):\r
+            if not isinstance(next_node, OVSSwitch):\r
                 logging.info("vnf: {0} is not connected to switch".format(vnf_name))\r
                 return\r
 \r
-            mon_port = self.net.DCNetwork_graph[vnf_name][vnf_switch]['dst_port']\r
-            switch_dpid = x = int(str(next_node.dpid),16)\r
+            network_metric['previous_measurement'] = 0\r
+            network_metric['previous_monitor_time'] = 0\r
 \r
-            ret = self.REST_cmd('stats/port', switch_dpid)\r
-            port_stat_dict = ast.literal_eval(ret)\r
-            for port_stat in port_stat_dict[str(switch_dpid)]:\r
-                if port_stat['port_no'] == mon_port:\r
-                    return port_stat\r
-                    break\r
 \r
-            return ret\r
+            network_metric['switch_dpid'] = int(str(next_node.dpid), 16)\r
+            network_metric['metric_key'] = metric\r
+\r
+\r
+            self.network_metrics.append(network_metric)\r
+\r
+            logging.info('Started monitoring: {2} on {0}:{1}'.format(vnf_name, vnf_interface, metric))\r
+            return 'Started monitoring: {2} on {0}:{1}'.format(vnf_name, vnf_interface, metric)\r
 \r
         except Exception as ex:\r
-            logging.exception("get_txrate error.")\r
+            logging.exception("get_rate error.")\r
             return ex.message\r
 \r
+    def remove_metric(self, vnf_name, vnf_interface, metric):\r
+        for metric_dict in self.network_metrics:\r
+            if metric_dict['vnf_name'] == vnf_name and metric_dict['vnf_interface'] == vnf_interface \\r
+                    and metric_dict['metric'] == metric:\r
+                self.network_metrics.remove(metric_dict)\r
+                logging.info('Stopped monitoring: {2} on {0}:{1}'.format(vnf_name, vnf_interface, metric))\r
+                return 'Stopped monitoring: {2} on {0}:{1}'.format(vnf_name, vnf_interface, metric)\r
+\r
+\r
+    # get all metrics defined in the list and export it to Prometheus\r
+    def get_network_metrics(self):\r
+        while self.start_monitoring:\r
+            # group metrics by dpid to optimize the rest api calls\r
+            dpid_list = [metric_dict['switch_dpid'] for metric_dict in self.network_metrics]\r
+            dpid_set = set(dpid_list)\r
+\r
+            for dpid in dpid_set:\r
+\r
+                # query Ryu\r
+                ret = self.REST_cmd('stats/port', dpid)\r
+                port_stat_dict = ast.literal_eval(ret)\r
+\r
+                metric_list = [metric_dict for metric_dict in self.network_metrics\r
+                               if int(metric_dict['switch_dpid'])==int(dpid)]\r
+                #logging.info('1set prom packets:{0} '.format(self.network_metrics))\r
+                for metric_dict in metric_list:\r
+                    self.set_network_metric(metric_dict, port_stat_dict)\r
+\r
+            time.sleep(1)\r
+\r
+    # add metric to the list to export to Prometheus, parse the Ryu port-stats reply\r
+    def set_network_metric(self, metric_dict, port_stat_dict):\r
+        # vnf tx is the datacenter switch rx and vice-versa\r
+        metric_key = self.switch_tx_rx(metric_dict['metric_key'])\r
+        switch_dpid = metric_dict['switch_dpid']\r
+        vnf_name = metric_dict['vnf_name']\r
+        vnf_interface = metric_dict['vnf_interface']\r
+        previous_measurement = metric_dict['previous_measurement']\r
+        previous_monitor_time = metric_dict['previous_monitor_time']\r
+        mon_port = metric_dict['mon_port']\r
+\r
+        for port_stat in port_stat_dict[str(switch_dpid)]:\r
+            if int(port_stat['port_no']) == int(mon_port):\r
+                port_uptime = port_stat['duration_sec'] + port_stat['duration_nsec'] * 10 ** (-9)\r
+                this_measurement = int(port_stat[metric_key])\r
+                #logging.info('set prom packets:{0} {1}:{2}'.format(this_measurement, vnf_name, vnf_interface))\r
+\r
+                # set prometheus metric\r
+                self.prom_metrics[metric_key].labels(vnf_name, vnf_interface).set(this_measurement)\r
+\r
+                if previous_monitor_time <= 0 or previous_monitor_time >= port_uptime:\r
+                    metric_dict['previous_measurement'] = int(port_stat[metric_key])\r
+                    metric_dict['previous_monitor_time'] = port_uptime\r
+                    # do first measurement\r
+                    #logging.info('first measurement')\r
+                    time.sleep(1)\r
+                    byte_rate = self.get_network_metrics()\r
+                    return byte_rate\r
+                else:\r
+                    time_delta = (port_uptime - metric_dict['previous_monitor_time'])\r
+                    byte_rate = (this_measurement - metric_dict['previous_measurement']) / float(time_delta)\r
+                    # logging.info('uptime:{2} delta:{0} rate:{1}'.format(time_delta,byte_rate,port_uptime))\r
+\r
+                metric_dict['previous_measurement'] = this_measurement\r
+                metric_dict['previous_monitor_time'] = port_uptime\r
+                return byte_rate\r
+\r
+        logging.exception('metric {0} not found on {1}:{2}'.format(metric_key, vnf_name, vnf_interface))\r
+        return 'metric {0} not found on {1}:{2}'.format(metric_key, vnf_name, vnf_interface)\r
 \r
 \r
     def REST_cmd(self, prefix, dpid):\r
         url = self.REST_api + '/' + str(prefix) + '/' + str(dpid)\r
         req = urllib2.Request(url)\r
         ret = urllib2.urlopen(req).read()\r
-        return ret
\ No newline at end of file
+        return ret\r
+\r
+    def start_Prometheus(self, port=9090):\r
+        # prometheus.yml configuration file is located in the same directory as this file\r
+        cmd = ["docker",\r
+               "run",\r
+               "--rm",\r
+               "-p", "{0}:9090".format(port),\r
+               "-v", "{0}/prometheus.yml:/etc/prometheus/prometheus.yml".format(os.path.dirname(os.path.abspath(__file__))),\r
+               "--name", "prometheus",\r
+               "prom/prometheus"\r
+               ]\r
+        logging.info('Start Prometheus container {0}'.format(cmd))\r
+        return Popen(cmd)\r
+\r
+    def start_cadvisor(self, port=8090):\r
+        cmd = ["docker",\r
+               "run",\r
+               "--rm",\r
+               "--volume=/:/rootfs:ro",\r
+               "--volume=/var/run:/var/run:rw",\r
+               "--volume=/sys:/sys:ro",\r
+               "--volume=/var/lib/docker/:/var/lib/docker:ro",\r
+               "--publish={0}:8080".format(port),\r
+               "--name=cadvisor",\r
+               "google/cadvisor:latest"\r
+               ]\r
+        logging.info('Start cAdvisor container {0}'.format(cmd))\r
+        return Popen(cmd)\r
+\r
+    def stop(self):\r
+        # stop the monitoring thread\r
+        self.start_monitoring = False\r
+        self.monitor_thread.join()\r
+\r
+        if self.prometheus_process is not None:\r
+            logging.info('stopping prometheus container')\r
+            self.prometheus_process.terminate()\r
+            self.prometheus_process.kill()\r
+            self._stop_container('prometheus')\r
+\r
+        if self.cadvisor_process is not None:\r
+            logging.info('stopping cadvisor container')\r
+            self.cadvisor_process.terminate()\r
+            self.cadvisor_process.kill()\r
+            self._stop_container('cadvisor')\r
+\r
+    def switch_tx_rx(self,metric=''):\r
+        # when monitoring vnfs, the tx of the datacenter switch is actually the rx of the vnf\r
+        # so we need to change the metric name to be consistent with the vnf rx or tx\r
+        if 'tx' in metric:\r
+            metric = metric.replace('tx','rx')\r
+        elif 'rx' in metric:\r
+            metric = metric.replace('rx','tx')\r
+\r
+        return metric\r
+\r
+    def _stop_container(self, name):\r
+        cmd = ["docker",\r
+               "stop",\r
+               name]\r
+        Popen(cmd).wait()\r
+\r
+        cmd = ["docker",\r
+               "rm",\r
+               name]\r
+        Popen(cmd).wait()\r
+\r
+\r