Cisco ACI faults require NDM metadata to be enabled. (#20279)

* Cisco ACI faults require NDM metadata to be enabled.

* Add collecting faults info log.

* Empty commit

Author: jmw51798

cisco_aci/README.md

@@ -55,7 +55,8 @@ To configure this check for an Agent running on a host:
         #   - <TENANT_2>
 
         ## @param send_ndm_metadata - boolean - optional - default: false
-        ## Set to `true` to enable Network Device Monitoring metadata (for devices and interfaces) to be sent.
+        ## Set to `true` to enable Network Device Monitoring metadata (for devices, interfaces, topology) to be sent
+        ## and to allow Cisco ACI fault collection to be enabled.
         #
         # send_ndm_metadata: false
 

cisco_aci/assets/configuration/spec.yaml

@@ -101,7 +101,8 @@ files:
         example: default
     - name: send_ndm_metadata
       description: |
-        Set to `true` to enable Network Device Monitoring metadata (for devices, interfaces, topology) to be sent.
+        Set to `true` to enable Network Device Monitoring metadata (for devices, interfaces, topology) to be sent
+        and to allow Cisco ACI fault collection to be enabled.
       value:
         type: boolean
         example: False

cisco_aci/datadog_checks/cisco_aci/data/conf.yaml.example

@@ -131,7 +131,8 @@ instances:
     # namespace: default
 
     ## @param send_ndm_metadata - boolean - optional - default: false
-    ## Set to `true` to enable Network Device Monitoring metadata (for devices, interfaces, topology) to be sent.
+    ## Set to `true` to enable Network Device Monitoring metadata (for devices, interfaces, topology) to be sent
+    ## and to allow Cisco ACI fault collection to be enabled.
     #
     # send_ndm_metadata: false
 

cisco_aci/datadog_checks/cisco_aci/faults.py

@@ -32,18 +32,28 @@ def __init__(self, check, api, instance, namespace):
         self.send_log = check.send_log
         self.write_persistent_cache = check.write_persistent_cache
 
+        # Config for submitting device/interface metadata to NDM
+        self.send_ndm_metadata = self.instance.get('send_ndm_metadata', False)
         # Config for submitting faultInst faults as logs
         self.send_faultinst_faults = self.instance.get('send_faultinst_faults', False)
         # Config for submitting faultDelegate faults as logs
         self.send_faultdelegate_faults = self.instance.get('send_faultdelegate_faults', False)
 
+    def ndm_metadata_enabled(self):
+        return self.send_ndm_metadata
+
     def faultinst_faults_enabled(self):
         return self.send_faultinst_faults
 
     def faultdelegate_faults_enabled(self):
         return self.send_faultdelegate_faults
 
     def collect(self):
+        if self.faultinst_faults_enabled() or self.faultdelegate_faults_enabled():
+            if not self.ndm_metadata_enabled():
+                self.log.warning("NDM metadata must be enabled (send_ndm_metadata) to collect faults")
+                return
+            self.log.info("collecting faults")
         if self.faultinst_faults_enabled():
             data = self.read_persistent_cache("max_timestamp_{}".format(Faults.FAULTINST_KEY))
             max_timestamp = from_json(data) if data else None

cisco_aci/tests/test_faults.py

@@ -19,3 +19,15 @@ def test_faults_mocked(aggregator, datadog_agent):
     check.check({})
     check.check({})  # Run twice to exercise the max_timestamp logic
     datadog_agent.assert_logs(check.check_id, EXPECTED_FAULT_LOGS)
+
+
+def test_faults_ndm_metadata_false_mocked(aggregator, datadog_agent):
+    config_without_ndm = common.CONFIG_WITH_TAGS.copy()
+    config_without_ndm['send_ndm_metadata'] = False
+    check = CiscoACICheck(common.CHECK_NAME, {}, [config_without_ndm])
+    api = Api(common.ACI_URLS, check.http, common.USERNAME, password=common.PASSWORD, log=check.log)
+    api.wrapper_factory = common.FakeFaultsSessionWrapper
+    check._api_cache[hash_mutable(config_without_ndm)] = api
+
+    check.check({})
+    datadog_agent.assert_logs(check.check_id, [])