Add validation for include_aggregated_endpoint (#13793)

* Add validation for include_aggregated_endpoint

* Use stronger language

* Use  rather than  for validation error

rabbitmq/assets/configuration/spec.yaml

@@ -29,6 +29,8 @@ files:
           - name: include_aggregated_endpoint
             description: |
               Whether or not to include metrics from the aggregated endpoint (/metrics).
+
+              Note: This option must be set to true when 'unaggregated_endpoint' is unspecified.
             value:
               type: boolean
               example: true

rabbitmq/datadog_checks/rabbitmq/config_models/validators.py

@@ -23,5 +23,10 @@ def initialize_instance(values, **kwargs):
             agg_ep = plugin_settings['include_aggregated_endpoint']
             if not isinstance(agg_ep, bool):
                 raise TypeError("'prometheus_plugin.include_aggregated_endpoint' must be a boolean.")
+            if not agg_ep and 'unaggregated_endpoint' not in plugin_settings:
+                raise ValueError(
+                    "'prometheus_plugin.include_aggregated_endpoint' field must "
+                    + "be set to 'true' when 'prometheus_plugin.unaggregated_endpoint' is not collected."
+                )
 
     return values

rabbitmq/datadog_checks/rabbitmq/data/conf.yaml.example

@@ -59,6 +59,8 @@ instances:
 
         ## @param include_aggregated_endpoint - boolean - optional - default: true
         ## Whether or not to include metrics from the aggregated endpoint (/metrics).
+        ##
+        ## Note: This option must be set to true when 'unaggregated_endpoint' is unspecified.
         #
         # include_aggregated_endpoint: true
 

rabbitmq/tests/test_openmetrics.py

@@ -240,6 +240,12 @@ def test_aggregated_and_unaggregated_endpoints(endpoint, metrics, aggregator, dd
             r"'prometheus_plugin\.include_aggregated_endpoint' must be a boolean\.",
             id="Aggregated_endpoint must be a boolean.",
         ),
+        pytest.param(
+            {'url': "http://localhost", "include_aggregated_endpoint": False},
+            r"'prometheus_plugin\.include_aggregated_endpoint' field must be set to 'true' "
+            + r"when 'prometheus_plugin\.unaggregated_endpoint' is not collected\.",
+            id="include_aggregated_endpoint must be true when unaggregated_endpoint is missing.",
+        ),
     ],
 )
 def test_config(prom_plugin_settings, err):