Initial commit

mktxp/router_metric.py

@@ -0,0 +1,133 @@
+# coding=utf8
+## Copyright (c) 2020 Arseniy Kuznetsov
+##
+## This program is free software; you can redistribute it and/or
+## modify it under the terms of the GNU General Public License
+## as published by the Free Software Foundation; either version 2
+## of the License, or (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+
+
+from mktxp.cli.config.config import config_handler, MKTXPConfigKeys
+from mktxp.router_connection import RouterAPIConnection
+
+class RouterMetric:
+    ''' RouterOS Metrics data provider
+    '''             
+    def __init__(self, router_name):
+        self.router_name = router_name
+        self.router_entry  = config_handler.entry(router_name)
+        self.api_connection = RouterAPIConnection(router_name, self.router_entry)
+        self.router_id = {
+            MKTXPConfigKeys.ROUTERBOARD_NAME: self.router_name,
+            MKTXPConfigKeys.ROUTERBOARD_ADDRESS: self.router_entry.hostname
+            }
+
+    def identity_records(self, identity_labels = []):
+        try:
+            identity_records = self.api_connection.router_api().get_resource('/system/identity').get()
+            return self._trimmed_records(identity_records, identity_labels)
+        except Exception as exc:
+            print(f'Error getting system identity info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def routerboard_records(self, routerboard_labels = []):
+        try:
+            routerboard_records = self.api_connection.router_api().get_resource('/system/routerboard').get()
+            return self._trimmed_records(routerboard_records, routerboard_labels)
+        except Exception as exc:
+            print(f'Error getting system routerboard info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def health_records(self, health_labels = []):
+        try:
+            health_records = self.api_connection.router_api().get_resource('/system/health').get()
+            return self._trimmed_records(health_records, health_labels)
+        except Exception as exc:
+            print(f'Error getting system health info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def system_resource_records(self, resource_labels = []):
+        try:
+            system_resource_records = self.api_connection.router_api().get_resource('/system/resource').get()
+            return self._trimmed_records(system_resource_records, resource_labels)
+        except Exception as exc:
+            print(f'Error getting system resource info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def dhcp_lease_records(self, dhcp_lease_labels = []):
+        try:
+            #dhcp_lease_records = self.api_connection.router_api().get_resource('/ip/dhcp-server/lease').get(status='bound')
+            dhcp_lease_records = self.api_connection.router_api().get_resource('/ip/dhcp-server/lease').call('print', {'active':''})
+            return self._trimmed_records(dhcp_lease_records, dhcp_lease_labels)
+        except Exception as exc:
+            print(f'Error getting dhcp info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def interface_traffic_records(self, interface_traffic_labels = []):
+        try:
+            traffic_records = self.api_connection.router_api().get_resource('/interface').get(running='yes', disabled='no')
+            return self._trimmed_records(traffic_records, interface_traffic_labels)
+        except Exception as exc:
+            print(f'Error getting interface traffic info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def interface_monitor_records(self, interface_monitor_labels = [], kind = 'ethernet'):
+        try:
+            interfaces = self.api_connection.router_api().get_resource(f'/interface/{kind}').get()
+            interface_names = [interface['name'] for interface in interfaces]
+
+            interface_monitor = lambda int_num : self.api_connection.router_api().get_resource(f'/interface/{kind}').call('monitor', {'once':'', 'numbers':f'{int_num}'})
+            interface_monitor_records = [interface_monitor(int_num)[0] for int_num in range(len(interface_names))]
+            return self._trimmed_records(interface_monitor_records, interface_monitor_labels)
+        except Exception as exc:
+            print(f'Error getting {kind} interface monitor info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def pool_records(self, pool_labels = []):
+        try:
+            pool_records = self.api_connection.router_api().get_resource('/ip/pool').get()
+            return self._trimmed_records(pool_records, pool_labels)
+        except Exception as exc:
+            print(f'Error getting pool info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def pool_used_records(self, pool_used_labels = []):
+        try:
+            pool_used_records = self.api_connection.router_api().get_resource('/ip/pool/used').get()
+            return self._trimmed_records(pool_used_records, pool_used_labels)
+        except Exception as exc:
+            print(f'Error getting pool used info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+    def route_records(self, route_labels = []):
+        try:
+            route_records = self.api_connection.router_api().get_resource('/ip/route').get(active='yes')
+            return self._trimmed_records(route_records, route_labels)
+        except Exception as exc:
+            print(f'Error getting pool active routes info from router{self.router_name}@{self.router_entry.hostname}: {exc}')
+            return None
+
+
+    # Helpers
+    def _trimmed_records(self, router_records, metric_labels):
+        if len(metric_labels) == 0 and len(router_records) > 0:
+            metric_labels = router_records[0].keys()
+        metric_labels = set(metric_labels)      
+
+        labeled_records = []
+        dash2_ = lambda x : x.replace('-', '_')
+        for router_record in router_records:
+            translated_record = {dash2_(key): value for (key, value) in router_record.items() if dash2_(key) in metric_labels}
+            for key, value in self.router_id.items():
+                translated_record[key] = value
+            labeled_records.append(translated_record)
+        return labeled_records
+
+
+
+