netbox-plugin-prometheus-sd 2.1.0__tar.gz → 2.2.0__tar.gz

{netbox_plugin_prometheus_sd-2.1.0 → netbox_plugin_prometheus_sd-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: netbox-plugin-prometheus-sd
-Version: 2.1.0
+Version: 2.2.0
 Summary: A Netbox plugin to provide Netbox entires to Prometheus HTTP service discovery
 License: MIT
 License-File: LICENSE
@@ -84,8 +84,9 @@ GET        /api/plugins/prometheus-sd/ip-addresses/         Get a list of ip in
 
 #### Extended services filters
 
-Apart from standard Netbox filters, services endpoint also supports `tenant=<slug>` or `tenant_id=<id>` parameters.
-The lookup is only executed against the `tenant` attribute of the object associated with the service.
+Apart from standard Netbox filters, services endpoint also supports `tenant=<slug>` or `tenant_id=<id>`, and
+`site=<slug>` or `site_id=<id>` parameters. The lookup is only executed against the `tenant`/`site` attribute of the
+object associated with the service.
 
 #### Filtering and response size
 

{netbox_plugin_prometheus_sd-2.1.0 → netbox_plugin_prometheus_sd-2.2.0}/README.md

@@ -66,8 +66,9 @@ GET        /api/plugins/prometheus-sd/ip-addresses/         Get a list of ip in
 
 #### Extended services filters
 
-Apart from standard Netbox filters, services endpoint also supports `tenant=<slug>` or `tenant_id=<id>` parameters.
-The lookup is only executed against the `tenant` attribute of the object associated with the service.
+Apart from standard Netbox filters, services endpoint also supports `tenant=<slug>` or `tenant_id=<id>`, and
+`site=<slug>` or `site_id=<id>` parameters. The lookup is only executed against the `tenant`/`site` attribute of the
+object associated with the service.
 
 #### Filtering and response size
 

{netbox_plugin_prometheus_sd-2.1.0 → netbox_plugin_prometheus_sd-2.2.0}/netbox_prometheus_sd/__init__.py

@@ -1,7 +1,7 @@
 from netbox.plugins import PluginConfig
 
 # Placeholder for semantic release
-__VERSION__ = "2.1.0"
+__VERSION__ = "2.2.0"
 
 
 class PrometheusSD(PluginConfig):

{netbox_plugin_prometheus_sd-2.1.0 → netbox_plugin_prometheus_sd-2.2.0}/netbox_prometheus_sd/filtersets.py

@@ -16,11 +16,11 @@ SERVICE_HAS_PORTS_FIELD = any(f.name == "ports" for f in Service._meta.get_field
 
 
 class ServiceFilterSet(NetboxServiceFilterSet):
-    """Filter set to support tenancy over the device/VM foreign key.
+    """Filter set to support tenancy and site filtering over the device/VM foreign key.
 
-    Tenancy in Netbox is very incosistent and the relationship on its own is defined across many different models. This
+    Tenancy in Netbox is very inconsistent and the relationship on its own is defined across many different models. This
     means that supporting all layers is nearly impossible without a stronger upstream support. For this reason only the
-    "first level" tenancy is supported by this filter set.
+    "first level" tenancy is supported by the tenant filter set.
     """
 
     tenant_id = MultiValueNumberFilter(
@@ -33,6 +33,16 @@ class ServiceFilterSet(NetboxServiceFilterSet):
         label=_("Tenant (slug)"),
     )
 
+    site_id = MultiValueNumberFilter(
+        method="filter_by_site_id",
+        label=_("Site (ID)"),
+    )
+
+    site = MultiValueCharFilter(
+        method="filter_by_site_slug",
+        label=_("Site (slug)"),
+    )
+
     # Netbox < 4.7 only exposes the ports array as `port`, but Netbox's
     # test_missing_filters wants a filter named after the model field.
     # see: https://github.com/netbox-community/netbox/blob/master/netbox/utilities/testing/filtersets.py#L98
@@ -61,3 +71,14 @@ class ServiceFilterSet(NetboxServiceFilterSet):
             Q(device__tenant__slug__in=value)
             | Q(virtual_machine__tenant__slug__in=value)
         )
+
+    def filter_by_site_id(self, queryset, name, value):
+        return queryset.filter(
+            Q(device__site_id__in=value) | Q(virtual_machine__site_id__in=value)
+        )
+
+    def filter_by_site_slug(self, queryset, name, value):
+        return queryset.filter(
+            Q(device__site__slug__in=value)
+            | Q(virtual_machine__site__slug__in=value)
+        )

{netbox_plugin_prometheus_sd-2.1.0 → netbox_plugin_prometheus_sd-2.2.0}/netbox_prometheus_sd/tests/test_filtersets.py

@@ -1,5 +1,6 @@
 from django.test import TestCase
 
+from dcim.models.sites import Site
 from ipam.models import Service
 from tenancy.models import Tenant
 
@@ -40,3 +41,23 @@ class ServiceTestCase(TestCase, ChangeLoggedFilterSetTestMixin):
         self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6)
         params = {"tenant": [tenant.slug]}
         self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6)
+
+    def test_device_site(self):
+        # build_device_full() assigns devices directly to the "site" site.
+        site = Site.objects.get(slug="site")
+
+        params = {"site_id": [site.pk]}
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3)
+        params = {"site": [site.slug]}
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3)
+
+    def test_vm_site(self):
+        # build_vm_full() assigns VMs directly to the "campus-a" site, distinct
+        # from the devices' site, so this also verifies the filter doesn't match
+        # across device/VM boundaries.
+        site = Site.objects.get(slug="campus-a")
+
+        params = {"site_id": [site.pk]}
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3)
+        params = {"site": [site.slug]}
+        self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3)

{netbox_plugin_prometheus_sd-2.1.0 → netbox_plugin_prometheus_sd-2.2.0}/netbox_prometheus_sd/tests/utils.py

@@ -119,6 +119,10 @@ def build_vm_full(name, ip_octet=1):
     )[0]
 
     vm.tenant = build_tenant()
+    # Direct site assignment, independent of the cluster's own site/scope -- Netbox
+    # supports both, and the plugin's ServiceFilterSet only filters on this direct
+    # relation (see filtersets.py).
+    vm.site = Site.objects.get_or_create(name="Campus A", slug="campus-a")[0]
     vm.custom_field_data = build_custom_fields()
     vm.role = DeviceRole.objects.get_or_create(name="VM", slug="vm", vm_role=True)[0]
     vm.primary_ip4 = IPAddress.objects.get_or_create(

{netbox_plugin_prometheus_sd-2.1.0 → netbox_plugin_prometheus_sd-2.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "netbox-plugin-prometheus-sd"
-version = "2.1.0" # placeholder
+version = "2.2.0" # placeholder
 description = "A Netbox plugin to provide Netbox entires to Prometheus HTTP service discovery"
 authors = ["Felix Peters <felix.peters@breuninger.de>"]
 license = "MIT"