Initial support for EoIP, GRE and IPIP

[phibos]

This adds initial support for EoIP, GRE and IPIP interfaces and fixes #204

[phibos]

@akpw this PR adds the disabled label to interface_status. This might break backward compatibility. Should we add an additional metric like interface_disabled to add the disabled state?

[akpw]

@phibos adding a label should be fine, however dropping existing labels or renaming existing metrics would result in breaking compatibility. from a quick glance there seems to be the case with status at least, can you pls double check to make sure all of the existing metrics and labels stay compatible?

[phibos]

Current status metrics

mktxp_interface_status{name="sfp1",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{name="sfp2",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{name="sfp3",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp4",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp5",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp6",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp7",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp8",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp9",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp10",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp11",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{name="sfp12",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{name="sfpplus1",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0

Status metrics after applying the changes:

mktxp_interface_status{disabled="0",name="sfp1",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="sfp2",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="1",name="sfp3",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="1",name="sfp4",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="1",name="sfp5",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="1",name="sfp6",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="1",name="sfp7",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="1",name="sfp8",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="1",name="sfp9",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="1",name="sfp10",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="1",name="sfp11",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="0",name="sfp12",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="1",name="sfpplus1",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 0.0
mktxp_interface_status{disabled="0",name="br-a",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="br-B",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="vrrp1",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="eoip-a",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="eoip-b",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="gre-a",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="gre-b",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="gre-c",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="gre-d",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0
mktxp_interface_status{disabled="0",name="gre-e",routerboard_address="192.168.1.1",routerboard_name="router.example.org"} 1.0

From a quick diff, the following changes:

• Add "disabled" label
• Add additional interfaces like:
  • Bridge
  • VRRP
  • EoIP
  • GRE

Current version:

The reported status is the status value from /interface/ethernet/monitor. Every 'link-ok' results in status=1, everything else ('no-link' and 'unknown') results in status=0.
https://help.mikrotik.com/docs/spaces/ROS/pages/8323191/Ethernet#Ethernet-Monitor

New version:

The status is the running value reported by /interface/print.

From the docs: https://help.mikrotik.com/docs/spaces/ROS/pages/8323191/Ethernet#Ethernet-Properties

Whether interface is running. Note that some interface does not have running check and they are always reported as "running".

At the moment I can't see any difference in the status reported. But if you like to keep the interface_status metric as link status I can rename the new metrics to interface_running.

[phibos]

One thing we should change is the handling of the use_comments_over_names setting.

For some metrics it is handled in the interface_ds ...

mktxp/mktxp/datasource/interface_ds.py

Lines 72 to 75 in 3beb00e

	if include_comments and interface.get('comment'):
	# combines names with comments
	interface_monitor_record['name'] = interface['comment'] if router_entry.config_entry.use_comments_over_names else \
	f"{interface['name']} ({interface['comment']})"

... and for some others it is handled by the interface_collector

mktxp/mktxp/collector/interface_collector.py

Lines 32 to 34 in 3beb00e

	if interface_traffic_record.get('comment'):
	interface_traffic_record['name'] = interface_traffic_record['comment'] if router_entry.config_entry.use_comments_over_names \
	else f"{interface_traffic_record['name']} ({interface_traffic_record['comment']})"

After this PR is merged I can proved a new PR to move the use_comments_over_names handling into the interface_ds.

[akpw]

@phibos thanks for the thorough check. Looks like the docs indicate there could be a difference, and e.g. the default dashboard already uses the link status context as well. So yes if possible it'd be better to leave interface_status and monitor_collector as they are, introducing new interface_running` metric instead.

[phibos]

@akpw I have

• Splitting the status and running metrics
  • interface_status is the link status
  • interface_running is the running state reported by RouterOS devices
  • interface_disabled is the disabled state
• Move the handling of the 'use_comments_over_names' setting to the
  DS, now it is also supported for GRE, IPIP, EoIP and other interfaces
• Removed some unused code
• Rebase with main, to get the latest changes