Skip to content

Commit 7cd13ee

Browse files
[DOCS-12421] Network Devices GeoMap (#32854)
* adding params * updating screenshots for topology * adding landing page info * add overview and troubleshooting * adding mappings * last update today * adjusting setup * add video * fix decimal degrees and add link * feedback from PM * Apply suggestions from code review Co-authored-by: Joe Peeples <joe.peeples@datadoghq.com> * incorporating feedback from Joes review * update references to geomap tag; replace with geolocation tag * new screenshot * fix screenshot * final screenshot fix * adding table with examlples * rename image * replace image --------- Co-authored-by: Joe Peeples <joe.peeples@datadoghq.com>
1 parent e63aaef commit 7cd13ee

File tree

16 files changed

+139
-12
lines changed

16 files changed

+139
-12
lines changed

config/_default/menus/main.en.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3676,10 +3676,10 @@ menu:
36763676
parent: ndm
36773677
identifier: ndm_profiles
36783678
weight: 304
3679-
- name: Device Topology Map
3680-
url: network_monitoring/devices/device_topology_map
3679+
- name: Maps
3680+
url: network_monitoring/devices/topology
36813681
parent: ndm
3682-
identifier: ndm_topology_map
3682+
identifier: ndm_network_maps
36833683
weight: 305
36843684
- name: SNMP Metrics Reference
36853685
url: network_monitoring/devices/data

config/_default/params.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ code_language_ids:
141141
traces: "Traces"
142142
metrics: "Metrics"
143143
logs: "Logs"
144+
topology: "Topology Map"
145+
geomap: "Geomap"
144146
branch: ""
145147

146148
signupclass: sign-up-trigger

content/en/network_monitoring/devices/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Network Device Monitoring (NDM) gives you visibility into your on-premises and v
3838
{{< nextlink href="network_monitoring/devices/getting_started" >}}<u>Getting Started</u>: Getting started with Network Device Monitoring{{< /nextlink >}}
3939
{{< nextlink href="network_monitoring/devices/supported_devices" >}}<u>Supported devices</u>: View supported NDM devices{{< /nextlink >}}
4040
{{< nextlink href="network_monitoring/devices/snmp_metrics?tab=snmpv2" >}}<u>SNMP Metrics</u>: Collect SNMP Metrics from your network devices {{< /nextlink >}}
41-
{{< nextlink href="network_monitoring/devices/device_topology_map" >}}<u>Device Topology Map</u>: View your network's physical connections{{< /nextlink >}}
41+
{{< nextlink href="network_monitoring/devices/topology" >}}<u>Device Maps</u>: View your network's physical and geographical connections{{< /nextlink >}}
4242
{{< nextlink href="network_monitoring/devices/guide/device_profiles/" >}}<u>SNMP Profile Manager </u>: Getting started with device profiles{{< /nextlink >}}
4343
{{< nextlink href="network_monitoring/devices/integrations/" >}}<u>Integrations </u>: Supported NDM Integrations{{< /nextlink >}}
4444
{{< /whatsnext >}}
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
2+
---
3+
title: Device Geomap
4+
code_lang: geomap
5+
type: multi-code-lang
6+
code_lang_weight: 1
7+
further_reading:
8+
- link: "https://www.datadoghq.com/blog/visualize-network-device-topology/"
9+
tag: "Blog"
10+
text: "Visualize relationships across your on-premise network with the Device Topology Map"
11+
- link: "/network_monitoring/devices/data"
12+
tag: "Documentation"
13+
text: "Data Collected with Network Device Monitoring"
14+
- link: "https://www.datadoghq.com/blog/monitor-snmp-with-datadog/"
15+
tag: "Blog"
16+
text: "Monitor SNMP with Datadog"
17+
---
18+
19+
## Overview
20+
21+
[Device Geomap][1] displays the geographic distribution of your network devices discovered through Network Device Monitoring (NDM). Using the [Geomap Widget points visualization][11], it plots devices on a geographical map based on their configured locations, allowing you to visualize site coverage, assess connectivity, and monitor regional network health. Use it to identify device outages, latency issues, or coverage gaps across distributed environments.
22+
23+
{{< img src="network_device_monitoring/geomap/device_geomap.png" alt="Network Device Geomap tab displaying the location of mapped devices." style="width:100%;" >}}
24+
25+
### Prerequisites
26+
27+
- [Network Device Monitoring][2] must be configured on your devices.
28+
- Devices must be tagged using the `geolocation:<value>` format, where `<value>` is the location identifier.
29+
30+
## Configuring locations
31+
32+
Devices appear on the Device Geomap when they're tagged with `geolocation:<value>` and mapped to geographic coordinates.
33+
34+
For example:
35+
| Geolocation | Latitude | Longitude |
36+
|---------------|----------|-----------|
37+
| nyc-office | 40.758896| -73.98513 |
38+
| denver-office | 39.7433 | -104.9886 |
39+
| boston-office | 42.3601 | -71.0589 |
40+
| singapore | 1.3521 | 103.8198 |
41+
42+
Configure device locations using the following steps:
43+
44+
1. Tag devices using the `geolocation:<value>` format, where `<value>` is the location identifier. See the [network device tagging][4] documentation for more information.
45+
46+
{{< img src="network_device_monitoring/geomap/device_side_panel.png" alt="Network Device side panel of a device, highlighting the `geolocation:boston-office` tag." style="width:100%;" >}}
47+
48+
2. From the Device GeoMap page, click **Add locations** in the top right corner. This opens the [Geomap locations settings][3] page, which provides multiple tabs to manage device locations:
49+
50+
- **All**: Displays all devices with `geolocation` tags, regardless of their mapping status.
51+
- **Needs Coordinates**: Shows devices tagged with `geolocation` values that don't have corresponding location coordinates configured.
52+
- **On Map**: Lists tagged devices with configured coordinates that are displayed on the Geomap.
53+
- **Unused**: Shows location mappings (coordinates) that have been configured but are not associated with any tagged devices.
54+
55+
{{< img src="network_device_monitoring/geomap/settings_on_map.png" alt="Settings page of Device Geomap, highlighting the All tab." style="width:100%;" >}}
56+
57+
3. On the settings page, click **+ Add mapping** and enter the location value along with its latitude and longitude coordinates in [decimal degrees][10] notation.
58+
59+
{{< img src="network_device_monitoring/geomap/add_mapping.png" alt="Settings page of Device Geomap, displaying the Add Mapping screen with fields for location, latitude, and longitude." style="width:80%;" >}}
60+
61+
4. To bulk import locations, select **Import from CSV** from the **+ Add mapping** dropdown. The CSV form provides a template you can download and use.
62+
63+
{{< img src="network_device_monitoring/geomap/mapping_csv.png" alt="Settings page of Device Geomap, displaying the Import from CSV option." style="width:90%;" >}}
64+
65+
## Viewing devices
66+
67+
After devices are added to the map, you can zoom in to click on an individual device or select a device cluster to view all devices in that location. Clicking on any device opens a side panel with detailed device information, including status, tags, and key metrics.
68+
69+
{{< img src="network_device_monitoring/geomap/geomap_device_cluster.mp4" alt="A user zooming in on the map, clicking on a device cluster, and opening the side panel of a device that is unreachable. " video=true >}}
70+
71+
## Troubleshooting
72+
73+
If you experience issues using Device Geomap, use the following troubleshooting guidelines. If you need further assistance, contact [Datadog support][5].
74+
75+
### Device appears in multiple locations
76+
77+
When a device is tagged with multiple `geolocation` tags, it displays at only one location on the map. However, when you click on any device cluster containing that device, it appears in the side panel for all tagged locations.
78+
79+
### CSV upload fails
80+
81+
If your CSV file fails to upload despite appearing correct, verify the following:
82+
83+
- No missing commas between fields
84+
- No extra spaces or special characters
85+
- Proper formatting according to the CSV template (available for download in the **+ Add mapping > Import from CSV** form)
86+
87+
### Tagged device does not appear on map
88+
89+
If a device doesn't appear on the map after tagging:
90+
91+
1. Verify that the location tag has coordinates configured on the [Settings][3] page.
92+
2. Allow a few minutes for tag updates to be reflected in the map.
93+
94+
## Further Reading
95+
96+
{{< partial name="whats-next/whats-next.html" >}}
97+
98+
[1]: https://app.datadoghq.com/devices/maps/geomap
99+
[2]: /network_monitoring/devices/setup#configuration
100+
[3]: https://app.datadoghq.com/devices/settings/geomap
101+
[4]: /network_monitoring/devices/setup#enrich-network-devices-with-tags
102+
[5]: /help
103+
[8]: /network_monitoring/devices/topology
104+
[9]: /network_monitoring/devices/geomap
105+
[10]: https://en.wikipedia.org/wiki/Decimal_degrees
106+
[11]: /dashboards/widgets/geomap/?tab=points

content/en/network_monitoring/devices/device_topology_map.md renamed to content/en/network_monitoring/devices/topology.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
1+
12
---
23
title: Device Topology Map
4+
code_lang: topology
5+
type: multi-code-lang
6+
code_lang_weight: 0
37
aliases:
4-
- /network_monitoring/devices/network_topology_map
8+
- /network_monitoring/devices/network_topology_map
9+
- /network_monitoring/devices/device_topology_map
510
further_reading:
611
- link: "https://www.datadoghq.com/blog/visualize-network-device-topology/"
712
tag: "Blog"
@@ -18,7 +23,7 @@ further_reading:
1823

1924
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.
2025

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" >}}
26+
{{< img src="/network_device_monitoring/network_topology_map/network_topology_map_new_2.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" >}}
2227

2328
## Setup
2429

@@ -43,7 +48,7 @@ Under Group By, use **tags** such as `team`, `service`, and `vendor` to select h
4348

4449
Select the **+ Filter** dropdown to refine which devices are displayed on the Device Topology Map.
4550

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%;" >}}
51+
{{< img src="/network_device_monitoring/network_topology_map/device_topology_filter_3.png" alt="The Device Topology Map with the filter dropdown open." style="width:90%;" >}}
4752

4853
**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.
4954

@@ -59,15 +64,19 @@ By default, the **Unmonitored Device** option is unchecked, which hides devices
5964

6065
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.
6166

62-
You can also view the device's connected interfaces in the **Interfaces** tab:
67+
{{< img src="/network_device_monitoring/network_topology_map/network_topology_map_device_inspect_view_6.png" alt="The Network Device Topology Map with a device selected, displaying information about the device in the side panel." style="width:100%;" >}}
68+
69+
### Link details
70+
71+
Click on a link between devices to explore connection details including traffic volume, bandwidth utilization, errors, and discards, with options to view the data in [Device Overview][10] or [NetFlow Monitoring][11].
6372

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%;" >}}
73+
{{< img src="/network_device_monitoring/network_topology_map/link_details.mp4" alt="A user clicking on a link between devices to open a side panel showing additional link details." video="true" >}}
6574

6675
### View flow details
6776

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].
77+
Click the **NetFlow** 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].
6978

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%;" >}}
79+
{{< img src="/network_device_monitoring/network_topology_map/netflow_tab_3.png" alt="View of the Device side panel, with the NetFlow tab highlighted." style="width:100%;" >}}
7180

7281
### Icon legend
7382

@@ -171,16 +180,26 @@ The connections discovered with LLDP or CDP can correspond to devices already mo
171180

172181
The device resolution can fail if the device is not monitored with NDM, or the LLDP or CDP data is insufficient to match the discovered device to the monitored device.
173182

183+
## Next steps
184+
185+
NDM provides multiple visualization tools to monitor your infrastructure:
186+
187+
- **[Device Geomap][9]**: View the geographic distribution of devices across locations to identify regional issues and coverage gaps.
188+
- **[Device Overview][10]**: Access detailed metrics and performance data for individual devices.
189+
- **[NetFlow Monitoring][1]**: Analyze traffic flows and bandwidth utilization across your network.
174190

175191
## Further Reading
176192

177193
{{< partial name="whats-next/whats-next.html" >}}
178194

179-
180195
[1]: /network_monitoring/netflow/
181196
[2]: https://app.datadoghq.com/devices/maps/topology
182197
[3]: /network_monitoring/devices/snmp_metrics/?tab=snmpv2#autodiscovery
183198
[4]: /network_monitoring/devices/profiles/
184199
[5]: /help
185200
[6]: /network_monitoring/devices/snmp_metrics/?tab=snmpv2#ping
186201
[7]: /datadog_cloudcraft/
202+
[8]: /network_monitoring/devices/topology
203+
[9]: /network_monitoring/devices/geomap
204+
[10]: https://app.datadoghq.com/devices
205+
[11]: https://app.datadoghq.com/devices/netflow
89.7 KB
Loading
924 KB
Loading
254 KB
Loading
Binary file not shown.
119 KB
Loading

0 commit comments

Comments
 (0)