From 70e5a64469f542f30d81260ec876b2f6dc5a79dc Mon Sep 17 00:00:00 2001 From: Leon Morten Richter Date: Sun, 13 Nov 2022 13:36:58 +0100 Subject: [PATCH] add IPv6 reachable addresses --- mktxp/cli/config/config.py | 5 +-- mktxp/cli/config/mktxp.conf | 1 + mktxp/collector/ipv6_neighbor_collector.py | 40 ++++++++++++++++++++++ mktxp/datasource/ipv6_neighbor_ds.py | 23 +++++++++++++ mktxp/flow/collector_registry.py | 3 ++ mktxp/flow/router_entry.py | 1 + 6 files changed, 71 insertions(+), 2 deletions(-) create mode 100644 mktxp/collector/ipv6_neighbor_collector.py create mode 100644 mktxp/datasource/ipv6_neighbor_ds.py diff --git a/mktxp/cli/config/config.py b/mktxp/cli/config/config.py index dfa1ddf..e316807 100755 --- a/mktxp/cli/config/config.py +++ b/mktxp/cli/config/config.py @@ -50,6 +50,7 @@ class MKTXPConfigKeys: FE_CAPSMAN_CLIENTS_KEY = 'capsman_clients' FE_POE_KEY = 'poe' FE_PUBLIC_IP_KEY = 'public_ip' + FE_IPV6_NEIGHBOR_KEY = 'ipv6_neighbor' FE_NETWATCH_KEY = 'netwatch' MKTXP_SOCKET_TIMEOUT = 'socket_timeout' @@ -86,7 +87,7 @@ class MKTXPConfigKeys: BOOLEAN_KEYS_YES = {FE_DHCP_KEY, FE_DHCP_LEASE_KEY, FE_DHCP_POOL_KEY, FE_IP_CONNECTIONS_KEY, FE_INTERFACE_KEY, FE_FIREWALL_KEY, FE_MONITOR_KEY, FE_ROUTE_KEY, MKTXP_USE_COMMENTS_OVER_NAMES, FE_WIRELESS_KEY, FE_WIRELESS_CLIENTS_KEY, FE_CAPSMAN_KEY, FE_CAPSMAN_CLIENTS_KEY, FE_POE_KEY, - FE_NETWATCH_KEY, FE_PUBLIC_IP_KEY} + FE_NETWATCH_KEY, FE_PUBLIC_IP_KEY, FE_IPV6_NEIGHBOR_KEY} SYSTEM_BOOLEAN_KEYS_YES = {MKTXP_BANDWIDTH_KEY} SYSTEM_BOOLEAN_KEYS_NO = {MKTXP_VERBOSE_MODE} @@ -106,7 +107,7 @@ class ConfigEntry: MKTXPConfigKeys.FE_DHCP_KEY, MKTXPConfigKeys.FE_DHCP_LEASE_KEY, MKTXPConfigKeys.FE_DHCP_POOL_KEY, MKTXPConfigKeys.FE_INTERFACE_KEY, MKTXPConfigKeys.FE_FIREWALL_KEY, MKTXPConfigKeys.FE_MONITOR_KEY, MKTXPConfigKeys.FE_ROUTE_KEY, MKTXPConfigKeys.FE_WIRELESS_KEY, MKTXPConfigKeys.FE_WIRELESS_CLIENTS_KEY, MKTXPConfigKeys.FE_IP_CONNECTIONS_KEY, MKTXPConfigKeys.FE_CAPSMAN_KEY, MKTXPConfigKeys.FE_CAPSMAN_CLIENTS_KEY, MKTXPConfigKeys.FE_POE_KEY, MKTXPConfigKeys.FE_NETWATCH_KEY, MKTXPConfigKeys.MKTXP_USE_COMMENTS_OVER_NAMES, - MKTXPConfigKeys.FE_PUBLIC_IP_KEY, + MKTXPConfigKeys.FE_PUBLIC_IP_KEY, MKTXPConfigKeys.FE_IPV6_NEIGHBOR_KEY ]) MKTXPSystemEntry = namedtuple('MKTXPSystemEntry', [MKTXPConfigKeys.PORT_KEY, MKTXPConfigKeys.MKTXP_SOCKET_TIMEOUT, MKTXPConfigKeys.MKTXP_INITIAL_DELAY, MKTXPConfigKeys.MKTXP_MAX_DELAY, diff --git a/mktxp/cli/config/mktxp.conf b/mktxp/cli/config/mktxp.conf index f8501d3..1f768d6 100644 --- a/mktxp/cli/config/mktxp.conf +++ b/mktxp/cli/config/mktxp.conf @@ -33,6 +33,7 @@ monitor = True # Interface monitor metrics poe = True # POE metrics public_ip = True # Public IP metrics + ipv6_neighbor = False # Reachable IPv6 Neighbors route = True # Routes metrics wireless = True # WLAN general metrics wireless_clients = True # WLAN clients metrics diff --git a/mktxp/collector/ipv6_neighbor_collector.py b/mktxp/collector/ipv6_neighbor_collector.py new file mode 100644 index 0000000..3d1d729 --- /dev/null +++ b/mktxp/collector/ipv6_neighbor_collector.py @@ -0,0 +1,40 @@ +# 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.ipv6_neighbor_ds import IPv6NeighborDataSource + + +class IPv6NeighborCollector(BaseCollector): + '''IPv6 Neighbor Collector''' + @staticmethod + def collect(router_entry): + if not router_entry.config_entry.ipv6_neighbor: + return + + metric_labels = ['address', 'interface', 'mac_address', 'status'] + + records = IPv6NeighborDataSource.metric_records( + router_entry, + metric_labels=metric_labels + ) + + metrics = BaseCollector.gauge_collector( + 'ipv6_neighbor_info', + 'Reachable IPv6 neighbors', + records, + 'ipv6_neighbor', + metric_labels=metric_labels + ) + yield metrics diff --git a/mktxp/datasource/ipv6_neighbor_ds.py b/mktxp/datasource/ipv6_neighbor_ds.py new file mode 100644 index 0000000..1e764d0 --- /dev/null +++ b/mktxp/datasource/ipv6_neighbor_ds.py @@ -0,0 +1,23 @@ +# 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 IPv6NeighborDataSource: + + def metric_records(router_entry, metric_labels): + metric_labels = metric_labels or [] + records = router_entry.api_connection.router_api().get_resource('/ipv6/neighbor').get(status='reachable') + return BaseDSProcessor.trimmed_records(router_entry, router_records=records, metric_labels=metric_labels, ) diff --git a/mktxp/flow/collector_registry.py b/mktxp/flow/collector_registry.py index 41e9bdc..8f5ae75 100644 --- a/mktxp/flow/collector_registry.py +++ b/mktxp/flow/collector_registry.py @@ -19,6 +19,7 @@ from mktxp.collector.interface_collector import InterfaceCollector from mktxp.collector.health_collector import HealthCollector from mktxp.collector.identity_collector import IdentityCollector from mktxp.collector.public_ip_collector import PublicIPAddressCollector +from mktxp.collector.ipv6_neighbor_collector import IPv6NeighborCollector from mktxp.collector.monitor_collector import MonitorCollector from mktxp.collector.poe_collector import POECollector from mktxp.collector.netwatch_collector import NetwatchCollector @@ -46,6 +47,8 @@ class CollectorRegistry: self.register('HealthCollector', HealthCollector.collect) self.register('PublicIPAddressCollector', PublicIPAddressCollector.collect) + self.register('IPv6NeighborCollector', IPv6NeighborCollector.collect) + self.register('DHCPCollector', DHCPCollector.collect) self.register('IPConnectionCollector', IPConnectionCollector.collect) self.register('PoolCollector', PoolCollector.collect) diff --git a/mktxp/flow/router_entry.py b/mktxp/flow/router_entry.py index ac85741..051f048 100644 --- a/mktxp/flow/router_entry.py +++ b/mktxp/flow/router_entry.py @@ -31,6 +31,7 @@ class RouterEntry: 'SystemResourceCollector': 0, 'HealthCollector': 0, 'PublicIPAddressCollector': 0, + 'IPv6NeighborCollector': 0, 'DHCPCollector': 0, 'PoolCollector': 0, 'IPConnectionCollector': 0,