Add support for sending device metadata

Author: zoedt

cisco_aci/datadog_checks/cisco_aci/fabric.py

@@ -4,6 +4,8 @@
 
 from six import iteritems
 
+from datadog_checks.base.utils.serialization import json
+from datadog_checks.cisco_aci.models import DeviceMetadata, Node
 from . import aci_metrics, exceptions, helpers
 
 
@@ -25,6 +27,7 @@ def __init__(self, check, api, instance):
         self.submit_metrics = check.submit_metrics
         self.tagger = self.check.tagger
         self.external_host_tags = self.check.external_host_tags
+        self.ndm_metadata = check.ndm_metadata
 
     def collect(self):
         fabric_pods = self.api.get_fabric_pods()
@@ -70,6 +73,7 @@ def submit_nodes_health(self, nodes, pods):
                 continue
             self.log.info("processing node %s on pod %s", node_id, pod_id)
             try:
+                self.submit_node_metadata(node_attrs, tags)
                 self.submit_process_metric(n, tags + self.check_tags + user_tags, hostname=hostname)
             except (exceptions.APIConnectionException, exceptions.APIParsingException):
                 pass
@@ -209,3 +213,34 @@ def get_fabric_type(self, obj_type):
             return 'pod'
         if obj_type == 'l1PhysIf':
             return 'port'
+
+    def submit_node_metadata(self, node_attrs, tags):
+        vendor = 'cisco_aci'
+        namespace='default'
+        node = Node(attributes=node_attrs)
+        id_tags = [
+            f'namespace:{namespace}',
+            f'system_ip:{node.attributes.address}'
+        ]
+        device_tags = [
+            f'device_vendor:{vendor}',
+            f'device_namespace:{namespace}',
+            f'device_hostname:{node.attributes.dn}',
+            f'hostname:{node.attributes.dn}',
+            f'system_ip:{node.attributes.address}',
+            f'device_ip:{node.attributes.address}',
+            f'device_id:{namespace}:{node.attributes.address}',
+        ]
+        device = DeviceMetadata(
+            device_id=f'{namespace}:{node.attributes.address}',
+            id_tags=id_tags,
+            tags=device_tags + tags,
+            name=node.attributes.dn,
+            ip_address=node.attributes.address,
+            model=node.attributes.model,
+            adSt=node.attributes.adSt,
+            vendor=vendor,
+            version=node.attributes.version,
+            serial_number=node.attributes.serial
+        )
+        self.ndm_metadata(json.dumps(device.model_dump()))

cisco_aci/datadog_checks/cisco_aci/models.py

@@ -0,0 +1,35 @@
+from pydantic import BaseModel, Field, computed_field
+
+class NodeAttributes(BaseModel):
+    address: str | None = None
+    adSt: str | None = None
+    role: str | None = None
+    dn: str | None = None
+    model: str | None = None
+    version: str | None = None
+    serial: str | None = None
+    vendor: str | None = Field(default='cisco_aci')
+    namespace: str | None = Field(default='default')
+
+class Node(BaseModel):
+    attributes: NodeAttributes
+
+class DeviceMetadata(BaseModel):
+    device_id: str | None = Field(default=None)
+    id_tags: list = Field(default_factory=list)
+    tags: list = Field(default_factory=list)
+    name: str | None = Field(default=None) 
+    ip_address: str | None = Field(default=None)
+    model: str | None = Field(default=None)
+    adSt: str | None = Field(default=None, exclude=True)
+    vendor: str | None = Field(default=None)
+    version: str | None = Field(default=None)
+    serial_number: str | None = Field(default=None)
+
+    @computed_field
+    @property
+    def status(self) -> int:
+        return 1 if self.adSt=='on' else 2
+
+class DeviceMetadataList(BaseModel):
+    device_metadata: list = Field(default_factory=list)

datadog_checks_base/datadog_checks/base/checks/base.py

@@ -662,6 +662,12 @@ def database_monitoring_metadata(self, raw_event):
 
         aggregator.submit_event_platform_event(self, self.check_id, to_native_string(raw_event), "dbm-metadata")
 
+    def ndm_metadata(self, raw_event):
+        # type: (str) -> None
+        if raw_event is None:
+            return
+        aggregator.submit_event_platform_event(self, self.check_id, to_native_string(raw_event), "ndm")
+
     def should_send_metric(self, metric_name):
         return not self._metric_excluded(metric_name) and self._metric_included(metric_name)