mirror of
https://github.com/KevinMidboe/mktxp-no-cli.git
synced 2025-10-29 09:40:23 +00:00
ca71399b96
`dhcp_name` is not sufficient to identify wireless clients. DHCP Host
Name Option (Code 12) is not required to be unique. As a result, it's
possible to have multiple metrics with exactly same labels. Adding
`mac_address` label to all wlan/capsman metrics allows to identify
the clients.
```
mktxp_wlan_clients_signal_strength{dhcp_name="xyz",routerboard_address="a.b.c.d",routerboard_name="foobar"} -63.0
mktxp_wlan_clients_signal_strength{dhcp_name="xyz",routerboard_address="a.b.c.d",routerboard_name="foobar"} -64.0
mktxp_wlan_clients_signal_strength{dhcp_name="xyz",routerboard_address="a.b.c.d",routerboard_name="foobar"} -65.0
```
vs.
```
mktxp_wlan_clients_signal_strength{dhcp_name="xyz",mac_address="11:22:33:44:55:AA",routerboard_address="a.b.c.d",routerboard_name="foobar"} -63.0
mktxp_wlan_clients_signal_strength{dhcp_name="xyz",mac_address="11:22:33:44:55:BB",routerboard_address="a.b.c.d",routerboard_name="foobar"} -64.0
mktxp_wlan_clients_signal_strength{dhcp_name="xyz",mac_address="11:22:33:44:55:CC",routerboard_address="a.b.c.d",routerboard_name="foobar"} -65.0
```
78 lines
4.8 KiB
Python
78 lines
4.8 KiB
Python
# 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 MKTXPConfigKeys
|
|
from mktxp.flow.processor.output import BaseOutputProcessor
|
|
from mktxp.collector.base_collector import BaseCollector
|
|
from mktxp.datasource.capsman_ds import CapsmanCapsMetricsDataSource, CapsmanRegistrationsMetricsDataSource, CapsmanInterfacesDatasource
|
|
from mktxp.datasource.wireless_ds import WirelessMetricsDataSource
|
|
|
|
|
|
class CapsmanCollector(BaseCollector):
|
|
''' CAPsMAN Metrics collector
|
|
'''
|
|
@staticmethod
|
|
def collect(router_entry):
|
|
if not router_entry.config_entry.capsman:
|
|
return
|
|
|
|
remote_caps_labels = ['identity', 'version', 'base_mac', 'board', 'base_mac']
|
|
remote_caps_records = CapsmanCapsMetricsDataSource.metric_records(router_entry, metric_labels = remote_caps_labels)
|
|
if remote_caps_records:
|
|
remote_caps_metrics = BaseCollector.info_collector('capsman_remote_caps', 'CAPsMAN remote caps', remote_caps_records, remote_caps_labels)
|
|
yield remote_caps_metrics
|
|
|
|
registration_labels = ['interface', 'ssid', 'mac_address', 'tx_rate', 'rx_rate', 'rx_signal', 'signal', 'uptime', 'bytes']
|
|
registration_records = CapsmanRegistrationsMetricsDataSource.metric_records(router_entry, metric_labels = registration_labels)
|
|
if registration_records:
|
|
# calculate number of registrations per interface
|
|
registration_per_interface = {}
|
|
for registration_record in registration_records:
|
|
registration_per_interface[registration_record['interface']] = registration_per_interface.get(registration_record['interface'], 0) + 1
|
|
# compile registrations-per-interface records
|
|
registration_per_interface_records = [{ MKTXPConfigKeys.ROUTERBOARD_NAME: router_entry.router_id[MKTXPConfigKeys.ROUTERBOARD_NAME],
|
|
MKTXPConfigKeys.ROUTERBOARD_ADDRESS: router_entry.router_id[MKTXPConfigKeys.ROUTERBOARD_ADDRESS],
|
|
'interface': key, 'count': value} for key, value in registration_per_interface.items()]
|
|
# yield registrations-per-interface metrics
|
|
registration_per_interface_metrics = BaseCollector.gauge_collector('capsman_registrations_count', 'Number of active registration per CAPsMAN interface', registration_per_interface_records, 'count', ['interface'])
|
|
yield registration_per_interface_metrics
|
|
|
|
# the client info metrics
|
|
if router_entry.config_entry.capsman_clients:
|
|
|
|
# translate / trim / augment registration records
|
|
for registration_record in registration_records:
|
|
BaseOutputProcessor.augment_record(router_entry, registration_record)
|
|
|
|
tx_byte_metrics = BaseCollector.counter_collector('capsman_clients_tx_bytes', 'Number of sent packet bytes', registration_records, 'tx_bytes', ['dhcp_name', 'mac_address'])
|
|
yield tx_byte_metrics
|
|
|
|
rx_byte_metrics = BaseCollector.counter_collector('capsman_clients_rx_bytes', 'Number of received packet bytes', registration_records, 'rx_bytes', ['dhcp_name', 'mac_address'])
|
|
yield rx_byte_metrics
|
|
|
|
signal_strength_metrics = BaseCollector.gauge_collector('capsman_clients_signal_strength', 'Client devices signal strength', registration_records, 'rx_signal', ['dhcp_name', 'mac_address'])
|
|
yield signal_strength_metrics
|
|
|
|
registration_metrics = BaseCollector.info_collector('capsman_clients_devices', 'Registered client devices info',
|
|
registration_records, ['dhcp_name', 'dhcp_address', 'rx_signal', 'ssid', 'tx_rate', 'rx_rate', 'interface', 'mac_address', 'uptime'])
|
|
yield registration_metrics
|
|
|
|
|
|
remote_cap_interface_labels = ['name', 'configuration', 'mac_address', 'current_state', 'current_channel', 'current_registered_clients']
|
|
remote_cap_interface_records = CapsmanInterfacesDatasource.metric_records(router_entry, metric_labels = remote_cap_interface_labels)
|
|
if remote_cap_interface_records:
|
|
remote_caps_metrics = BaseCollector.info_collector('capsman_interfaces', 'CAPsMAN interfaces', remote_cap_interface_records, remote_cap_interface_labels)
|
|
yield remote_caps_metrics
|
|
|