Sy/fix msk (#19552)

* allow for check to skip over empty brokerinfo * changelog * Update 19552.added * Update 19552.added
DataDog · Feb 4, 2025 · 9870517 · 9870517
1 parent fce85a9
commit 9870517
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 5 deletions.
diff --git a/amazon_msk/changelog.d/19552.added b/amazon_msk/changelog.d/19552.added
@@ -0,0 +1 @@
+Allow for check to skip over nodes with empty `BrokerNodeInfo` fields
diff --git a/amazon_msk/datadog_checks/amazon_msk/amazon_msk.py b/amazon_msk/datadog_checks/amazon_msk/amazon_msk.py
@@ -103,7 +103,11 @@ def check(self, _):
             self.service_check(self.SERVICE_CHECK_CONNECT, self.OK, tags=self._scraper_config['custom_tags'])
 
         for node_info in response['NodeInfoList']:
-            broker_info = node_info['BrokerNodeInfo']
+            broker_info = node_info.get('BrokerNodeInfo')
+            if not broker_info:
+                self.log.debug('NodeInfo does not contain BrokerNodeInfo, skipping')
+                continue
+
             self._scraper_config['_metric_tags'] = ['broker_id:{}'.format(broker_info['BrokerId'])]
 
             for endpoint in broker_info['Endpoints']:

diff --git a/amazon_msk/datadog_checks/amazon_msk/check.py b/amazon_msk/datadog_checks/amazon_msk/check.py
@@ -96,7 +96,11 @@ def refresh_scrapers(self):
         scrapers = {}
 
         for node_info in response['NodeInfoList']:
-            broker_info = node_info['BrokerNodeInfo']
+            broker_info = node_info.get('BrokerNodeInfo')
+            if not broker_info:
+                self.log.debug('NodeInfo does not contain BrokerNodeInfo, skipping')
+                continue
+
             broker_id_tag = f'broker_id:{broker_info["BrokerId"]}'
 
             for endpoint in broker_info['Endpoints']:

diff --git a/amazon_msk/tests/fixtures/list_nodes.json b/amazon_msk/tests/fixtures/list_nodes.json
@@ -1,5 +1,13 @@
 {
   "NodeInfoList": [
+    {
+      "nodeType": "CONTROLLER",
+      "controllerNodeInfo": {
+        "endpoints": [
+          "b-2.msk-integrate.ch6uni.c6.kafka.us-east-1.amazonaws.com"
+        ]
+      }
+    },
     {
       "AddedToClusterTime": "2019-11-22T23:44:28.725Z",
       "BrokerNodeInfo": {

diff --git a/amazon_msk/tests/test_unit.py b/amazon_msk/tests/test_unit.py
@@ -29,7 +29,9 @@ def test_node_check_legacy(aggregator, instance_legacy, mock_client):
     aggregator.assert_service_check(c.SERVICE_CHECK_CONNECT, c.OK, tags=global_tags)
 
     for node_info in client.list_nodes()['NodeInfoList']:
-        broker_info = node_info['BrokerNodeInfo']
+        broker_info = node_info.get('BrokerNodeInfo')
+        if broker_info is None:
+            continue
         broker_tags = ['broker_id:{}'.format(broker_info['BrokerId'])]
         broker_tags.extend(global_tags)
 
@@ -99,7 +101,10 @@ def test_node_check(aggregator, dd_run_check, instance, mock_client):
     aggregator.assert_service_check('aws.msk.{}'.format(c.SERVICE_CHECK_CONNECT), c.OK, tags=global_tags)
 
     for node_info in client.list_nodes()['NodeInfoList']:
-        broker_info = node_info['BrokerNodeInfo']
+        broker_info = node_info.get('BrokerNodeInfo')
+        if broker_info is None:
+            continue
+
         broker_tags = ['broker_id:{}'.format(broker_info['BrokerId'])]
         broker_tags.extend(global_tags)
 
@@ -222,7 +227,9 @@ def test_custom_metric_path(aggregator, instance_legacy, mock_client):
     aggregator.assert_service_check(c.SERVICE_CHECK_CONNECT, c.OK, tags=global_tags)
 
     for node_info in client.list_nodes()['NodeInfoList']:
-        broker_info = node_info['BrokerNodeInfo']
+        broker_info = node_info.get('BrokerNodeInfo')
+        if broker_info is None:
+            continue
         broker_tags = ['broker_id:{}'.format(broker_info['BrokerId'])]
         broker_tags.extend(global_tags)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Allow for check to skip over nodes with empty `BrokerNodeInfo` fields