[corechecks/snmp] Add id and source_type to Topology Links data (#…

…15184)

Co-authored-by: pducolin <[email protected]>

pkg/collector/corechecks/snmp/internal/metadata/payload.go

@@ -111,6 +111,8 @@ type TopologyLinkSide struct {
 
 // TopologyLinkMetadata contains topology interface to interface links metadata
 type TopologyLinkMetadata struct {
-	Local  *TopologyLinkSide `json:"local,omitempty"`
-	Remote *TopologyLinkSide `json:"remote,omitempty"`
+	ID         string            `json:"id"`
+	SourceType string            `json:"source_type"`
+	Local      *TopologyLinkSide `json:"local"`
+	Remote     *TopologyLinkSide `json:"remote"`
 }

pkg/collector/corechecks/snmp/internal/report/report_device_metadata.go

@@ -25,6 +25,7 @@ import (
 )
 
 const interfaceStatusMetric = "snmp.interface.status"
+const topologyLinkSourceTypeLLDP = "lldp"
 
 // ReportNetworkDeviceMetadata reports device metadata
 func (ms *MetricSender) ReportNetworkDeviceMetadata(config *checkconfig.CheckConfig, store *valuestore.ResultValueStore, origTags []string, collectTime time.Time, deviceStatus metadata.DeviceStatus) {
@@ -306,7 +307,13 @@ func buildNetworkTopologyMetadata(deviceID string, store *metadata.Store, interf
 
 		localInterfaceIDType, localInterfaceID = resolveLocalInterface(deviceID, interfaceIndexByIDType, localInterfaceIDType, localInterfaceID)
 
+		// remEntryUniqueID: The combination of localPortNum and lldpRemIndex is expected to be unique for each entry in
+		//                   lldpRemTable. We don't include lldpRemTimeMark (used for filtering only recent data) since it can change often.
+		remEntryUniqueID := localPortNum + "." + lldpRemIndex
+
 		newLink := metadata.TopologyLinkMetadata{
+			ID:         deviceID + ":" + remEntryUniqueID,
+			SourceType: topologyLinkSourceTypeLLDP,
 			Remote: &metadata.TopologyLinkSide{
 				Device: &metadata.TopologyLinkDevice{
 					Name:        store.GetColumnAsString("lldp_remote.device_name", strIndex),

pkg/collector/corechecks/snmp/profile_metadata_test.go

@@ -564,6 +564,8 @@ profiles:
   ],
   "links": [
         {
+            "id": "profile-metadata:1.2.3.4:101.1",
+            "source_type": "lldp",
             "local": {
                 "device": {
                     "id": "profile-metadata:1.2.3.4",
@@ -590,6 +592,8 @@ profiles:
             }
         },
         {
+            "id": "profile-metadata:1.2.3.4:102.2",
+            "source_type": "lldp",
             "local": {
                 "device": {
                     "id": "profile-metadata:1.2.3.4",

releasenotes/notes/add_id_and_source_type_to_ndm_topology_data-87db2503e46ab4d2.yaml

@@ -0,0 +1,11 @@
+# Each section from every release note are combined when the
+# CHANGELOG.rst is rendered. So the text needs to be worded so that
+# it does not depend on any information only available in another
+# section. This may mean repeating some details, but each section
+# must be readable independently of the other.
+#
+# Each section note must be formatted as reStructuredText.
+---
+enhancements:
+  - |
+    [corechecks/snmp] Add `id` and `source_type` to NDM Topology Links