SNMP: drivers declare a health profile as data; deprecate HealthMetricsMixin #32

New Issue

2026-10-14T08:22:57Z

christianmanivong commented

2026-10-14 08:22:57 +00:00

HealthMetricsMixin (health_metrics.py) and _ucd_metrics.py collect CPU, memory, load and interface counters over SNMP. The collector is a classmethod that the application calls with its own snmp_get/snmp_walk; the driver is not even connected while it runs. It is mixed into five role bases, and four drivers (procurve, netgear, tplink-jetstream, yealink) override it with proprietary OIDs.

Change

Add SnmpHealthProfile (TypedDict) to models: the OIDs a device publishes uptime, CPU, memory and interface counters under, plus the two switches the mixin carries today (_SNMP_SKIP_IF, _SNMP_TX_ERR_IS_DROP).
A driver whose device answers standard UCD-MIB/IF-MIB declares nothing. Others set SNMP_HEALTH_PROFILE as a class attribute.
Mark HealthMetricsMixin, collect_ucd_metrics and the OID constants deprecated; remove them in 5.0.
Rule test: no module imports asyncio.

Part of NetOrk/netork#1105. Plan: NAPALM/napalm-device-types docs/STRUCTURE.md (branch docs/structure-plan).

Prio P3: the first step after the docs; the application side waits on it.

`HealthMetricsMixin` (`health_metrics.py`) and `_ucd_metrics.py` collect CPU, memory, load and interface counters over SNMP. The collector is a classmethod that the application calls with its own `snmp_get`/`snmp_walk`; the driver is not even connected while it runs. It is mixed into five role bases, and four drivers (procurve, netgear, tplink-jetstream, yealink) override it with proprietary OIDs. **Change** - Add `SnmpHealthProfile` (TypedDict) to `models`: the OIDs a device publishes uptime, CPU, memory and interface counters under, plus the two switches the mixin carries today (`_SNMP_SKIP_IF`, `_SNMP_TX_ERR_IS_DROP`). - A driver whose device answers standard UCD-MIB/IF-MIB declares nothing. Others set `SNMP_HEALTH_PROFILE` as a class attribute. - Mark `HealthMetricsMixin`, `collect_ucd_metrics` and the OID constants deprecated; remove them in 5.0. - Rule test: no module imports `asyncio`. Part of NetOrk/netork#1105. Plan: NAPALM/napalm-device-types `docs/STRUCTURE.md` (branch `docs/structure-plan`). Prio P3: the first step after the docs; the application side waits on it.

christianmanivong referenced this issue

2026-10-14 08:23:27 +00:00

docs: a structure that keeps device-types vendor- and product-agnostic #37

christianmanivong referenced this issue from NAPALM/napalm-opnsense

2026-10-14 08:58:50 +00:00

Agnostic structure: fix_snmp template, ping batch, neutral markers #16

christianmanivong referenced this issue from NAPALM/napalm-hpe-aruba-procurve

2026-10-14 08:58:51 +00:00

Memory usage is probably inverted: the OID read as "used" is free memory #9

christianmanivong referenced this issue from NAPALM/napalm-hpe-aruba-procurve

2026-10-14 08:58:52 +00:00

Agnostic structure: SNMP profile and fix_snmp template #12