Add v2 APIs for Exporter

We have added several APIs for retrieving Exporter data.

Author: hoangpn

promgen/filters.py

@@ -145,3 +145,34 @@ class RuleFilterV2(django_filters.rest_framework.FilterSet):
         method=filter_content_type,
         help_text="Filter by content type model name. Example: content_type=service",
     )
+
+
+class ExporterFilter(django_filters.rest_framework.FilterSet):
+    project = django_filters.CharFilter(
+        field_name="project__name",
+        lookup_expr="contains",
+        help_text="Filter by project name containing a specific substring. Example: project=Example Project",
+    )
+    job = django_filters.CharFilter(
+        field_name="job",
+        lookup_expr="contains",
+        help_text="Filter by job name containing a specific substring. Example: job=prometheus",
+    )
+    path = django_filters.CharFilter(
+        field_name="path",
+        lookup_expr="contains",
+        help_text="Filter by path containing a specific substring. Example: path=/metrics",
+    )
+    scheme = django_filters.ChoiceFilter(
+        field_name="scheme",
+        choices=[
+            ("http", "HTTP"),
+            ("https", "HTTPS"),
+        ],
+        lookup_expr="exact",
+        help_text="Filter by exact scheme. Example: scheme=http",
+    )
+    enabled = django_filters.BooleanFilter(
+        field_name="enabled",
+        help_text="Filter by enabled status (true or false). Example: enabled=true",
+    )

promgen/fixtures/testcases.yaml

@@ -85,13 +85,15 @@
     project: 1
     job: node
     port: 9100
+    path: /metrics
 - model: promgen.exporter
   pk: 2
   fields:
     project: 2
-    job: node
+    job: nginx
     port: 9100
     enabled: false
+    scheme: https
 - model: promgen.probe
   pk: 1
   fields:

promgen/rest_v2.py

@@ -255,3 +255,20 @@ def delete_host(self, request, id):
         for hostname in hostnames:
             farm.host_set.filter(name=hostname).delete()
         return Response(serializers.HostRetrieveSerializer(farm.host_set, many=True).data)
+
+
+@extend_schema_view(
+    list=extend_schema(summary="List Exporters", description="Retrieve a list of all exporters."),
+    retrieve=extend_schema(
+        summary="Retrieve Exporter",
+        description="Retrieve detailed information about a specific exporter.",
+    ),
+)
+@extend_schema(tags=["Exporter"])
+class ExporterViewSet(mixins.RetrieveModelMixin, mixins.ListModelMixin, viewsets.GenericViewSet):
+    queryset = models.Exporter.objects.all()
+    filterset_class = filters.ExporterFilter
+    serializer_class = serializers.ExporterSerializer
+    lookup_value_regex = "[^/]+"
+    lookup_field = "id"
+    pagination_class = PromgenPagination

promgen/serializers.py

@@ -232,3 +232,11 @@ class HostListSerializer(serializers.Serializer):
     hosts = serializers.ListField(
         child=serializers.CharField(), help_text="List of hostnames to add."
     )
+
+
+class ExporterSerializer(serializers.ModelSerializer):
+    project = serializers.ReadOnlyField(source="project.name")
+
+    class Meta:
+        model = models.Exporter
+        fields = "__all__"

promgen/tests/examples/export.targets.json

@@ -2,6 +2,7 @@
     {
       "labels": {
         "__farm_source": "promgen",
+        "__metrics_path__": "/metrics",
         "__scheme__": "http",
         "__shard": "test-shard",
         "farm": "test-farm",

promgen/tests/examples/rest.exporter.default.json

@@ -0,0 +1,25 @@
+{
+  "count": 2,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "enabled": false,
+      "id": 2,
+      "job": "nginx",
+      "path": "",
+      "port": 9100,
+      "project": "another-project",
+      "scheme": "https"
+    },
+    {
+      "enabled": true,
+      "id": 1,
+      "job": "node",
+      "path": "/metrics",
+      "port": 9100,
+      "project": "test-project",
+      "scheme": "http"
+    }
+  ]
+}

promgen/tests/examples/rest.exporter.detail.json

@@ -0,0 +1,9 @@
+{
+  "enabled": true,
+  "id": 1,
+  "job": "node",
+  "path": "/metrics",
+  "port": 9100,
+  "project": "test-project",
+  "scheme": "http"
+}

promgen/tests/examples/rest.exporter.filter_by_enabled.json

@@ -0,0 +1,16 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "enabled": true,
+      "id": 1,
+      "job": "node",
+      "path": "/metrics",
+      "port": 9100,
+      "project": "test-project",
+      "scheme": "http"
+    }
+  ]
+}

promgen/tests/examples/rest.exporter.filter_by_job.json

@@ -0,0 +1,16 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "enabled": false,
+      "id": 2,
+      "job": "nginx",
+      "path": "",
+      "port": 9100,
+      "project": "another-project",
+      "scheme": "https"
+    }
+  ]
+}

promgen/tests/examples/rest.exporter.filter_by_path.json

@@ -0,0 +1,16 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "enabled": true,
+      "id": 1,
+      "job": "node",
+      "path": "/metrics",
+      "port": 9100,
+      "project": "test-project",
+      "scheme": "http"
+    }
+  ]
+}

promgen/tests/examples/rest.exporter.filter_by_project.json

@@ -0,0 +1,16 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "enabled": true,
+      "id": 1,
+      "job": "node",
+      "path": "/metrics",
+      "port": 9100,
+      "project": "test-project",
+      "scheme": "http"
+    }
+  ]
+}

promgen/tests/examples/rest.exporter.filter_by_scheme.json

@@ -0,0 +1,16 @@
+{
+  "count": 1,
+  "next": null,
+  "previous": null,
+  "results": [
+    {
+      "enabled": false,
+      "id": 2,
+      "job": "nginx",
+      "path": "",
+      "port": 9100,
+      "project": "another-project",
+      "scheme": "https"
+    }
+  ]
+}

promgen/tests/examples/rest.exporter.paginated.json

@@ -0,0 +1,16 @@
+{
+  "count": 2,
+  "next": "http://testserver/rest/v2/exporters/?page_number=2&page_size=1",
+  "previous": null,
+  "results": [
+    {
+      "enabled": false,
+      "id": 2,
+      "job": "nginx",
+      "path": "",
+      "port": 9100,
+      "project": "another-project",
+      "scheme": "https"
+    }
+  ]
+}

promgen/tests/test_rest.py

@@ -775,3 +775,76 @@ def test_rest_rule(self):
             reverse("api-v2:rule-detail", args=[1]), HTTP_AUTHORIZATION=f"Token {token}"
         )
         self.assertEqual(response.status_code, 204)
+
+    @override_settings(PROMGEN=tests.SETTINGS)
+    def test_rest_exporter(self):
+        # Check retrieving all exporters
+        expected = tests.Data("examples", "rest.exporter.default.json").json()
+        response = self.client.get(reverse("api-v2:exporter-list"))
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving paginated exporters
+        expected = tests.Data("examples", "rest.exporter.paginated.json").json()
+        response = self.client.get(reverse("api-v2:exporter-list"), {"page_number": 1, "page_size": 1})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving exporters whose "enabled" is "true"
+        expected = tests.Data("examples", "rest.exporter.filter_by_enabled.json").json()
+        response = self.client.get(reverse("api-v2:exporter-list"), {"enabled": "true"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving exporters whose "job" contains "inx"
+        expected = tests.Data("examples", "rest.exporter.filter_by_job.json").json()
+        response = self.client.get(reverse("api-v2:exporter-list"), {"job": "inx"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving exporters with a non-existent "job" returns an empty list
+        response = self.client.get(reverse("api-v2:exporter-list"), {"job": "non-existent"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["count"], 0)
+
+        # Check retrieving exporters whose "path" contains "metrics"
+        expected = tests.Data("examples", "rest.exporter.filter_by_path.json").json()
+        response = self.client.get(reverse("api-v2:exporter-list"), {"path": "/metrics"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving exporters with a non-existent "path" returns an empty list
+        response = self.client.get(reverse("api-v2:exporter-list"), {"path": "non-existent"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["count"], 0)
+
+        # Check retrieving exporters whose "project" contains "test"
+        expected = tests.Data("examples", "rest.exporter.filter_by_project.json").json()
+        response = self.client.get(reverse("api-v2:exporter-list"), {"project": "test"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving exporters with a non-existent "project" returns an empty list
+        response = self.client.get(reverse("api-v2:exporter-list"), {"project": "non-existent"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data["count"], 0)
+
+        # Check retrieving exporters whose "scheme" is "http"
+        expected = tests.Data("examples", "rest.exporter.filter_by_scheme.json").json()
+        response = self.client.get(reverse("api-v2:exporter-list"), {"scheme": "https"})
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving exporters with a non-existent "scheme" returns an 400 Bad Request
+        response = self.client.get(reverse("api-v2:exporter-list"), {"scheme": "non-existent"})
+        self.assertEqual(response.status_code, 400)
+
+        # Check retrieving exporters whose "id" is "1"
+        expected = tests.Data("examples", "rest.exporter.detail.json").json()
+        response = self.client.get(reverse("api-v2:exporter-detail", args=[1]))
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json(), expected)
+
+        # Check retrieving exporters with a non-existent "id" returns 404 Not Found
+        response = self.client.get(reverse("api-v2:exporter-detail", args=[-1]))
+        self.assertEqual(response.status_code, 404)

promgen/urls.py

@@ -38,6 +38,7 @@
 v2_router.register("notifiers", rest_v2.NotifierViewSet)
 v2_router.register("rules", rest_v2.RuleViewSet)
 v2_router.register("farms", rest_v2.FarmViewSet)
+v2_router.register("exporters", rest_v2.ExporterViewSet)
 
 urlpatterns = [
     path("admin/", admin.site.urls),