Metrics

Netmaker Pro offers analytics. With Analytics, admin users can view connectivity, latency and data transferred between two peers or nodes on a Netmaker network. Client analytics are also available. All of this data may be visualised in the Netmaker UI. In addition, Netmaker includes a custom exporter for Prometheus/Grafana integration to view the data as well.

circle-info

Metrics currently relies on ICMP to be allowed between nodes.

Below are the steps to view Analytics on your Netmaker Pro instance.

1

View network metrics in the Netmaker Dashboard

To view the metrics in the Netmaker Dashboard:

  • Select a network.

  • Click the Analytics interface.

  • Switch to any metric you are interested in, including metrics from clients.

circle-info

Metrics may take up to 5 minutes for nodes to report data.

If present, an analytics image for the dashboard will appear here.

2

Grafana Dashboard

If your Netmaker instance includes the Prometheus/Grafana setup and is configured with the METRICS_EXPORTER="on", you can also view your metrics via Grafana.

Access details example:

URL: "https://grafana.<YOUR_DOMAIN_NAME>"
Username: "admin"
Password: "admin"

Out-of-the-box Netmaker Grafana options include:

  • Netmaker Metrics Dashboard

  • Netmaker Network Graph

Netmaker Grafana Dashboards

The Netmaker Metrics Dashboard lets you select and view data on individual nodes.

Netmaker Grafana View 1

The Netmaker Network Graph view shows a network graph where you can hover nodes to see node statistics and hover edges to view connection information. Edge colors vary by connection status (green = connected, red = disconnected).

Netmaker Grafana View 2
3

Prometheus Dashboard

You can also view your metrics on the Prometheus dashboard. On first visit you may be prompted for credentials.

Access details example:

URL: "https://prometheus.<YOUR_DOMAIN_NAME>"
Username: "Netmaker-Prometheus"
Password: "<YOUR_LICENSE_KEY>"

Last updated

Was this helpful?