Metrics

Device Status

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

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

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

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

Traffic

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
https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/1.1/traffic.png

WiFi Clients

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
https://raw.githubusercontent.com/openwisp/openwisp-monitoring/docs/docs/wifi-clients.png

Memory Usage

measurement:

<memory>

type:

float

fields:

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

configuration:

memory

charts:

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

CPU Load

measurement:

load

type:

float

fields:

cpu_usage, load_1, load_5, load_15

configuration:

load

charts:

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

Disk Usage

measurement:

disk

type:

float

fields:

used_disk

configuration:

disk

charts:

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

Mobile Signal Strength

measurement:

signal_strength

type:

float

fields:

signal_strength, signal_power

configuration:

signal_strength

charts:

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

Mobile Signal Quality

measurement:

signal_quality

type:

float

fields:

signal_quality, signal_quality

configuration:

signal_quality

charts:

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

Mobile Access Technology in Use

measurement:

access_tech

type:

int

fields:

access_tech

configuration:

access_tech

charts:

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

Iperf3

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

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

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.

Passive vs Active Metric Collection

The the different device metric collected by OpenWISP Monitoring can be divided in two categories:

  1. metrics collected actively by OpenWISP: these metrics are collected by the celery workers running on the OpenWISP server, which continuously sends network requests to the devices and store the results;

  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.

The Checks section of the documentation lists the currently implemented active checks.