Allow disabling querying an exporter

amazon_msk/assets/configuration/spec.yaml

@@ -36,12 +36,16 @@ files:
       value:
         type: string
     - name: jmx_exporter_port
-      description: The port on which the JMX Exporter serves metrics.
+      description: |
+        The port on which the JMX Exporter serves metrics.
+        Set the port to 0 to disable.
       value:
         type: integer
         example: 11001
     - name: node_exporter_port
-      description: The port on which the Node Exporter serves metrics.
+      description: |
+        The port on which the Node Exporter serves metrics.
+        Set the port to 0 to disable.
       value:
         type: integer
         example: 11002

amazon_msk/datadog_checks/amazon_msk/amazon_msk.py

@@ -117,13 +117,14 @@ def check(self, _):
 
             for endpoint in broker_info['Endpoints']:
                 for (port, metrics_mapper, type_overrides) in self._exporter_data:
-                    self._scraper_config['prometheus_url'] = '{}://{}:{}{}'.format(
-                        self._endpoint_prefix, endpoint, port, self._prometheus_metrics_path
-                    )
-                    self._scraper_config['metrics_mapper'] = metrics_mapper
-                    self._scraper_config['type_overrides'] = type_overrides
-
-                    self.process(self._scraper_config)
+                    if port:
+                        self._scraper_config['prometheus_url'] = '{}://{}:{}{}'.format(
+                            self._endpoint_prefix, endpoint, port, self._prometheus_metrics_path
+                        )
+                        self._scraper_config['metrics_mapper'] = metrics_mapper
+                        self._scraper_config['type_overrides'] = type_overrides
+
+                        self.process(self._scraper_config)
 
     def parse_config(self):
         cluster_arn = self.instance.get('cluster_arn')

amazon_msk/datadog_checks/amazon_msk/check.py

@@ -89,17 +89,20 @@ def refresh_scrapers(self):
 
             for endpoint in broker_info['Endpoints']:
                 for port, metrics in self._exporter_data:
-                    url = f'{self._endpoint_prefix}://{endpoint}:{port}{self.config.prometheus_metrics_path}'
-                    if url in self.scrapers:
-                        scrapers[url] = self.scrapers[url]
-                        continue
-
-                    scraper = self.create_scraper({'openmetrics_endpoint': url, 'metrics': metrics, **self.instance})
-                    scraper.static_tags += self._static_tags
-                    scraper.set_dynamic_tags(broker_id_tag)
-                    self.configure_additional_transformers(scraper.metric_transformer.transformer_data)
-
-                    scrapers[url] = scraper
+                    if port:
+                        url = f'{self._endpoint_prefix}://{endpoint}:{port}{self.config.prometheus_metrics_path}'
+                        if url in self.scrapers:
+                            scrapers[url] = self.scrapers[url]
+                            continue
+
+                        scraper = self.create_scraper(
+                            {'openmetrics_endpoint': url, 'metrics': metrics, **self.instance}
+                        )
+                        scraper.static_tags += self._static_tags
+                        scraper.set_dynamic_tags(broker_id_tag)
+                        self.configure_additional_transformers(scraper.metric_transformer.transformer_data)
+
+                        scrapers[url] = scraper
 
         self.scrapers = scrapers
 

amazon_msk/datadog_checks/amazon_msk/data/conf.yaml.example

@@ -72,11 +72,13 @@ instances:
 
     ## @param jmx_exporter_port - integer - optional - default: 11001
     ## The port on which the JMX Exporter serves metrics.
+    ## Set the port to 0 to disable.
     #
     # jmx_exporter_port: 11001
 
     ## @param node_exporter_port - integer - optional - default: 11002
     ## The port on which the Node Exporter serves metrics.
+    ## Set the port to 0 to disable.
     #
     # node_exporter_port: 11002
 

amazon_msk/tests/test_unit.py

@@ -53,6 +53,51 @@ def test_node_check_legacy(aggregator, instance_legacy, mock_client):
     aggregator.assert_all_metrics_covered()
 
 
+@pytest.mark.usefixtures('mock_data')
+def test_disabled_exporter_legacy(aggregator, instance_legacy, mock_client):
+    inst = copy.deepcopy(instance_legacy)
+
+    # Test both JMX and NODE exporters disabled
+    inst.update(
+        {
+            "jmx_exporter_port": 0,
+            "node_exporter_port": 0,
+        }
+    )
+    c = AmazonMskCheck('amazon_msk', {}, [inst])
+    assert not c.run()
+
+    assert_jmx_metrics_legacy(aggregator, [], is_enabled=False)
+    assert_node_metrics_legacy(aggregator, [], is_enabled=False)
+
+    # Test NODE exporter disabled
+    inst.update(
+        {
+            "jmx_exporter_port": 11001,
+            "node_exporter_port": 0,
+        }
+    )
+    c = AmazonMskCheck('amazon_msk', {}, [inst])
+    assert not c.run()
+
+    assert_jmx_metrics_legacy(aggregator, [], is_enabled=True)
+    assert_node_metrics_legacy(aggregator, [], is_enabled=False)
+
+    # Test JMX exporter disabled
+    aggregator.reset()
+    inst.update(
+        {
+            "jmx_exporter_port": 0,
+            "node_exporter_port": 11002,
+        }
+    )
+    c = AmazonMskCheck('amazon_msk', {}, [inst])
+    assert not c.run()
+
+    assert_jmx_metrics_legacy(aggregator, [], is_enabled=False)
+    assert_node_metrics_legacy(aggregator, [], is_enabled=True)
+
+
 @pytest.mark.usefixtures('mock_data')
 @pytest.mark.skipif(PY2, reason='Test only available on Python 3')
 def test_node_check(aggregator, dd_run_check, instance, mock_client):
@@ -90,7 +135,53 @@ def test_node_check(aggregator, dd_run_check, instance, mock_client):
     aggregator.assert_all_metrics_covered()
 
 
-def assert_node_metrics_legacy(aggregator, tags):
+@pytest.mark.usefixtures('mock_data')
+@pytest.mark.skipif(PY2, reason='Test only available on Python 3')
+def test_disabled_exporter_check(aggregator, dd_run_check, instance, mock_client):
+    inst = copy.deepcopy(instance)
+
+    # Test both JMX and NODE exporters disabled
+    inst.update(
+        {
+            "jmx_exporter_port": 0,
+            "node_exporter_port": 0,
+        }
+    )
+    c = AmazonMskCheck('amazon_msk', {}, [inst])
+    dd_run_check(c)
+
+    assert_jmx_metrics(aggregator, [], is_enabled=False)
+    assert_node_metrics(aggregator, [], is_enabled=False)
+
+    # Test NODE exporter disabled
+    inst.update(
+        {
+            "jmx_exporter_port": 11001,
+            "node_exporter_port": 0,
+        }
+    )
+    c = AmazonMskCheck('amazon_msk', {}, [inst])
+    dd_run_check(c)
+
+    assert_jmx_metrics(aggregator, [], is_enabled=True)
+    assert_node_metrics(aggregator, [], is_enabled=False)    
+
+    # Test JMX exporter disabled
+    aggregator.reset()
+    inst.update(
+        {
+            "jmx_exporter_port": 0,
+            "node_exporter_port": 11002,
+        }
+    )
+    c = AmazonMskCheck('amazon_msk', {}, [inst])
+    dd_run_check(c)
+
+    assert_jmx_metrics(aggregator, [], is_enabled=False)
+    assert_node_metrics(aggregator, [], is_enabled=True)
+
+
+def assert_node_metrics_legacy(aggregator, tags, is_enabled=True):
     metrics = set(NODE_METRICS_MAP.values())
 
     # Summaries
@@ -100,18 +191,24 @@ def assert_node_metrics_legacy(aggregator, tags):
 
     for metric in sorted(metrics):
         metric = 'aws.msk.{}'.format(metric)
-        for tag in tags:
-            aggregator.assert_metric_has_tag(metric, tag)
+        if is_enabled:
+            for tag in tags:
+                aggregator.assert_metric_has_tag(metric, tag)
+        else:
+            aggregator.assert_metric(metric, count=0)
 
 
-def assert_jmx_metrics_legacy(aggregator, tags):
+def assert_jmx_metrics_legacy(aggregator, tags, is_enabled=True):
     for metric in sorted(JMX_METRICS_MAP.values()):
         metric = 'aws.msk.{}'.format(metric)
-        for tag in tags:
-            aggregator.assert_metric_has_tag(metric, tag)
+        if is_enabled:
+            for tag in tags:
+                aggregator.assert_metric_has_tag(metric, tag)
+        else:
+            aggregator.assert_metric(metric, count=0)
 
 
-def assert_node_metrics(aggregator, tags):
+def assert_node_metrics(aggregator, tags, is_enabled=True):
     expected_metrics = set()
 
     for raw_metric_name, metric_name in NODE_METRICS_MAP.items():
@@ -127,11 +224,14 @@ def assert_node_metrics(aggregator, tags):
 
     for metric in sorted(expected_metrics):
         metric = 'aws.msk.{}'.format(metric)
-        for tag in tags:
-            aggregator.assert_metric_has_tag(metric, tag)
+        if is_enabled:
+            for tag in tags:
+                aggregator.assert_metric_has_tag(metric, tag)
+        else:
+            aggregator.assert_metric(metric, count=0)
 
 
-def assert_jmx_metrics(aggregator, tags):
+def assert_jmx_metrics(aggregator, tags, is_enabled=True):
     expected_metrics = set()
 
     for raw_metric_name, metric_name in JMX_METRICS_MAP.items():
@@ -145,8 +245,11 @@ def assert_jmx_metrics(aggregator, tags):
 
     for metric in sorted(expected_metrics):
         metric = 'aws.msk.{}'.format(metric)
-        for tag in tags:
-            aggregator.assert_metric_has_tag(metric, tag)
+        if is_enabled:
+            for tag in tags:
+                aggregator.assert_metric_has_tag(metric, tag)
+        else:
+            aggregator.assert_metric(metric, count=0)
 
 
 @pytest.mark.usefixtures('mock_data')