Skip to content

Commit 9eb9506

Browse files
[DOCS-12223] updates to network topology map (#32491)
* updates to network topology map * updating interfaces tab * updates to screenshots and copy * Apply suggestions from code review Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> * incorporating feedback from review * Update content/en/network_monitoring/devices/device_topology_map.md Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com> * small update --------- Co-authored-by: domalessi <111786334+domalessi@users.noreply.github.com>
1 parent ee897c6 commit 9eb9506

File tree

7 files changed

+29
-74
lines changed

7 files changed

+29
-74
lines changed

content/en/network_monitoring/devices/device_topology_map.md

Lines changed: 29 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ further_reading:
1616

1717
## Overview
1818

19-
The [Network Device Topology Map][2] provides an overview of your network's physical connections, so you can more easily identify issues in your devices and understand their upstream and downstream impacts.
19+
The [Network Device Topology Map][2] uses [Cloudcraft][7] diagrams to provide an interactive visual representation of your network's physical connections. The map automatically discovers and displays devices, their interfaces, and the relationships between them. This visualization helps you identify issues in your network devices, understand their upstream and downstream impacts, troubleshoot connectivity problems, and gain insights into how traffic flows through your infrastructure.
2020

21-
{{< img src="/network_device_monitoring/network_topology_map/network_topology_map_search_3.mp4" alt="The network device topology map, with vendor:cisco added to the search bar, and then the Filter nodes box filtered by nyc. A node is selected and the inspect option chosen, showing its connected nodes. One of the connected nodes is then selected, and the inspect option is selected again, displaying additional connected nodes" video="true" >}}
21+
{{< img src="/network_device_monitoring/network_topology_map/network_topology_map_new.mp4" alt="A user adds team, service, and vendor tags to the network device topology map, then selects a device to open its side panel." video="true" >}}
2222

2323
## Setup
2424

@@ -33,46 +33,41 @@ The Datadog Agent version 7.52 and later automatically collects topology data. N
3333

3434
In the Network Topology Map, the following navigation options are available:
3535

36-
### View
36+
### Group by
3737

38-
1. In **View By**, use tags to select how you want to visualize devices:
38+
Under Group By, use **tags** such as `team`, `service`, and `vendor` to select how you want to visualize your devices:
3939

40-
{{< img src="/network_device_monitoring/network_topology_map/device-topology-grouped.png" alt="The navigation option, with view by devices and tags selected, highlighting view by location" style="width:80%;" >}}
40+
{{< img src="/network_device_monitoring/network_topology_map/device-topology-group_by.png" alt="A Group by control showing tags for team, service, and vendor." style="width:80%;" >}}
4141

42-
### Color
42+
### Filter devices
4343

44-
2. Under **Color By**, change how nodes on the Device Topology Map are colored based on:
44+
Select the **+ Filter** dropdown to refine which devices are displayed on the Device Topology Map.
4545

46-
- **Device State**: Display nodes on the Device Topology Map by SNMP reachability.
47-
- **Ping State**: Display nodes on the Device Topology Map by [Ping status][6].
46+
{{< img src="/network_device_monitoring/network_topology_map/device_topology_filter_2.png" alt="The Device Topology Map with the filter dropdown open." style="width:90%;" >}}
4847

49-
{{< img src="/network_device_monitoring/network_topology_map/device-topology-overview-intro.png" alt="The navigation option, with view by color selected, highlighting view by device state" style="width:80%;" >}}
48+
**Note:** The **Filter Devices** setting determines which devices appear on the Device Topology Map for all queries, including those that filter by a device facet in the search bar.
5049

51-
The following are the definitions of the nodes for each color state:
52-
<div style="width:80%; margin: 0 auto;">
50+
### Resources
5351

54-
| Color | Description |
55-
|----------|---------------------------|
56-
| Green | Device is reachable. |
57-
| Red | Issue with device, such as unreachable through SNMP. |
58-
| Gray | Device is monitored by NDM; however, no data has been received. For example, if the ping wasn't configured and you opted to `color by` **Ping State** in the Device Topology Map, the devices are displayed in gray. |
59-
| No color | Shadow devices that are not directly monitored by NDM, but are discoverable through LLDP/CDP from a connected device that NDM is monitoring. You can toggle on/off the [Hide _N_ unmonitored device section](#filter-devices) if you want these devices to be shown on the Device Topology Map. |
52+
Use the **Resource** dropdown to filter the diagram by specific device types, such as Firewalls, Access Points, and Routers.
6053

61-
</div>
54+
{{< img src="/network_device_monitoring/network_topology_map/resources_dropdown.png" alt="The Device Topology Map with the Resources drop-down open, and Unmonitored Device un-checked." style="width:30%;" >}}
6255

63-
### Filter devices
56+
By default, the **Unmonitored Device** option is unchecked, which hides devices that are not directly monitored by Network Device Monitoring but are discovered through LLDP/CDP from adjacent monitored devices. Check this option to display these unmonitored devices on the diagram.
6457

65-
3. Under **Filter Devices**, gain further granular control over what devices are shown on the Device Topology Map.
58+
## Investigating devices
6659

67-
{{< img src="/network_device_monitoring/network_topology_map/device_topology_filter_devices_hide.png" alt="The navigation option, with view filer option selected, toggling by hide unmonitored devices " style="width:80%;" >}}
60+
In addition to showing an overview of your network's physical connections, the Device Topology Map lets you investigate individual devices to understand their connections, flows, and overall status. Hover over a device to see its status and key metrics, or click a device to open a side panel with details such as its IP address, tags, throughput, CPU, and memory.
6861

69-
**Note:** The **Filter Devices** setting impacts what devices are shown on the Device Topology Map for _all_ queries you might make. For example, if you filter by a device facet in the search bar.
62+
You can also view the device's connected interfaces in the **Interfaces** tab:
7063

71-
Hide _N_ Unmonitored Devices - Turned OFF by default.
72-
: Toggling this on hides devices on the Device Topology Map that are not directly monitored by Network Device Monitoring, but still discovered by LLDP/CDP, and shown on the map from adjacent devices that are monitored by Network Device Monitoring.
64+
{{< img src="/network_device_monitoring/network_topology_map/network_topology_map_device_inspect_view_5.png" alt="The Network Device Topology Map with a device selected, displaying information about the device in the side panel." style="width:100%;" >}}
7365

74-
Hide _N_ Unconnected Devices - Turned OFF by default.
75-
: Toggling this on hides any devices that have no link connections. Devices can be unconnected for reasons such as improper configuration, or the device does not support [LLDP/CDP](#troubleshooting).
66+
### View flow details
67+
68+
Click the **Flow** tab in the side panel to explore the device's traffic sources, destinations, and volume. The data is automatically filtered by the device's `@device.ip`. For more information, see [NetFlow Monitoring][1].
69+
70+
{{< img src="/network_device_monitoring/network_topology_map/Netflow_tab.png" alt="View of the Device side panel, with the NetFlow tab highlighted." style="width:100%;" >}}
7671

7772
### Icon legend
7873

@@ -113,46 +108,10 @@ SNMP devices are matched to a representative icon based on their device type in
113108
</tr>
114109
</table>
115110

116-
117-
## Investigating devices
118-
119-
In addition to providing an overview of your network's physical connections, you can investigate individual devices to understand their connections, flows, and overall status. Hovering over a device displays its overall status and key metrics. You can also click on a device to see the following options:
120-
121-
{{< img src="/network_device_monitoring/network_topology_map/network_topology_map_device_inspect_view_3.png" alt="The network device topology map with a device selected, displaying information about the device as well as the options to Inspect, View device details, and view flow details" style="width:80%;" >}}
122-
123-
### Inspect
124-
125-
Choose **Inspect** to see the device's interface connections. Click on any of the connected interfaces for further investigation.
126-
This view shows only the physical interfaces that are actually connected to another device. This means that it shows a subset of the total set of interfaces of a network device.
127-
128-
{{< img src="/network_device_monitoring/network_topology_map/ndm_topology_interface_updated.png" alt="The Inspect view of an individual device, displaying the device's interface connections" style="width:80%;" >}}
129-
130-
### View device details
131-
132-
Choose **View device details** to see information such as the device's IP address and tags, as well as data related to throughput, CPU, and memory.
133-
134-
{{< img src="/network_device_monitoring/network_topology_map/network_topology_device_details_2.png" alt="The View device details tab of an individual device" style="width:80%;" >}}
135-
136-
From this view, you can also view the device's connected interfaces in the **Connected Interfaces** tab.
137-
138-
{{< img src="/network_device_monitoring/network_topology_map/network_topology_map_devices_interface_2.png" alt="The View device details tab of an individual device with the Interfaces tab selected" style="width:80%;" >}}
139-
140-
### View flow details
141-
142-
Choose **View flow details** to open the NetFlow tab filtered by the device's `@device.ip` for a detailed exploration of the device's sources, destinations, and volume. See the [NetFlow Monitoring][1] page for more information.
143-
144111
## Troubleshooting
145112

146113
If you experience issues using the Network Topology Map, use the following troubleshooting guidelines. If you need further assistance, contact [Datadog support][5].
147114

148-
### Missing topology data message box
149-
150-
{{< img src="/network_device_monitoring/network_topology_map/missing_topology_map.png" alt="The missing topology data message that is displayed when the rendered map has no links" style="width:80%;" >}}
151-
152-
This message is displayed when the rendered map has no links.
153-
154-
**Note**: Since the "Hide _N_ Unconnected Devices" toggle is enabled by default, this message displays with an empty map.
155-
156115
### Empty map message
157116

158117
{{< img src="/network_device_monitoring/network_topology_map/no_devices_found.png" alt="The no devices found message that is displayed when NDM is either not configured or because of filtering." style="width:80%;" >}}
@@ -163,13 +122,9 @@ There are no devices because NDM is not configured.
163122

164123
{{< img src="/network_device_monitoring/network_topology_map/no_connections_found.png" alt="The no devices found message that is displayed when NDM is either not configured or because of filtering." style="width:80%;" >}}
165124

166-
- Turn the "Hide _N_ Unconnected Devices" toggle off to show the isolated devices.
125+
- Turn the **Unmonitored Device** selection on to show the unmonitored devices.
167126
- Use categorization tag to help understand your map view with information hierarchy.
168127

169-
### Empty map/ no monitored devices
170-
171-
- Ensure the "Hide _N_ Unconnected Devices" toggle is off.
172-
173128
### Missing devices/connections
174129

175130
The Device Topology Map data is based on LLDP (Link Layer Discovery Protocol) and CDP (Cisco Discovery Protocol) information collected with SNMP. If your map is missing devices and/or connections, ensure the following:
@@ -191,18 +146,17 @@ sudo -u dd-agent datadog-agent snmp walk <DEVICE_IP> 1.3.6.1.4.1.9.9.23
191146

192147
### Missing connections or links
193148

194-
If your device is exposing topology data with LLDP or CDP but some of the connections are missing, ensure that the "Hide _N_ Unmonitored Devices" toggle is off.
195-
If you are using tags to filter nodes on the map, ensure the "Show one hop away on filter" toggle is on to see the connected nodes.
149+
If your device is exposing topology data with LLDP or CDP but some of the connections are missing, ensure that the **Unmonitored Device** selection is off.
196150

197-
### Un-monitored devices showing on map
151+
### Unmonitored devices showing on map
198152

199153
The Device Topology Map shows all devices discovered with LLDP or CDP. These can be new devices that are not already monitored with SNMP or existing devices that were not [resolved](#device-resolution) to the equivalent monitored device.
200-
You can use the "Hide _N_ Unmonitored Devices" toggle to hide these nodes.
154+
You can use the **Unmonitored Device** selection to hide these nodes.
201155

202156
### Device duplicated on map
203157

204158
The Device Topology Map shows all devices discovered with LLDP and/or CDP. In some cases, these devices are already monitored with SNMP but can not be [resolved](#device-resolution) to the equivalent monitored device. In this case, the device is shown twice: one node representing the monitored device and one node representing the LLDP/CDP discovered device.
205-
Use the "Hide _N_ Unmonitored Devices" toggle to hide the unmonitored nodes.
159+
Use the **Unmonitored Device** selection to hide the unmonitored nodes.
206160

207161
### Borderless or black nodes on the map
208162

@@ -224,8 +178,9 @@ The device resolution can fail if the device is not monitored with NDM, or the L
224178

225179

226180
[1]: /network_monitoring/netflow/
227-
[2]: https://app.datadoghq.com/devices?viewTab=topology
181+
[2]: https://app.datadoghq.com/devices/maps/topology
228182
[3]: /network_monitoring/devices/snmp_metrics/?tab=snmpv2#autodiscovery
229183
[4]: /network_monitoring/devices/profiles/
230184
[5]: /help
231185
[6]: /network_monitoring/devices/snmp_metrics/?tab=snmpv2#ping
186+
[7]: /datadog_cloudcraft/
983 KB
Loading
37.5 KB
Loading
1.39 MB
Loading
1.29 MB
Loading
Binary file not shown.
55.8 KB
Loading

0 commit comments

Comments
 (0)