Metrics & Charts

Introduction: Passive vs Active Metrics

This page describes the main metrics collected and displayed in the web interface as charts.

Let's start by dividing the metrics collected by OpenWISP Monitoring in two macro categories:

  1. metrics collected actively by OpenWISP: these metrics are collected by the Active Checks;

  2. metrics collected passively by OpenWISP: these metrics are sent by the OpenWrt Monitoring Agent installed on the network devices and are collected by OpenWISP via its REST API.

Device Status

This metric stores the current status of the device for viewing purposes.

Collected via: OpenWrt Monitoring Agent.

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/device-status-1.png
https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/device-status-2.png
https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/device-status-3.png
https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/device-status-4.png

Ping

Ping Success Rate:

https://github.com/openwisp/openwisp-monitoring/raw/docs/docs/1.1/ping-success-rate.png

Packet loss:

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/packet-loss.png

Round Trip Time:

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/rtt.png

collection:

Ping check

alert:

Ping alert

measurement:

ping

types:

int (reachable and loss), float (rtt)

fields:

reachable, loss, rtt_min, rtt_max, rtt_avg

configuration:

ping

charts:

uptime (Ping Success Rate), packet_loss, rtt

Traffic

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.1/traffic.png

collection:

OpenWrt Monitoring Agent

measurement:

traffic

type:

int

fields:

rx_bytes, tx_bytes

tags:

 
{
    "organization_id": "<organization-id-of-the-related-device>",
    "ifname": "<interface-name>",
    # optional
    "location_id": "<location-id-of-the-related-device-if-present>",
    "floorplan_id": "<floorplan-id-of-the-related-device-if-present>",
}

configuration:

traffic

charts:

traffic

WiFi Clients

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/wifi-clients.png

collection:

OpenWrt Monitoring Agent

measurement:

wifi_clients

type:

int

fields:

clients

tags:

 
{
    "organization_id": "<organization-id-of-the-related-device>",
    "ifname": "<interface-name>",
    # optional
    "location_id": "<location-id-of-the-related-device-if-present>",
    "floorplan_id": "<floorplan-id-of-the-related-device-if-present>",
}

configuration:

clients

charts:

wifi_clients

Memory Usage

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/memory.png

collection:

OpenWrt Monitoring Agent

alert:

Memory Usage Alert

measurement:

memory

type:

float

fields:

percent_used, free_memory, total_memory, buffered_memory, shared_memory, cached_memory, available_memory

configuration:

memory

charts:

memory

CPU Load Averages

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/cpu-load.png

collection:

OpenWrt Monitoring Agent

alert:

CPU Load Average Alert

measurement:

load

type:

float

fields:

cpu_usage, load_1, load_5, load_15

configuration:

load

charts:

load

Disk Usage

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/disk-usage.png

collection:

OpenWrt Monitoring Agent

alert:

Disk Usage Alert

measurement:

disk

type:

float

fields:

used_disk

configuration:

disk

charts:

disk

Mobile Signal Strength

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/signal-strength.png

collection:

OpenWrt Monitoring Agent

measurement:

signal_strength

type:

float

fields:

signal_strength, signal_power

configuration:

signal_strength

charts:

signal_strength

Mobile Signal Quality

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/signal-quality.png

collection:

OpenWrt Monitoring Agent

measurement:

signal_quality

type:

float

fields:

signal_quality, signal_quality

configuration:

signal_quality

charts:

signal_quality

Mobile Access Technology in Use

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/access-technology.png

collection:

OpenWrt Monitoring Agent

measurement:

access_tech

type:

int

fields:

access_tech

configuration:

access_tech

charts:

access_tech

Iperf3

Bandwidth:

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.1/bandwidth.png

Transferred Data:

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.1/transferred-data.png

Retransmits:

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.1/retransmits.png

Jitter:

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.1/jitter.png

Datagram:

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.1/datagram.png

Datagram loss:

https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.1/datagram-loss.png

collection:

Iperf3 Check

measurement:

iperf3

types:
int (iperf3_result, sent_bytes_tcp, received_bytes_tcp, retransmits, sent_bytes_udp, total_packets, lost_packets),
float (sent_bps_tcp, received_bps_tcp, sent_bps_udp, jitter, lost_percent)

fields:
iperf3_result, sent_bps_tcp, received_bps_tcp, sent_bytes_tcp, received_bytes_tcp, retransmits,
sent_bps_udp, sent_bytes_udp, jitter, total_packets, lost_packets, lost_percent

configuration:

iperf3

charts:

bandwidth, transfer, retransmits, jitter, datagram, datagram_loss

For more info on how to configure and use Iperf3, please refer to Configuring Iperf3 Check.

Note

Iperf3 charts uses connect_points=True in default chart configuration that joins it's individual chart data points.