[NDM] Add NDM metadata support for Cisco ACI

cisco_aci/assets/configuration/spec.yaml

@@ -92,6 +92,12 @@ files:
       value:
         type: boolean
         example: False
+    - name: namespace
+      description: |
+        Namespace to be used for devices, interfaces, metrics. If none is specified, will use 'default'.
+      value:
+        type: string
+        example: default
     - template: instances/http
       overrides:
         username.display_priority: 9

cisco_aci/changelog.d/17735.added

@@ -0,0 +1 @@
+[NDM] Add NDM metadata support for Cisco ACI

cisco_aci/datadog_checks/cisco_aci/__init__.py

@@ -3,6 +3,6 @@
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
 from .__about__ import __version__
-from .cisco import CiscoACICheck
+from datadog_checks.cisco_aci.cisco import CiscoACICheck
 
 __all__ = ['__version__', 'CiscoACICheck']

cisco_aci/datadog_checks/cisco_aci/cisco.py

@@ -6,13 +6,12 @@
 from datadog_checks.base import AgentCheck, ConfigurationError
 from datadog_checks.base.config import _is_affirmative
 from datadog_checks.base.utils.containers import hash_mutable
-
-from . import aci_metrics
-from .api import Api
-from .capacity import Capacity
-from .fabric import Fabric
-from .tags import CiscoTags
-from .tenant import Tenant
+from datadog_checks.cisco_aci.aci_metrics import make_tenant_metrics
+from datadog_checks.cisco_aci.api import Api
+from datadog_checks.cisco_aci.capacity import Capacity
+from datadog_checks.cisco_aci.fabric import Fabric
+from datadog_checks.cisco_aci.tags import CiscoTags
+from datadog_checks.cisco_aci.tenant import Tenant
 
 SOURCE_TYPE = 'cisco_aci'
 
@@ -25,7 +24,7 @@ class CiscoACICheck(AgentCheck):
 
     def __init__(self, name, init_config, instances):
         super(CiscoACICheck, self).__init__(name, init_config, instances)
-        self.tenant_metrics = aci_metrics.make_tenant_metrics()
+        self.tenant_metrics = make_tenant_metrics()
         self.last_events_ts = {}
         self.external_host_tags = {}
         self._api_cache = {}
@@ -109,7 +108,7 @@ def check(self, _):
             raise
 
         try:
-            fabric = Fabric(self, api, self.instance)
+            fabric = Fabric(self, api, self.instance, self.instance.get('namespace', 'default'))
             fabric.collect()
         except Exception as e:
             self.log.error('fabric collection failed: %s', e)

cisco_aci/datadog_checks/cisco_aci/config_models/defaults.py

@@ -60,6 +60,10 @@ def instance_min_collection_interval():
     return 15
 
 
+def instance_namespace():
+    return 'default'
+
+
 def instance_persist_connections():
     return False
 

cisco_aci/datadog_checks/cisco_aci/config_models/instance.py

@@ -82,6 +82,7 @@ class InstanceConfig(BaseModel):
     log_requests: Optional[bool] = None
     metric_patterns: Optional[MetricPatterns] = None
     min_collection_interval: Optional[float] = None
+    namespace: Optional[str] = None
     ntlm_domain: Optional[str] = None
     password: Optional[str] = None
     persist_connections: Optional[bool] = None

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

@@ -124,6 +124,11 @@ instances:
     #
     # appcenter: false
 
+    ## @param namespace - string - optional - default: default
+    ## Namespace to be used for devices, interfaces, metrics. If none is specified, will use 'default'.
+    #
+    # namespace: default
+
     ## @param proxy - mapping - optional
     ## This overrides the `proxy` setting in `init_config`.
     ##

cisco_aci/datadog_checks/cisco_aci/fabric.py

@@ -2,21 +2,34 @@
 # All rights reserved
 # Licensed under a 3-clause BSD style license (see LICENSE)
 
-from six import iteritems
+from six import PY3, iteritems
+
+from datadog_checks.base.utils.serialization import json
+
+if PY3:
+    from datadog_checks.cisco_aci.models import DeviceMetadata, Eth, InterfaceMetadata, Node
+else:
+    DeviceMetadata = None
+    Eth = None
+    InterfaceMetadata = None
+    Node = None
 
 from . import aci_metrics, exceptions, helpers
 
+VENDOR_CISCO = 'cisco'
+
 
 class Fabric:
     """
     Collect fabric metrics from the APIC
     """
 
-    def __init__(self, check, api, instance):
+    def __init__(self, check, api, instance, namespace):
         self.check = check
         self.api = api
         self.instance = instance
         self.check_tags = check.check_tags
+        self.namespace = namespace
 
         # grab some functions from the check
         self.gauge = check.gauge
@@ -25,6 +38,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 +84,8 @@ def submit_nodes_health(self, nodes, pods):
                 continue
             self.log.info("processing node %s on pod %s", node_id, pod_id)
             try:
+                if PY3:
+                    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
@@ -94,6 +110,8 @@ def process_eth(self, node):
             eth_attrs = helpers.get_attributes(e)
             eth_id = eth_attrs['id']
             tags = self.tagger.get_fabric_tags(e, 'l1PhysIf')
+            if PY3:
+                self.submit_interface_metadata(eth_attrs, node['address'], tags)
             try:
                 stats = self.api.get_eth_stats(pod_id, node['id'], eth_id)
                 self.submit_fabric_metric(stats, tags, 'l1PhysIf', hostname=hostname)
@@ -209,3 +227,43 @@ def get_fabric_type(self, obj_type):
             return 'pod'
         if obj_type == 'l1PhysIf':
             return 'port'
+
+    def submit_node_metadata(self, node_attrs, tags):
+        node = Node(attributes=node_attrs)
+        id_tags = ['namespace:{}'.format(self.namespace), 'system_ip:{}'.format(node.attributes.address)]
+        device_tags = [
+            'device_vendor:{}'.format(VENDOR_CISCO),
+            'device_namespace:{}'.format(self.namespace),
+            'device_hostname:{}'.format(node.attributes.dn),
+            'hostname:{}'.format(node.attributes.dn),
+            'system_ip:{}'.format(node.attributes.address),
+            'device_ip:{}'.format(node.attributes.address),
+            'id:{}:{}'.format(self.namespace, node.attributes.address),
+        ]
+        device = DeviceMetadata(
+            id='{}:{}'.format(self.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,
+            fabric_st=node.attributes.fabric_st,
+            vendor=VENDOR_CISCO,
+            version=node.attributes.version,
+            serial_number=node.attributes.serial,
+            device_type=node.attributes.device_type,
+        )
+        self.ndm_metadata(json.dumps(device.model_dump()))
+
+    def submit_interface_metadata(self, eth_attr, address, tags):
+        eth = Eth(attributes=eth_attr)
+        interface = InterfaceMetadata(
+            device_id='{}:{}'.format(self.namespace, address),
+            id_tags=tags,
+            index=eth.attributes.id,
+            name=eth.attributes.name,
+            description=eth.attributes.desc,
+            mac_address=eth.attributes.router_mac,
+            admin_status=eth.attributes.admin_st,
+        )
+        self.ndm_metadata(json.dumps(interface.model_dump(exclude_none=True)))

cisco_aci/datadog_checks/cisco_aci/models.py

@@ -0,0 +1,114 @@
+# (C) Datadog, Inc. 2024-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+
+import six
+
+if six.PY3:
+    from typing import Optional
+
+    from pydantic import BaseModel, Field, computed_field, field_validator
+
+    class NodeAttributes(BaseModel):
+        address: Optional[str] = None
+        fabric_st: Optional[str] = Field(default=None, alias="fabricSt")
+        role: Optional[str] = None
+        dn: Optional[str] = None
+        model: Optional[str] = None
+        version: Optional[str] = None
+        serial: Optional[str] = None
+        vendor: Optional[str] = Field(default='cisco-aci')
+        namespace: Optional[str] = Field(default='default')
+
+        @computed_field
+        @property
+        def device_type(self) -> str:
+            if self.role in ['leaf', 'spine']:
+                return 'switch'
+            if self.role in ['controller', 'vleaf', 'vip', 'protection-chain']:
+                return 'cisco_aci'
+            return 'other'
+
+    class Node(BaseModel):
+        attributes: NodeAttributes
+
+    class EthAttributes(BaseModel):
+        admin_st: Optional[str] = Field(default=None, alias="adminSt")
+        id: Optional[str] = None
+        name: Optional[str] = None
+        desc: Optional[str] = None
+        router_mac: Optional[str] = Field(default=None, alias="routerMac")
+
+    class Eth(BaseModel):
+        attributes: EthAttributes
+
+    class DeviceMetadata(BaseModel):
+        id: Optional[str] = Field(default=None)
+        id_tags: list = Field(default_factory=list)
+        tags: list = Field(default_factory=list)
+        name: Optional[str] = Field(default=None)
+        ip_address: Optional[str] = Field(default=None)
+        model: Optional[str] = Field(default=None)
+        fabric_st: Optional[str] = Field(default=None, exclude=True)
+        vendor: Optional[str] = Field(default=None)
+        version: Optional[str] = Field(default=None)
+        serial_number: Optional[str] = Field(default=None)
+        device_type: Optional[str] = Field(default=None)
+        integration: Optional[str] = Field(default='cisco-aci')
+
+        @computed_field
+        @property
+        def status(self) -> int:
+            mapping = {
+                'active': 1,
+                'inactive': 2,
+                'disabled': 5,
+                'discovering': 2,
+                'undiscovered': 2,
+                'unsupported': 2,
+                'unknown': 4,
+            }
+            return mapping.get(self.fabric_st, 7)
+
+    class DeviceMetadataList(BaseModel):
+        device_metadata: list = Field(default_factory=list)
+
+    class InterfaceMetadata(BaseModel):
+        device_id: Optional[str] = Field(default=None)
+        id_tags: list = Field(default_factory=list)
+        index: Optional[str] = Field(default=None)
+        name: Optional[str] = Field(default=None)
+        description: Optional[str] = Field(default=None)
+        mac_address: Optional[str] = Field(default=None)
+        admin_status: Optional[int] = Field(default=None)
+        oper_status: Optional[int] = Field(default=None)
+
+        @field_validator("admin_status", mode="before")
+        @classmethod
+        def parse_admin_status(cls, admin_status: int | None) -> int | None:
+            if not admin_status:
+                return None
+
+            if admin_status == "up":
+                return 1
+            return 2
+
+        @field_validator("oper_status", mode="before")
+        @classmethod
+        def parse_oper_status(cls, oper_status: int | None) -> int | None:
+            if not oper_status:
+                return None
+
+            if oper_status == "up":
+                return 1
+            return 2
+
+    class InterfaceMetadataList(BaseModel):
+        interface_metadata: list = Field(default_factory=list)
+
+    class NetworkDevicesMetadata(BaseModel):
+        subnet: Optional[str] = None
+        namespace: str = None
+        devices: Optional[list[DeviceMetadata]] = Field(default_factory=list)
+        interfaces: Optional[list[InterfaceMetadata]] = Field(default_factory=list)
+        collect_timestamp: Optional[float] = None