[feature] Support dynamic mobile signal metrics for multiple interfaces

Author: Yash-Chauhan22

.dockerignore

@@ -0,0 +1,8 @@
+venv/
+.git/
+.github/
+.tox/
+htmlcov/
+build/
+dist/
+*.egg-info/

docker-compose.yml

@@ -6,6 +6,8 @@ services:
       dockerfile: Dockerfile
     ports:
       - "8000:8000"
+    volumes:
+      - .:/opt/openwisp
     depends_on:
       - influxdb
       - redis

docs/user/metrics.rst

@@ -207,15 +207,25 @@ Mobile Signal Strength
     :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/signal-strength.png
     :align: center
 
-================== =====================================
-**collection**:    :doc:`OpenWrt Monitoring Agent
-                   </openwrt-monitoring-agent/index>`
-**measurement**:   ``signal_strength``
+================== ==========================================================================
+**collection**:    :doc:`OpenWrt Monitoring Agent </openwrt-monitoring-agent/index>`
+**measurement**:   ``signal``
 **type**:          ``float``
 **fields**:        ``signal_strength``, ``signal_power``
+**tags**:          .. code-block:: python
+
+                       {
+                           "organization_id": "<organization-id-of-the-related-device>",
+                           "ifname": "<interface-name>",
+                           # optional
+                           "location_id": "<location-id-of-the-related-device-if-present>",
+                           "floorplan_id": "<floorplan-id-of-the-related-device-if-present>",
+                       }
 **configuration**: ``signal_strength``
 **charts**:        ``signal_strength``
-================== =====================================
+================== ==========================================================================
+
+If a device has multiple mobile interfaces, a separate chart will be created for each interface, with its name appended to the chart title (e.g. ``Signal Strength (RSSI): mobile0``).
 
 .. _mobile_signal_quality:
 
@@ -226,15 +236,25 @@ Mobile Signal Quality
     :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/signal-quality.png
     :align: center
 
-================== ======================================
-**collection**:    :doc:`OpenWrt Monitoring Agent
-                   </openwrt-monitoring-agent/index>`
-**measurement**:   ``signal_quality``
+================== ==========================================================================
+**collection**:    :doc:`OpenWrt Monitoring Agent </openwrt-monitoring-agent/index>`
+**measurement**:   ``signal``
 **type**:          ``float``
-**fields**:        ``signal_quality``, ``signal_quality``
+**fields**:        ``signal_quality``, ``snr``
+**tags**:          .. code-block:: python
+
+                       {
+                           "organization_id": "<organization-id-of-the-related-device>",
+                           "ifname": "<interface-name>",
+                           # optional
+                           "location_id": "<location-id-of-the-related-device-if-present>",
+                           "floorplan_id": "<floorplan-id-of-the-related-device-if-present>",
+                       }
 **configuration**: ``signal_quality``
 **charts**:        ``signal_quality``
-================== ======================================
+================== ==========================================================================
+
+If a device has multiple mobile interfaces, a separate chart will be created for each interface, with its name appended to the chart title (e.g. ``Signal Quality (RSRQ): mobile0``).
 
 .. _mobile_access_technology_in_use:
 
@@ -245,15 +265,25 @@ Mobile Access Technology in Use
     :target: https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/access-technology.png
     :align: center
 
-================== ==================================
-**collection**:    :doc:`OpenWrt Monitoring Agent
-                   </openwrt-monitoring-agent/index>`
-**measurement**:   ``access_tech``
+================== ==========================================================================
+**collection**:    :doc:`OpenWrt Monitoring Agent </openwrt-monitoring-agent/index>`
+**measurement**:   ``signal``
 **type**:          ``int``
 **fields**:        ``access_tech``
+**tags**:          .. code-block:: python
+
+                       {
+                           "organization_id": "<organization-id-of-the-related-device>",
+                           "ifname": "<interface-name>",
+                           # optional
+                           "location_id": "<location-id-of-the-related-device-if-present>",
+                           "floorplan_id": "<floorplan-id-of-the-related-device-if-present>",
+                       }
 **configuration**: ``access_tech``
 **charts**:        ``access_tech``
-================== ==================================
+================== ==========================================================================
+
+If a device has multiple mobile interfaces, a separate chart will be created for each interface, with its name appended to the chart title (e.g. ``Access Technology: mobile0``).
 
 .. _iperf3:
 

openwisp_monitoring/device/tests/test_api.py

@@ -1008,6 +1008,71 @@ def test_mobile_charts(self):
         )
         self.assertEqual(self.chart_queryset.count(), charts_count + 3)
 
+    @tag("flaky_with_udp_writes")
+    def test_multiple_mobile_charts(self):
+        org = self._create_org()
+        device = self._create_device(organization=org)
+        charts_count = self.chart_queryset.count()
+        data = {
+            "type": "DeviceMonitoring",
+            "interfaces": [
+                {
+                    "name": "mobile0",
+                    "mac": "00:00:00:00:00:00",
+                    "mtu": 1900,
+                    "multicast": True,
+                    "txqueuelen": 1000,
+                    "type": "modem-manager",
+                    "up": True,
+                    "mobile": {
+                        "connection_status": "connected",
+                        "imei": "300000001234567",
+                        "manufacturer": "Sierra Wireless, Incorporated",
+                        "model": "MC7430",
+                        "operator_code": "50502",
+                        "operator_name": "YES OPTUS",
+                        "power_status": "on",
+                        "signal": {
+                            "lte": {"rsrp": -75, "rsrq": -8, "rssi": -51, "snr": 13},
+                        },
+                    },
+                },
+                {
+                    "name": "mobile1",
+                    "mac": "00:00:00:00:00:01",
+                    "mtu": 1900,
+                    "multicast": True,
+                    "txqueuelen": 1000,
+                    "type": "modem-manager",
+                    "up": True,
+                    "mobile": {
+                        "connection_status": "connected",
+                        "imei": "300000001234568",
+                        "manufacturer": "Sierra Wireless, Incorporated",
+                        "model": "MC7430",
+                        "operator_code": "50502",
+                        "operator_name": "YES OPTUS",
+                        "power_status": "on",
+                        "signal": {
+                            "lte": {"rsrp": -80, "rsrq": -10, "rssi": -55, "snr": 11},
+                        },
+                    },
+                },
+            ],
+        }
+        self._post_data(device.id, device.key, data)
+        response = self.client.get(self._url(device.pk.hex, device.key))
+        self.assertEqual(response.status_code, 200)
+        charts = response.data["charts"]
+        self.assertEqual(self.chart_queryset.count(), charts_count + 6)
+        chart_titles = [chart["title"] for chart in charts]
+        self.assertIn("Signal Strength (RSSI): mobile0", chart_titles)
+        self.assertIn("Signal Strength (RSSI): mobile1", chart_titles)
+        self.assertIn("Signal Quality (RSRQ): mobile0", chart_titles)
+        self.assertIn("Signal Quality (RSRQ): mobile1", chart_titles)
+        self.assertIn("Access Technology: mobile0", chart_titles)
+        self.assertIn("Access Technology: mobile1", chart_titles)
+
     # This test reads chart summaries immediately after posting data. That is
     # unreliable with UDP writes.
     @tag("flaky_with_udp_writes")

openwisp_monitoring/device/writer.py

@@ -77,7 +77,13 @@ def write(self, data, time=None, current=False):
             ifname = interface["name"]
             if "mobile" in interface:
                 self._write_mobile_signal(
-                    interface, ifname, ct, self.device_data.pk, current, time=time
+                    interface,
+                    ifname,
+                    ct,
+                    self.device_data.pk,
+                    current,
+                    time=time,
+                    extra_tags=device_extra_tags,
                 )
             ifstats = interface.get("statistics", {})
             # Explicitly stated None to avoid skipping in case the stats are zero
@@ -192,7 +198,9 @@ def _get_mobile_signal_type(self, signal):
             if tech in signal:
                 return tech
 
-    def _write_mobile_signal(self, interface, ifname, ct, pk, current=False, time=None):
+    def _write_mobile_signal(
+        self, interface, ifname, ct, pk, current=False, time=None, extra_tags=None
+    ):
         access_type = self._get_mobile_signal_type(interface["mobile"].get("signal"))
         if not access_type:
             return
@@ -210,13 +218,15 @@ def _write_mobile_signal(self, interface, ifname, ct, pk, current=False, time=No
         if signal_strength is not None:
             signal_strength = float(signal_strength)
         if signal_strength is not None or signal_power is not None:
+            name = f"{ifname} signal strength"
             metric, created = Metric._get_or_create(
                 object_id=self.device_data.pk,
                 content_type_id=ct.id,
                 configuration="signal_strength",
-                name="signal strength",
+                name=name,
                 key="signal",
                 main_tags={"ifname": Metric._makekey(ifname)},
+                extra_tags=extra_tags,
             )
             self._append_metric_data(
                 metric, signal_strength, current, time=time, extra_values=extra_values
@@ -239,27 +249,31 @@ def _write_mobile_signal(self, interface, ifname, ct, pk, current=False, time=No
         if signal_quality is not None:
             signal_quality = float(signal_quality)
         if snr is not None or signal_quality is not None:
+            name = f"{ifname} signal quality"
             metric, created = Metric._get_or_create(
                 object_id=self.device_data.pk,
                 content_type_id=ct.id,
                 configuration="signal_quality",
-                name="signal quality",
+                name=name,
                 key="signal",
                 main_tags={"ifname": Metric._makekey(ifname)},
+                extra_tags=extra_tags,
             )
             self._append_metric_data(
                 metric, signal_quality, current, time=time, extra_values=extra_values
             )
             if created:
                 self._create_signal_quality_chart(metric)
         # create access technology chart
+        name = f"{ifname} access technology"
         metric, created = Metric._get_or_create(
             object_id=self.device_data.pk,
             content_type_id=ct.id,
             configuration="access_tech",
-            name="access technology",
+            name=name,
             key="signal",
             main_tags={"ifname": Metric._makekey(ifname)},
+            extra_tags=extra_tags,
         )
         self._append_metric_data(
             metric,

openwisp_monitoring/monitoring/configuration.py

@@ -572,7 +572,7 @@ def _get_access_tech():
                 "type": "scatter",
                 "fill": "none",
                 "yaxis": {"zeroline": False},
-                "title": _("Signal Strength (RSSI)"),
+                "title": _("Signal Strength (RSSI): {ifname}"),
                 "colors": (DEFAULT_COLORS[3], DEFAULT_COLORS[0]),
                 "description": _(
                     "Signal Strength (RSSI) and Signal Power (RSRP), measured in dBm."
@@ -598,7 +598,7 @@ def _get_access_tech():
                 "type": "scatter",
                 "fill": "none",
                 "yaxis": {"zeroline": False},
-                "title": _("Signal Quality (RSRQ)"),
+                "title": _("Signal Quality (RSRQ): {ifname}"),
                 "colors": (DEFAULT_COLORS[3], DEFAULT_COLORS[0]),
                 "description": _(
                     _(
@@ -623,7 +623,7 @@ def _get_access_tech():
         "charts": {
             "access_tech": {
                 "type": "bar",
-                "title": _("Access Technology"),
+                "title": _("Access Technology: {ifname}"),
                 "description": _(
                     _(
                         "Shows the access technology (LTE, UTMS, CDMA1x, etc.) "

openwisp_monitoring/monitoring/tests/test_models.py

@@ -337,14 +337,15 @@ def test_metric_pre_write_signals_emitted(self):
 
     def test_metric_post_write_signals_emitted(self):
         om = self._create_object_metric()
+        now = timezone.now()
         with catch_signal(post_metric_write) as handler:
-            om.write(3, current=True, time=start_time)
+            om.write(3, current=True, time=now)
             handler.assert_called_once_with(
                 sender=Metric,
                 metric=om,
                 values={om.field_name: 3},
                 signal=post_metric_write,
-                time=start_time.isoformat(),
+                time=now.isoformat(),
                 current=True,
             )