add DHCP ip_pool_total metric, #99

Author: akpw

mktxp/collector/pool_collector.py

@@ -19,7 +19,7 @@
 
 class PoolCollector(BaseCollector):
     ''' IP Pool Metrics collector
-    '''    
+    '''
     @staticmethod
     def collect(router_entry):
         # ~*~*~*~*~*~ IPv4 ~*~*~*~*~*~
@@ -36,21 +36,60 @@ def _process_ip_stack(router_entry, ipv6=False):
         ip_stack = 'ipv6' if ipv6 else 'ipv4'
 
         # initialize all pool counts, including those currently not used
-        pool_records = PoolMetricsDataSource.metric_records(router_entry, metric_labels = ['name'], ipv6=ipv6)   
+        pool_records = PoolMetricsDataSource.metric_records(router_entry, metric_labels = ['name', 'ranges', 'total'], ipv6=ipv6)
         if pool_records:
             pool_used_labels = ['pool']
             pool_used_counts = {pool_record['name']: 0 for pool_record in pool_records}
+            pool_size_counts = {pool_record['name']: int(pool_record.get('total', PoolCollector._calculate_pool_size(pool_record.get('ranges', '')))) for pool_record in pool_records}
 
             # for pools in usage, calculate the current numbers
-            pool_used_records = PoolUsedMetricsDataSource.metric_records(router_entry, metric_labels = pool_used_labels, ipv6=ipv6)   
+            pool_used_records = PoolUsedMetricsDataSource.metric_records(router_entry, metric_labels = pool_used_labels, ipv6=ipv6)
             for pool_used_record in pool_used_records:
                 pool_used_counts[pool_used_record['pool']] = pool_used_counts.get(pool_used_record['pool'], 0) + 1
 
            # compile used-per-pool records
             used_per_pool_records = [{ MKTXPConfigKeys.ROUTERBOARD_NAME: router_entry.router_id[MKTXPConfigKeys.ROUTERBOARD_NAME],
                                        MKTXPConfigKeys.ROUTERBOARD_ADDRESS: router_entry.router_id[MKTXPConfigKeys.ROUTERBOARD_ADDRESS],
                                        'pool': key, 'count': value} for key, value in pool_used_counts.items()]
-            
+
             # yield used-per-pool metrics
             used_per_pool_metrics = BaseCollector.gauge_collector(f'ip_pool_used{"_ipv6" if ipv6 else ""}', f'Number of used addresses per IP pool ({ip_stack.upper()})', used_per_pool_records, 'count', ['pool'])
             yield used_per_pool_metrics
+
+            # compile total-per-pool records
+            total_per_pool_records = [{ MKTXPConfigKeys.ROUTERBOARD_NAME: router_entry.router_id[MKTXPConfigKeys.ROUTERBOARD_NAME],
+                                       MKTXPConfigKeys.ROUTERBOARD_ADDRESS: router_entry.router_id[MKTXPConfigKeys.ROUTERBOARD_ADDRESS],
+                                       'pool': key, 'count': value} for key, value in pool_size_counts.items()]
+
+            # yield total-per-pool metrics
+            total_per_pool_metrics = BaseCollector.gauge_collector(f'ip_pool_total{"_ipv6" if ipv6 else ""}', f'Total capacity of IP pool ({ip_stack.upper()})', total_per_pool_records, 'count', ['pool'])
+            yield total_per_pool_metrics
+
+    @staticmethod
+    def _calculate_pool_size(ranges_str):
+        import ipaddress
+        total = 0
+        if not ranges_str:
+            return total
+        for r in ranges_str.split(','):
+            r = r.strip()
+            if not r:
+                continue
+            if '-' in r:
+                start, end = r.split('-', 1)
+                try:
+                    total += int(ipaddress.ip_address(end.strip())) - int(ipaddress.ip_address(start.strip())) + 1
+                except Exception:
+                    pass
+            elif '/' in r:
+                try:
+                    total += ipaddress.ip_network(r, strict=False).num_addresses
+                except Exception:
+                    pass
+            else:
+                try:
+                    ipaddress.ip_address(r)
+                    total += 1
+                except Exception:
+                    pass
+        return total

mktxp/datasource/pool_ds.py

@@ -17,12 +17,12 @@
 
 class PoolMetricsDataSource:
     ''' Pool Metrics data provider
-    '''             
+    '''
     @staticmethod
     def metric_records(router_entry, *, metric_labels = None, ipv6 = False):
         ip_stack = 'ipv6' if ipv6 else 'ip'
         if metric_labels is None:
-            metric_labels = []                
+            metric_labels = []
         try:
             pool_records = router_entry.api_connection.router_api().get_resource(f'/{ip_stack}/pool').get()
             return BaseDSProcessor.trimmed_records(router_entry, router_records = pool_records, metric_labels = metric_labels)
@@ -33,12 +33,12 @@ def metric_records(router_entry, *, metric_labels = None, ipv6 = False):
 
 class PoolUsedMetricsDataSource:
     ''' Pool/Used Metrics data provider
-    '''             
+    '''
     @staticmethod
     def metric_records(router_entry, *, metric_labels = None, ipv6 = False):
         ip_stack = 'ipv6' if ipv6 else 'ip'
         if metric_labels is None:
-            metric_labels = []                
+            metric_labels = []
         try:
             pool_used_records = router_entry.api_connection.router_api().get_resource(f'/{ip_stack}/pool/used').get()
             return BaseDSProcessor.trimmed_records(router_entry, router_records = pool_used_records, metric_labels = metric_labels)

tests/collector/test_pool_collector.py

@@ -0,0 +1,28 @@
+import pytest
+from mktxp.collector.pool_collector import PoolCollector
+
+def test_calculate_pool_size_empty():
+    assert PoolCollector._calculate_pool_size('') == 0
+    assert PoolCollector._calculate_pool_size(None) == 0
+
+def test_calculate_pool_size_single_range():
+    # 10.20.10.10 to 10.20.10.254 is exactly 245 IPs
+    assert PoolCollector._calculate_pool_size('10.20.10.10-10.20.10.254') == 245
+
+def test_calculate_pool_size_multiple_ranges():
+    assert PoolCollector._calculate_pool_size('192.168.1.10-192.168.1.19, 192.168.1.100-192.168.1.109') == 20
+
+def test_calculate_pool_size_cidr_ipv4():
+    # /24 has 256 addresses
+    assert PoolCollector._calculate_pool_size('192.168.1.0/24') == 256
+
+def test_calculate_pool_size_cidr_ipv6():
+    # /127 has 2 addresses
+    assert PoolCollector._calculate_pool_size('2001:db8::/127') == 2
+
+def test_calculate_pool_size_single_ip():
+    assert PoolCollector._calculate_pool_size('192.168.1.100') == 1
+
+def test_calculate_pool_size_invalid_input():
+    # Should ignore invalid chunks safely
+    assert PoolCollector._calculate_pool_size('192.168.1.10-192.168.1.20, invalid-range') == 11