# Monitoring your Network ## Overview You probably want to monitor the traffic and connections in your network. There are three primary ways to do this with Netmaker: {% stepper %} {% step %} ### The built-in Metrics dashboard Use the Netmaker web UI (Professional / Enterprise Edition) to view aggregated metrics collected by the netmaker server from netclients. {% endstep %} {% step %} ### A Prometheus exporter and a Grafana dashboard template Export metrics to Prometheus using the netmaker exporter, then visualize with Grafana (dashboard JSON can be imported). {% endstep %} {% step %} ### View network data directly on devices using WireGuard features Use wireguard-tools (wg show) on client systems to inspect per-peer bytes, handshakes, and other WireGuard statistics locally. {% endstep %} {% endstepper %} In this section, we overview how to use these features. ## Monitoring Network Stats with the Metrics Dashboard The netmaker server collects metrics from netclients and provides aggregated views inside the Netmaker web UI. This feature is available in Netmaker Professional / Enterprise Edition. Steps to access: * Log into the Netmaker dashboard. * Navigate to the specific network from the Networks tab. * Click the Metrics tab. ![](https://docs.netmaker.io/docs/operations-guide/Base64-Image-Removed) Available metric pages: * Connectivity status: overview of which hosts can establish connectivity with each other. ![](https://docs.netmaker.io/docs/operations-guide/Base64-Image-Removed) * Example: host “centos-userspace” can connect with “ubuntu20-04”; “fedora” cannot connect with “relayed”. ![](https://docs.netmaker.io/docs/operations-guide/Base64-Image-Removed) * Latency: round-trip time (ms) between hosts (e.g., 149ms between “centos-userspace” and “ubuntu20-04”). ![](https://docs.netmaker.io/docs/operations-guide/Base64-Image-Removed) * Bytes Sent: amount of data sent from hosts on the left to hosts on the top. ![](https://docs.netmaker.io/docs/operations-guide/Base64-Image-Removed) * Example: “390.56 MiB” sent from “Ubuntu20-04” to “centos-userspace” (so centos-userspace received 390.56 MiB). * Bytes Received: amount of data received on hosts on the left from hosts on the top. ![](https://docs.netmaker.io/docs/operations-guide/Base64-Image-Removed) * Example: “313.73 MiB” received on “Ubuntu20-04” from “centos-userspace” (so centos-userspace sent 313.73 MiB). * Uptime: uptime percentage for the connection between two hosts. ![](/files/40730f3b22cc72d83d9c5b16cc2b4c4c97f309aa) * Example: “Ubuntu20-04” ↔ “centos-userspace” uptime is “100.00%”. * Clients: connection status, uptime, latency, total data sent/received for static external clients under a Remote Access Gateway. ![](https://docs.netmaker.io/docs/operations-guide/Base64-Image-Removed) These metrics are available in Netmaker Professional / Enterprise Edition via the Netmaker web UI. ## Exporting Metrics via Prometheus The netmaker exporter plugin fetches statistics from the netmaker server and exposes them in a Prometheus-friendly format. * Default exporter URL (example): * Prometheus can be configured to scrape this exporter URL. ![](/files/ab8dce1efd4ab7524038965177d1f50d5fba43a9) Notes: * Prometheus is installed by default on Netmaker EE installation. * For manual Prometheus installation, see: Accessing the default Prometheus instance (example URL): * * Login: username “Netmaker-Prometheus”, password is your Netmaker EE license key. ![](/files/db6cc1ef90120f304dbb7258757d7647d08cde40) Inside Prometheus: * Status -> Configuration: confirms netmaker-exporter is added as a scrape config (configured in prometheus.yml). ![](/files/26cefbd1af7beae1ab8a8c9e4fd3783bf90d6f1b) * Status -> Targets: shows the netmaker-exporter endpoint status and details. ![](/files/f61ac415d90d75f0e952ca8c2d842c5fcb77933c) ## Importing Metrics via Grafana Grafana visualizes metrics stored in Prometheus. Netmaker EE installs a Grafana instance by default. * Official Grafana install guide: * Default Grafana URL (example): * Default login: admin / admin (you will be prompted to set a new password after first login). ![](/files/ef9a10b35d735efa8b0d0ae5af080f9c4996d75a) Adding Prometheus as a data source: * Open the Grafana menu -> Connections (Data Sources). * Search for Prometheus and create a Prometheus data source. * Configure the name, Prometheus endpoint/server URL, authentication, etc. * Click “Save & Test”. ![](/files/49d401e8a1770152081d0ca809717bfe2e1d274c) Notes: * The default Grafana installed with Netmaker EE already has the netmaker Prometheus instance added as a data source. ![](/files/4656bfc9ab490400bfe23e8a9273dfd8cbb51eae) Netmaker dashboard: * Netmaker EE installs a default Netmaker Grafana dashboard. * This dashboard shows the same metrics available in the Netmaker web UI. ![](/files/b081563c8d84aff433dfc517c23e6e0ed523b1ae) ![](/files/806bed7ddb34092f321018519f9e13b8f4b84584) Exporting/importing the dashboard JSON: * Inside the Netmaker metrics dashboard, open dashboard settings (gear icon) -> JSON Model and copy the JSON. * In another Grafana instance: Dashboards -> New -> Import -> paste JSON -> Load to add the dashboard. ![](/files/88e6a6e6a0884991824daac663109ebf4d057bc7) ![](/files/e55a52ea68a32490ba9ff8e140ecd0323a4f8c97) ![](/files/d9c669846a3948fa25dc3f70468696dbdcd59751) ## Using WireGuard to Check Network Statistics on Devices If wireguard-tools is installed on client systems, you can view WireGuard interface statistics gathered by the netclient. Install on Debian/Ubuntu: * sudo apt install wireguard-tools Run: * wg show This displays: * bytes sent and received per peer * latest handshake time * other WireGuard details ![](/files/a955a1cf157bdc1cbe7eb02fde2296ecf7269bb6) These metrics are part of what the netclient collects for the Netmaker web UI and the Prometheus exporter. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://learn.netmaker.io/getting-started/operations-field-guide/monitoring-your-network.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.