Adding upstream version 1.12.0.upstream/1.12.0upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

4 files changed, 301 insertions, 0 deletions

diff --git a/collectors/charts.d.plugin/ap/Makefile.inc b/collectors/charts.d.plugin/ap/Makefile.inc
new file mode 100644
index 0000000..a2dd375
--- /dev/null
+++ b/collectors/charts.d.plugin/ap/Makefile.inc
@@ -0,0 +1,13 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# THIS IS NOT A COMPLETE Makefile
+# IT IS INCLUDED BY ITS PARENT'S Makefile.am
+# IT IS REQUIRED TO REFERENCE ALL FILES RELATIVE TO THE PARENT
+
+# install these files
+dist_charts_DATA       += ap/ap.chart.sh
+dist_chartsconfig_DATA += ap/ap.conf
+
+# do not install these files, but include them in the distribution
+dist_noinst_DATA       += ap/README.md ap/Makefile.inc
+
diff --git a/collectors/charts.d.plugin/ap/README.md b/collectors/charts.d.plugin/ap/README.md
new file mode 100644
index 0000000..962a856
--- /dev/null
+++ b/collectors/charts.d.plugin/ap/README.md
@@ -0,0 +1,86 @@
+# Access Point Plugin (ap)
+
+The `ap` collector visualizes data related to access points.
+
+## Example netdata charts
+
+![image](https://cloud.githubusercontent.com/assets/2662304/12377654/9f566e88-bd2d-11e5-855a-e0ba96b8fd98.png)
+
+## How it works
+
+It does the following:
+
+1. Runs `iw dev` searching for interfaces that have `type AP`.
+
+   From the same output it collects the SSIDs each AP supports by looking for lines `ssid NAME`.
+
+   Example:
+```sh
+# iw dev
+phy#0
+        Interface wlan0
+                ifindex 3
+                wdev 0x1
+                addr 7c:dd:90:77:34:2a
+                ssid TSAOUSIS
+                type AP
+                channel 7 (2442 MHz), width: 20 MHz, center1: 2442 MHz
+```
+
+
+2. For each interface found, it runs `iw INTERFACE station dump`.
+
+   From the output is collects:
+
+   - rx/tx bytes
+   - rx/tx packets
+   - tx retries
+   - tx failed
+   - signal strength
+   - rx/tx bitrate
+   - expected throughput
+
+   Example:
+
+```sh
+# iw wlan0 station dump
+Station 40:b8:37:5a:ed:5e (on wlan0)
+        inactive time:  910 ms
+        rx bytes:       15588897
+        rx packets:     127772
+        tx bytes:       52257763
+        tx packets:     95802
+        tx retries:     2162
+        tx failed:      28
+        signal:         -43 dBm
+        signal avg:     -43 dBm
+        tx bitrate:     65.0 MBit/s MCS 7
+        rx bitrate:     1.0 MBit/s
+        expected throughput:    32.125Mbps
+        authorized:     yes
+        authenticated:  yes
+        preamble:       long
+        WMM/WME:        yes
+        MFP:            no
+        TDLS peer:      no
+```
+
+3. For each interface found, it creates 6 charts:
+
+   - Number of Connected clients
+   - Bandwidth for all clients
+   - Packets for all clients
+   - Transmit Issues for all clients
+   - Average Signal among all clients
+   - Average Bitrate (including average expected throughput) among all clients
+
+## Configuration
+
+You can only set `ap_update_every=NUMBER` to `/etc/netdata/charts.d/ap.conf`, to give the data collection frequency.
+To edit this file on your system run `/etc/netdata/edit-config charts.d/ap.conf`.
+
+## Auto-detection
+
+The plugin is able to auto-detect if you are running access points on your linux box.
+
+[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fcollectors%2Fcharts.d.plugin%2Fap%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
diff --git a/collectors/charts.d.plugin/ap/ap.chart.sh b/collectors/charts.d.plugin/ap/ap.chart.sh
new file mode 100644
index 0000000..a2d04c0
--- /dev/null
+++ b/collectors/charts.d.plugin/ap/ap.chart.sh
@@ -0,0 +1,179 @@
+# shellcheck shell=bash
+# no need for shebang - this file is loaded from charts.d.plugin
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# netdata
+# real-time performance and health monitoring, done right!
+# (C) 2016 Costa Tsaousis <costa@tsaousis.gr>
+#
+
+# _update_every is a special variable - it holds the number of seconds
+# between the calls of the _update() function
+ap_update_every=
+ap_priority=6900
+
+declare -A ap_devs=()
+
+# _check is called once, to find out if this chart should be enabled or not
+ap_check() {
+	require_cmd iw || return 1
+	local ev
+	ev=$(run iw dev | awk '
+		BEGIN {
+			i = "";
+			ssid = "";
+			ap = 0;
+		}
+		/^[ \t]+Interface / {
+			if( ap == 1 ) {
+				print "ap_devs[" i "]=\"" ssid "\""
+			}
+
+			i = $2;
+			ssid = "";
+			ap = 0;
+		}
+		/^[ \t]+ssid / { ssid = $2; }
+		/^[ \t]+type AP$/ { ap = 1; }
+		END {
+			if( ap == 1 ) {
+				print "ap_devs[" i "]=\"" ssid "\""
+			}
+		}
+	')
+	eval "${ev}"
+
+	# this should return:
+	#  - 0 to enable the chart
+	#  - 1 to disable the chart
+
+	[ ${#ap_devs[@]} -gt 0 ] && return 0
+	error "no devices found in AP mode, with 'iw dev'"
+	return 1
+}
+
+# _create is called once, to create the charts
+ap_create() {
+	local ssid dev
+
+	for dev in "${!ap_devs[@]}"; do
+		ssid="${ap_devs[${dev}]}"
+
+		# create the chart with 3 dimensions
+		cat <<EOF
+CHART ap_clients.${dev} '' "Connected clients to ${ssid} on ${dev}" "clients" ${dev} ap.clients line $((ap_priority + 1)) $ap_update_every
+DIMENSION clients '' absolute 1 1
+
+CHART ap_bandwidth.${dev} '' "Bandwidth for ${ssid} on ${dev}" "kilobits/s" ${dev} ap.net area $((ap_priority + 2)) $ap_update_every
+DIMENSION received '' incremental 8 1024
+DIMENSION sent '' incremental -8 1024
+
+CHART ap_packets.${dev} '' "Packets for ${ssid} on ${dev}" "packets/s" ${dev} ap.packets line $((ap_priority + 3)) $ap_update_every
+DIMENSION received '' incremental 1 1
+DIMENSION sent '' incremental -1 1
+
+CHART ap_issues.${dev} '' "Transmit Issues for ${ssid} on ${dev}" "issues/s" ${dev} ap.issues line $((ap_priority + 4)) $ap_update_every
+DIMENSION retries 'tx retries' incremental 1 1
+DIMENSION failures 'tx failures' incremental -1 1
+
+CHART ap_signal.${dev} '' "Average Signal for ${ssid} on ${dev}" "dBm" ${dev} ap.signal line $((ap_priority + 5)) $ap_update_every
+DIMENSION signal 'average signal' absolute 1 1000
+
+CHART ap_bitrate.${dev} '' "Bitrate for ${ssid} on ${dev}" "Mbps" ${dev} ap.bitrate line $((ap_priority + 6)) $ap_update_every
+DIMENSION receive '' absolute 1 1000
+DIMENSION transmit '' absolute -1 1000
+DIMENSION expected 'expected throughput' absolute 1 1000
+EOF
+	done
+
+	return 0
+}
+
+# _update is called continuously, to collect the values
+ap_update() {
+	# the first argument to this function is the microseconds since last update
+	# pass this parameter to the BEGIN statement (see bellow).
+
+	# do all the work to collect / calculate the values
+	# for each dimension
+	# remember: KEEP IT SIMPLE AND SHORT
+
+	for dev in "${!ap_devs[@]}"; do
+		echo
+		echo "DEVICE ${dev}"
+		iw "${dev}" station dump
+	done | awk '
+        function zero_data() {
+            dev = "";
+            c = 0;
+            rb = 0;
+            tb = 0;
+            rp = 0;
+            tp = 0;
+            tr = 0;
+            tf = 0;
+            tt = 0;
+            rt = 0;
+            s = 0;
+            g = 0;
+            e = 0;
+        }
+        function print_device() {
+            if(dev != "" && length(dev) > 0) {
+                print "BEGIN ap_clients." dev;
+                print "SET clients = " c;
+                print "END";
+                print "BEGIN ap_bandwidth." dev;
+                print "SET received = " rb;
+                print "SET sent = " tb;
+                print "END";
+                print "BEGIN ap_packets." dev;
+                print "SET received = " rp;
+                print "SET sent = " tp;
+                print "END";
+                print "BEGIN ap_issues." dev;
+                print "SET retries = " tr;
+                print "SET failures = " tf;
+                print "END";
+
+                if( c == 0 ) c = 1;
+                print "BEGIN ap_signal." dev;
+                print "SET signal = " int(s / c);
+                print "END";
+                print "BEGIN ap_bitrate." dev;
+                print "SET receive = " int(rt / c);
+                print "SET transmit = " int(tt / c);
+                print "SET expected = " int(e / c);
+                print "END";
+            }
+            zero_data();
+        }
+        BEGIN {
+            zero_data();
+        }
+        /^DEVICE / {
+            print_device();
+            dev = $2;
+        }
+        /^Station/            { c++; }
+        /^[ \t]+rx bytes:/   { rb += $3; }
+        /^[ \t]+tx bytes:/   { tb += $3; }
+        /^[ \t]+rx packets:/ { rp += $3; }
+        /^[ \t]+tx packets:/ { tp += $3; }
+        /^[ \t]+tx retries:/ { tr += $3; }
+        /^[ \t]+tx failed:/  { tf += $3; }
+        /^[ \t]+signal:/     { x = $2; s  += x * 1000; }
+        /^[ \t]+rx bitrate:/ { x = $3; rt += x * 1000; }
+        /^[ \t]+tx bitrate:/ { x = $3; tt += x * 1000; }
+        /^[ \t]+expected throughput:(.*)Mbps/ {
+            x=$3;
+            sub(/Mbps/, "", x);
+            e += x * 1000;
+        }
+        END {
+            print_device();
+        }
+    '
+
+	return 0
+}
diff --git a/collectors/charts.d.plugin/ap/ap.conf b/collectors/charts.d.plugin/ap/ap.conf
new file mode 100644
index 0000000..38fc157
--- /dev/null
+++ b/collectors/charts.d.plugin/ap/ap.conf
@@ -0,0 +1,23 @@
+# no need for shebang - this file is loaded from charts.d.plugin
+
+# netdata
+# real-time performance and health monitoring, done right!
+# (C) 2018 Costa Tsaousis <costa@tsaousis.gr>
+# GPL v3+
+
+# nothing fancy to configure.
+# this module will run
+# iw dev - to find wireless devices in AP mode
+# iw ${dev} station dump - to get connected clients
+# based on the above, it generates several charts
+
+# the data collection frequency
+# if unset, will inherit the netdata update frequency
+#ap_update_every=
+
+# the charts priority on the dashboard
+#ap_priority=6900
+
+# the number of retries to do in case of failure
+# before disabling the module
+#ap_retries=10