Add support for specifying tenants in avi_vantage (#19825)

* add tenant property to the config

* tenant admin case working

* multiple tenants working

* add empty tenant test + small cleanup

* ddev validate config models test -fs

* cleanup

* changelog

* ddev test -fs

* fix metrics path in e2e flask app

* change tenant property to a list

* add test for default config

* lint

* update default value to be empty list

Author: NouemanKHAL

avi_vantage/assets/configuration/spec.yaml

@@ -31,6 +31,16 @@ files:
         items:
           type: string
           enum: *avi_entities
+    - name: tenants
+      required: false
+      description: |
+        A list of tenant names to collect metrics for. If empty, it defaults to the admin tenant.
+      value:
+        type: array
+        items:
+          type: string
+        example: [admin, tenant_a, tenant_b]
+        display_default: []
     - template: instances/openmetrics
       overrides:
         persist_connections.hidden: true

avi_vantage/changelog.d/19825.added

@@ -0,0 +1 @@
+Add support for specifying tenants in avi_vantage

avi_vantage/datadog_checks/avi_vantage/check.py

@@ -3,6 +3,7 @@
 # Licensed under a 3-clause BSD style license (see LICENSE)
 from contextlib import contextmanager
 from copy import deepcopy
+from urllib.parse import urlencode
 
 from datadog_checks.avi_vantage import metrics
 from datadog_checks.base import AgentCheck, OpenMetricsBaseCheckV2
@@ -29,6 +30,9 @@ def __init__(self, name, init_config, instances):
         # Required for storing the auth cookie
         self.instance['persist_connections'] = True
         self._base_url = None
+        self.tenant = None
+        if self.instance.get("tenants"):
+            self.tenant = ",".join(self.instance.get("tenants"))
 
     @property
     def base_url(self):
@@ -46,7 +50,14 @@ def configure_scrapers(self):
                 )
             resource_metrics = RESOURCE_METRICS[entity]
             instance_copy = deepcopy(self.instance)
+
+            # GET /api/analytics/prometheus-metrics/{entity_type}/?{query_params}"
             endpoint = self.base_url + "/api/analytics/prometheus-metrics/" + entity
+            if self.tenant:
+                query_params = {"tenant": self.tenant}
+                encoded_params = urlencode(query_params)
+                endpoint += f"/?{encoded_params}"
+
             instance_copy['openmetrics_endpoint'] = endpoint
             instance_copy['metrics'] = [resource_metrics]
             instance_copy['rename_labels'] = LABELS_REMAPPER.copy()

avi_vantage/datadog_checks/avi_vantage/config_models/defaults.py

@@ -108,6 +108,10 @@ def instance_telemetry():
     return False
 
 
+def instance_tenants():
+    return []
+
+
 def instance_timeout():
     return 10
 

avi_vantage/datadog_checks/avi_vantage/config_models/instance.py

@@ -141,6 +141,7 @@ class InstanceConfig(BaseModel):
     tag_by_endpoint: Optional[bool] = None
     tags: Optional[tuple[str, ...]] = None
     telemetry: Optional[bool] = None
+    tenants: Optional[tuple[str, ...]] = None
     timeout: Optional[float] = None
     tls_ca_cert: Optional[str] = None
     tls_cert: Optional[str] = None

avi_vantage/datadog_checks/avi_vantage/data/conf.yaml.example

@@ -61,6 +61,14 @@ instances:
     #   - serviceengine
     #   - virtualservice
 
+    ## @param tenants - list of strings - optional - default: []
+    ## A list of tenant names to collect metrics for. If empty, it defaults to the admin tenant.
+    #
+    # tenants:
+    #   - admin
+    #   - tenant_a
+    #   - tenant_b
+
     ## @param raw_metric_prefix - string - optional
     ## A prefix that is removed from all exposed metric names, if present.
     ## All configuration options will use the prefix-less name.