Merge pull request #259 from ivanpavlina/main

Pull container statistics

Author: akpw

README.md

@@ -125,6 +125,8 @@ The default configuration file comes with a sample configuration, making it easy
     routing_stats = False           # Routing process stats
     certificate = False             # Certificates metrics
     
+    container = False               # Containers metrics
+    
     remote_dhcp_entry = None        # An MKTXP entry to provide for remote DHCP info / resolution
     remote_capsman_entry = None     # An MKTXP entry to provide for remote capsman info 
 

mktxp/cli/config/config.py

@@ -58,6 +58,7 @@ class CollectorKeys:
     SWITCH_PORT_COLLECTOR = 'SwitchPortCollector'
     MKTXP_COLLECTOR = 'MKTXPCollector'
     CERTIFICATE_COLLECTOR = 'CertificateCollector'
+    CONTAINER_COLLECTOR = "ContainerCollector"
 
 
 class MKTXPConfigKeys:
@@ -125,7 +126,9 @@ class MKTXPConfigKeys:
 
     FE_KID_CONTROL_DEVICE = 'kid_control_assigned'
     FE_KID_CONTROL_DYNAMIC = 'kid_control_dynamic'
-    
+
+    FE_CONTAINER_KEY = 'container'
+
     FE_CERTIFICATE_KEY = 'certificate'
     FE_ROUTING_STATS_KEY = 'routing_stats'
 
@@ -178,7 +181,7 @@ class MKTXPConfigKeys:
 
     BOOLEAN_KEYS_NO = {ENABLED_KEY, SSL_KEY, NO_SSL_CERTIFICATE, FE_CHECK_FOR_UPDATES, FE_KID_CONTROL_DEVICE, FE_KID_CONTROL_DYNAMIC,
                        SSL_CERTIFICATE_VERIFY, FE_IPV6_ROUTE_KEY, FE_IPV6_DHCP_POOL_KEY, FE_IPV6_FIREWALL_KEY, FE_IPV6_NEIGHBOR_KEY, FE_CONNECTION_STATS_KEY, FE_BFD_KEY, FE_BGP_KEY,
-                       FE_EOIP_KEY, FE_GRE_KEY, FE_IPIP_KEY, FE_IPSEC_KEY, FE_LTE_KEY, FE_SWITCH_PORT_KEY, FE_ROUTING_STATS_KEY, FE_CERTIFICATE_KEY, FE_DNS_KEY}
+                       FE_EOIP_KEY, FE_GRE_KEY, FE_IPIP_KEY, FE_IPSEC_KEY, FE_LTE_KEY, FE_SWITCH_PORT_KEY, FE_ROUTING_STATS_KEY, FE_CERTIFICATE_KEY, FE_DNS_KEY, FE_CONTAINER_KEY}
 
     # Feature keys enabled by default
     BOOLEAN_KEYS_YES = {PLAINTEXT_LOGIN_KEY, FE_DHCP_KEY, FE_HEALTH_KEY, FE_PACKAGE_KEY, FE_DHCP_LEASE_KEY, FE_IP_CONNECTIONS_KEY, FE_INTERFACE_KEY, 
@@ -212,7 +215,7 @@ class ConfigEntry:
                                                        MKTXPConfigKeys.FE_IPV6_ROUTE_KEY, MKTXPConfigKeys.FE_IPV6_DHCP_POOL_KEY, MKTXPConfigKeys.FE_IPV6_FIREWALL_KEY, MKTXPConfigKeys.FE_IPV6_NEIGHBOR_KEY,                                               
                                                        MKTXPConfigKeys.FE_USER_KEY, MKTXPConfigKeys.FE_QUEUE_KEY, MKTXPConfigKeys.FE_REMOTE_DHCP_ENTRY, MKTXPConfigKeys.FE_REMOTE_CAPSMAN_ENTRY, MKTXPConfigKeys.FE_CHECK_FOR_UPDATES, MKTXPConfigKeys.FE_BFD_KEY, MKTXPConfigKeys.FE_BGP_KEY,
                                                        MKTXPConfigKeys.FE_KID_CONTROL_DEVICE, MKTXPConfigKeys.FE_KID_CONTROL_DYNAMIC, MKTXPConfigKeys.FE_EOIP_KEY, MKTXPConfigKeys.FE_GRE_KEY, MKTXPConfigKeys.FE_IPIP_KEY, MKTXPConfigKeys.FE_LTE_KEY, MKTXPConfigKeys.FE_IPSEC_KEY, MKTXPConfigKeys.FE_SWITCH_PORT_KEY,
-                                                       MKTXPConfigKeys.FE_ROUTING_STATS_KEY, MKTXPConfigKeys.FE_CERTIFICATE_KEY
+                                                       MKTXPConfigKeys.FE_ROUTING_STATS_KEY, MKTXPConfigKeys.FE_CERTIFICATE_KEY, MKTXPConfigKeys.FE_CONTAINER_KEY
                                                        ])
     MKTXPSystemEntry = namedtuple('MKTXPSystemEntry', [MKTXPConfigKeys.PORT_KEY, MKTXPConfigKeys.LISTEN_KEY, MKTXPConfigKeys.MKTXP_SOCKET_TIMEOUT,
                                                        MKTXPConfigKeys.MKTXP_INITIAL_DELAY, MKTXPConfigKeys.MKTXP_MAX_DELAY,

mktxp/cli/config/mktxp.conf

@@ -79,6 +79,8 @@
     bgp = False                     # BGP sessions metrics
     routing_stats = False           # Routing process stats
     certificate = False             # Certificates metrics
+
+    container = False               # Containers metrics
 
     remote_dhcp_entry = None        # An MKTXP entry to provide for remote DHCP info / resolution
     remote_capsman_entry = None     # An MKTXP entry to provide for remote capsman info 

mktxp/collector/container_collector.py

@@ -0,0 +1,29 @@
+# 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.collector.base_collector import BaseCollector
+from mktxp.datasource.container_ds import ContainerDataSource
+from mktxp.datasource.package_ds import PackageMetricsDataSource
+
+
+class ContainerCollector(BaseCollector):
+    '''Neighbor Collector'''
+
+    @staticmethod
+    def collect(router_entry):
+        if router_entry.config_entry.container and PackageMetricsDataSource.is_package_installed(router_entry, package_name='container'):
+            metric_labels = ['name', 'repo', 'os', 'arch', 'status']
+            records = ContainerDataSource.metric_records(router_entry, metric_labels=metric_labels)
+            metrics = BaseCollector.info_collector('container', 'Containers', records, metric_labels=metric_labels)
+            yield metrics

mktxp/datasource/container_ds.py

@@ -0,0 +1,33 @@
+# 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.datasource.base_ds import BaseDSProcessor
+
+
+class ContainerDataSource:
+    @staticmethod
+    def metric_records(router_entry, metric_labels):
+        
+        metric_labels = metric_labels or []                        
+        router_records = []        
+        
+        try:
+            router_records = router_entry.api_connection.router_api().get_resource(f'/container').get()
+            for record in router_records:
+                if 'comment' in record:
+                    record['name'] = record['comment']
+            return BaseDSProcessor.trimmed_records(router_entry, router_records=router_records, metric_labels=metric_labels)
+        except Exception as exc:
+            print(f'Error getting Neighbors info from router {router_entry.router_name}@{router_entry.config_entry.hostname}: {exc}')
+            return None

mktxp/flow/collector_handler.py

@@ -130,7 +130,7 @@ def _valid_collect_interval(self):
         diff = now - self.last_collect_timestamp
         if diff < config_handler.system_entry.minimal_collect_interval:
             if config_handler.system_entry.verbose_mode:
-                print(f'An attemp to collect metrics within minimal metrics collection interval: {diff} < {config_handler.system_entry.minimal_collect_interval}')
+                print(f'An attempt to collect metrics within minimal metrics collection interval: {diff} < {config_handler.system_entry.minimal_collect_interval}')
                 print('deferring..')
             return False
 

mktxp/flow/collector_registry.py

@@ -48,6 +48,7 @@
 from mktxp.collector.switch_collector import SwitchPortCollector
 from mktxp.collector.certificate_collector import CertificateCollector
 from mktxp.collector.dns_collector import DNSCollector
+from mktxp.collector.container_collector import ContainerCollector
 
 class CollectorRegistry:
     ''' MKTXP Collectors Registry
@@ -95,6 +96,8 @@ def __init__(self):
         self.register(CollectorKeys.LTE_COLLECTOR, LTECollector.collect)
         self.register(CollectorKeys.SWITCH_PORT_COLLECTOR, SwitchPortCollector.collect)
 
+        self.register(CollectorKeys.CONTAINER_COLLECTOR, ContainerCollector.collect)
+
         self.register(CollectorKeys.ROUTING_STATS_COLLECTOR, RoutingStatsCollector.collect)
         self.register(CollectorKeys.CERTIFICATE_COLLECTOR, CertificateCollector.collect)
 

mktxp/flow/router_entry.py

@@ -82,7 +82,8 @@ def __init__(self, router_name):
                             CollectorKeys.LTE_COLLECTOR: 0,
                             CollectorKeys.SWITCH_PORT_COLLECTOR: 0,
                             CollectorKeys.MKTXP_COLLECTOR: 0,
-                            CollectorKeys.CERTIFICATE_COLLECTOR: 0
+                            CollectorKeys.CERTIFICATE_COLLECTOR: 0,
+                            CollectorKeys.CONTAINER_COLLECTOR: 0
                             }         
         self._dhcp_entry = None        
         self._dhcp_records = {}