finish #306 routerboard inventory collector

akpw · akpw · commit 18a6d32e462c · 2026-05-10T16:10:20.000+01:00
diff --git a/README.md b/README.md
@@ -83,6 +83,7 @@ The default configuration file comes with a sample configuration, making it easy
     ssl_ca_file = ""                # path to the certificate authority file to validate against, leave empty to use system store
     plaintext_login = True          # for legacy RouterOS versions below 6.43 use False
 
+    routerboard = False             # RouterBOARD inventory / firmware metrics
     health = True                   # System Health metrics
     installed_packages = True       # Installed packages
     dhcp = True                     # DHCP general metrics
@@ -531,6 +532,20 @@ Let's go check on that in the dashboard, or just get the info right from the com
 ```
 *A few quick checks show all of the destination IPs relate to AWS instances, so supposedly it's legit... but let's remain vigilant, to know better :)*
 
+### RouterBOARD inventory and firmware
+RouterBOARD inventory and firmware status can be exported with:
+
+```
+routerboard = False             # RouterBOARD inventory / firmware metrics
+```
+
+This enables:
+
+- `mktxp_routerboard_info`
+- `mktxp_routerboard_firmware_upgrade_available`
+
+The option is disabled by default. On devices without `/system/routerboard` support, enabling it may result in no data or scrape errors.
+
 
 ### Parallel routers fetch
 Concurrent exports across multiple devices can considerably speed up things for slow network connections. This feature can be turned on and configured with the following [system options](https://github.com/akpw/mktxp/blob/main/README.md#mktxp-system-configuration):
diff --git a/deploy/kubernetes/secret.yaml b/deploy/kubernetes/secret.yaml
@@ -90,6 +90,7 @@ stringData:
             connection_stats_destinations = False   # Set to True to track individual destination IPs/ports (Warning: High Cardinality)
 
             interface = True                # Interfaces traffic metrics
+            routerboard = False             # RouterBOARD inventory / firmware metrics
             wireguard_peers = False         # Wireguard peers metrics
             bridge_vlan = False             # Bridge VLAN metrics
 
diff --git a/mktxp/cli/config/config.py b/mktxp/cli/config/config.py
@@ -27,6 +27,7 @@
 class CollectorKeys:
     IDENTITY_COLLECTOR = 'IdentityCollector'
     SYSTEM_RESOURCE_COLLECTOR = 'SystemResourceCollector'
+    ROUTERBOARD_COLLECTOR = 'RouterboardCollector'
     HEALTH_COLLECTOR = 'HealthCollector'
     PUBLIC_IP_ADDRESS_COLLECTOR = 'PublicIPAddressCollector'
     NEIGHBOR_COLLECTOR = 'NeighborCollector'
@@ -84,6 +85,7 @@ class MKTXPConfigKeys:
     SSL_CA_FILE = 'ssl_ca_file'
     PLAINTEXT_LOGIN_KEY = 'plaintext_login'
 
+    FE_ROUTERBOARD_KEY = 'routerboard'
     FE_HEALTH_KEY = 'health'
     FE_PACKAGE_KEY = 'installed_packages'
     FE_DHCP_KEY = 'dhcp'
@@ -213,8 +215,8 @@ class MKTXPConfigKeys:
     DEFAULT_MKTXP_PROBE_CONNECTION_POOL_MAX_SIZE = 128
 
 
-    BOOLEAN_KEYS_NO = {ENABLED_KEY, SSL_KEY, NO_SSL_CERTIFICATE, FE_CHECK_FOR_UPDATES, FE_KID_CONTROL_DEVICE, FE_KID_CONTROL_DYNAMIC,FE_WG_PEER_KEY,
-                       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_CONNECTION_STATS_DESTINATIONS_KEY, FE_BFD_KEY, FE_BGP_KEY,
+    BOOLEAN_KEYS_NO = {ENABLED_KEY, SSL_KEY, NO_SSL_CERTIFICATE, FE_CHECK_FOR_UPDATES, FE_KID_CONTROL_DEVICE, FE_KID_CONTROL_DYNAMIC, FE_WG_PEER_KEY,
+                       FE_ROUTERBOARD_KEY, 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_CONNECTION_STATS_DESTINATIONS_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_CONTAINER_KEY, FE_W60G_KEY, FE_MODULE_ONLY_KEY, FE_BRIDGE_VLAN_KEY}
 
     # Feature keys enabled by default
@@ -247,7 +249,7 @@ class ConfigEntry:
     MKTXPConfigEntry = namedtuple('MKTXPConfigEntry', [MKTXPConfigKeys.ENABLED_KEY, MKTXPConfigKeys.HOST_KEY, MKTXPConfigKeys.PORT_KEY,
                                                        MKTXPConfigKeys.USER_KEY, MKTXPConfigKeys.PASSWD_KEY, MKTXPConfigKeys.CREDENTIALS_FILE_KEY,
                                                        MKTXPConfigKeys.SSL_KEY, MKTXPConfigKeys.NO_SSL_CERTIFICATE, MKTXPConfigKeys.SSL_CERTIFICATE_VERIFY, MKTXPConfigKeys.SSL_CHECK_HOSTNAME, MKTXPConfigKeys.SSL_CA_FILE, MKTXPConfigKeys.PLAINTEXT_LOGIN_KEY,
-                                                       MKTXPConfigKeys.FE_DHCP_KEY, MKTXPConfigKeys.FE_HEALTH_KEY, MKTXPConfigKeys.FE_PACKAGE_KEY, MKTXPConfigKeys.FE_DHCP_LEASE_KEY, MKTXPConfigKeys.FE_INTERFACE_KEY,MKTXPConfigKeys.FE_WG_PEER_KEY,
+                                                       MKTXPConfigKeys.FE_DHCP_KEY, MKTXPConfigKeys.FE_ROUTERBOARD_KEY, MKTXPConfigKeys.FE_HEALTH_KEY, MKTXPConfigKeys.FE_PACKAGE_KEY, MKTXPConfigKeys.FE_DHCP_LEASE_KEY, MKTXPConfigKeys.FE_INTERFACE_KEY, MKTXPConfigKeys.FE_WG_PEER_KEY,
                                                        MKTXPConfigKeys.FE_MONITOR_KEY, MKTXPConfigKeys.FE_W60G_KEY, MKTXPConfigKeys.FE_WIRELESS_KEY, MKTXPConfigKeys.FE_WIRELESS_CLIENTS_KEY,
                                                        MKTXPConfigKeys.FE_IP_CONNECTIONS_KEY, MKTXPConfigKeys.FE_CONNECTION_STATS_KEY, MKTXPConfigKeys.FE_CONNECTION_STATS_DESTINATIONS_KEY, MKTXPConfigKeys.FE_CAPSMAN_KEY, MKTXPConfigKeys.FE_CAPSMAN_CLIENTS_KEY, MKTXPConfigKeys.FE_POE_KEY,
                                                        MKTXPConfigKeys.FE_NETWATCH_KEY, MKTXPConfigKeys.FE_INTERFACE_NAME_FORMAT, MKTXPConfigKeys.FE_PUBLIC_IP_KEY,
diff --git a/mktxp/cli/config/mktxp.conf b/mktxp/cli/config/mktxp.conf
@@ -46,6 +46,7 @@
     connection_stats_destinations = False   # Set to True to track individual destination IPs/ports (Warning: High Cardinality)
 
     interface = True                # Interfaces traffic metrics
+    routerboard = False             # RouterBOARD inventory / firmware metrics
     wireguard_peers = False         # Wireguard peers metrics
     bridge_vlan = False             # Bridge VLAN metrics
 
diff --git a/mktxp/collector/routerboard_collector.py b/mktxp/collector/routerboard_collector.py
@@ -0,0 +1,58 @@
+# 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.routerboard_ds import RouterboardMetricsDataSource
+
+
+class RouterboardCollector(BaseCollector):
+    """RouterBOARD inventory + firmware metrics collector"""
+
+    @staticmethod
+    def collect(router_entry):
+        if not router_entry.config_entry.routerboard:
+            return
+        
+        rb_labels = [
+            "routerboard",
+            "model",
+            "serial_number",
+            "firmware_type",
+            "factory_firmware",
+            "current_firmware",
+            "upgrade_firmware",
+        ]
+
+        rb_records = RouterboardMetricsDataSource.metric_records(router_entry, metric_labels=rb_labels)
+        if not rb_records:
+            return
+
+        yield BaseCollector.info_collector(
+            "routerboard",
+            "RouterBOARD inventory and firmware information",
+            rb_records,
+            rb_labels,
+        )
+
+        for r in rb_records:
+            cur = r.get("current_firmware")
+            upg = r.get("upgrade_firmware")
+            r["firmware_upgrade_available"] = 1 if (cur and upg and cur != upg) else 0
+
+        yield BaseCollector.gauge_collector(
+            "routerboard_firmware_upgrade_available",
+            "Whether RouterBOARD firmware upgrade is available (current_firmware != upgrade_firmware)",
+            rb_records,
+            "firmware_upgrade_available",
+            ["current_firmware", "upgrade_firmware"],
+        )
diff --git a/mktxp/flow/collector_registry.py b/mktxp/flow/collector_registry.py
@@ -53,6 +53,7 @@
 from mktxp.collector.certificate_collector import CertificateCollector
 from mktxp.collector.dns_collector import DNSCollector
 from mktxp.collector.container_collector import ContainerCollector
+from mktxp.collector.routerboard_collector import RouterboardCollector
 
 class CollectorRegistry:
     ''' MKTXP Collectors Registry
@@ -65,6 +66,7 @@ def __init__(self):
 
         self.register(CollectorKeys.IDENTITY_COLLECTOR, IdentityCollector.collect)
         self.register(CollectorKeys.SYSTEM_RESOURCE_COLLECTOR, SystemResourceCollector.collect)
+        self.register(CollectorKeys.ROUTERBOARD_COLLECTOR, RouterboardCollector.collect)
         self.register(CollectorKeys.HEALTH_COLLECTOR, HealthCollector.collect)
         self.register(CollectorKeys.PUBLIC_IP_ADDRESS_COLLECTOR, PublicIPAddressCollector.collect)
 
diff --git a/mktxp/flow/router_entry.py b/mktxp/flow/router_entry.py
@@ -52,6 +52,7 @@ def __init__(self, router_name):
 
         self.time_spent =  { CollectorKeys.IDENTITY_COLLECTOR: 0,
                             CollectorKeys.SYSTEM_RESOURCE_COLLECTOR: 0,
+                            CollectorKeys.ROUTERBOARD_COLLECTOR: 0,
                             CollectorKeys.HEALTH_COLLECTOR: 0,
                             CollectorKeys.PUBLIC_IP_ADDRESS_COLLECTOR: 0,
                             CollectorKeys.NEIGHBOR_COLLECTOR: 0,
diff --git a/tests/cli/config/test_config.py b/tests/cli/config/test_config.py
@@ -161,3 +161,7 @@ def test_system_config_key_in_new_section(tmpdir):
 def test_wireguard_peer_key_registration():
     assert MKTXPConfigKeys.FE_WG_PEER_KEY == 'wireguard_peers'
     assert MKTXPConfigKeys.FE_WG_PEER_KEY in MKTXPConfigKeys.BOOLEAN_KEYS_NO
+
+def test_routerboard_key_registration():
+    assert MKTXPConfigKeys.FE_ROUTERBOARD_KEY == 'routerboard'
+    assert MKTXPConfigKeys.FE_ROUTERBOARD_KEY in MKTXPConfigKeys.BOOLEAN_KEYS_NO
diff --git a/tests/collector/test_routerboard_collector.py b/tests/collector/test_routerboard_collector.py
@@ -0,0 +1,66 @@
+# 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 unittest.mock import Mock, patch
+
+from mktxp.collector.routerboard_collector import RouterboardCollector
+
+
+def test_routerboard_collector_yields_inventory_and_upgrade_metrics():
+    mock_router_entry = Mock()
+    mock_router_entry.config_entry.routerboard = True
+
+    mock_records = [{
+        'routerboard': 'true',
+        'model': 'RB5009',
+        'serial_number': 'ABC123',
+        'firmware_type': 'routerboot',
+        'factory_firmware': '7.12',
+        'current_firmware': '7.14',
+        'upgrade_firmware': '7.16',
+    }]
+
+    with patch('mktxp.collector.routerboard_collector.RouterboardMetricsDataSource.metric_records') as mock_ds, \
+         patch('mktxp.collector.base_collector.BaseCollector.info_collector') as mock_info, \
+         patch('mktxp.collector.base_collector.BaseCollector.gauge_collector') as mock_gauge:
+        mock_ds.return_value = mock_records
+        mock_info.return_value = 'routerboard-info'
+        mock_gauge.return_value = 'routerboard-upgrade'
+
+        results = list(RouterboardCollector.collect(mock_router_entry))
+
+    mock_ds.assert_called_once_with(
+        mock_router_entry,
+        metric_labels=[
+            'routerboard',
+            'model',
+            'serial_number',
+            'firmware_type',
+            'factory_firmware',
+            'current_firmware',
+            'upgrade_firmware',
+        ]
+    )
+    assert mock_records[0]['firmware_upgrade_available'] == 1
+    assert results == ['routerboard-info', 'routerboard-upgrade']
+
+
+def test_routerboard_collector_skips_when_disabled():
+    mock_router_entry = Mock()
+    mock_router_entry.config_entry.routerboard = False
+
+    with patch('mktxp.collector.routerboard_collector.RouterboardMetricsDataSource.metric_records') as mock_ds:
+        results = list(RouterboardCollector.collect(mock_router_entry))
+
+    mock_ds.assert_not_called()
+    assert results == []
