From f4c15053b36caf047ec69bcb18f8ccb0fe333803 Mon Sep 17 00:00:00 2001 From: M.Gergő Date: Tue, 18 Sep 2018 10:24:22 +0200 Subject: Munin monitoring script of Ubiquiti Unifi Wireless network. --- .description-html | 8 ++++---- .gitignore | 1 + README.md | 32 ++++++++++++++++++++------------ img/munin-netw.png | Bin 0 -> 37106 bytes img/munin-ssid.png | Bin 0 -> 36615 bytes ubnt_unifi.php | 3 ++- 6 files changed, 27 insertions(+), 17 deletions(-) create mode 100644 img/munin-netw.png create mode 100644 img/munin-ssid.png diff --git a/.description-html b/.description-html index d59cff1..42a3f37 100644 --- a/.description-html +++ b/.description-html @@ -2,18 +2,18 @@ - unifimunin.git + unifi-munin.git

unifimunin.git

You should clone the repository first, because the raw reading is not allowed here!
-( #>> git clone http://git.bmrg.hu/unifimunin.git )

+( #>> git clone http://git.bmrg.hu/unifi-munin.git )
-

In browserable format:
https://github.com/EpeR1/unifimunin

+

In browserable format:
https://github.com/EpeR1/unifi-munin

-
+
diff --git a/.gitignore b/.gitignore index 178261d..d02fec0 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ .description + diff --git a/README.md b/README.md index 6c38edf..f39e6f6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ -This is a [Munin](http://munin-monitoring.org/) plugin to monitor your [Ubiquity Unifi](https://www.ubnt.com/products/#unifi) wireless network status. +This is a [Munin](http://munin-monitoring.org/) plugin to monitor your [Ubiquiti Unifi](https://www.ubnt.com/products/#unifi) wireless network status. It uses SNMP v2 to get network data. +**The original version of this repo is aviable here: [http://git.bmrg.hu/unifi-munin.git](http://git.bmrg.hu/unifi-munin.git/)** + +. + ## Usage unifi_munin - Munin plugin to monitor UBNT unifi wireless APs @@ -13,13 +17,17 @@ Network usage -## Installation on Debian +## Installing on Debian 1) Copy the **ubnt_unifi.php** into the **/usr/share/munin/plugins/** folder. 2) Set the rights: - `chmod 755 /usr/share/munin/plugins/ubnt_unifi.php` + + chmod 755 /usr/share/munin/plugins/ubnt_unifi.php + 3) Create a symlink to this file: - `ln -s /usr/share/munin/plugins/ubnt_unifi.php /etc/munin/plugins/ubnt_unifi` + + ln -s /usr/share/munin/plugins/ubnt_unifi.php /etc/munin/plugins/ubnt_unifi + 4) Edit the **/etc/munin/plugin-conf.d/munin-node** file, and add the following configuration lines. 5) Test the plugin with the `munin-run ubnt_unifi` command. @@ -27,13 +35,13 @@ Network usage The following environment variables are used: -` [ubnt_unifi] ` -` timeout` - Munin-update timeout for this plugin. -` env.controller` - The unifi controller hostname/ip. -` env.devices` - A "space" separated list of the hostnames or IP addresses of wireless APs. -` env.timeout` - The maximum timeout in milliseconds of SNMP requests. (Be careful of munin max update time!). -` env.retry` - Number of retry after failed/time out SNMP requets. -` env.devnetw` - The network of the APs. (It is expreimental yet.) + [ubnt_unifi] + timeout - Munin-update timeout for this plugin. + env.controller - The unifi controller hostname/ip. + env.devices - A "space" separated list of the hostnames or IP addresses of wireless APs. + env.timeout - The maximum timeout in milliseconds of SNMP requests. (Be careful of munin max update time!). + env.retry - Number of retry after failed/time out SNMP requets. + env.devnetw - The network of the APs. (It is expreimental yet.) Configuration example for Munin: @@ -52,7 +60,7 @@ Configuration example for Munin: ### AUTHOR -Copyright (C) 2018 Gergő M. +Copyright (C) 2018 Gergő J. Miklós. diff --git a/img/munin-netw.png b/img/munin-netw.png new file mode 100644 index 0000000..fd825bd Binary files /dev/null and b/img/munin-netw.png differ diff --git a/img/munin-ssid.png b/img/munin-ssid.png new file mode 100644 index 0000000..a4ec8b5 Binary files /dev/null and b/img/munin-ssid.png differ diff --git a/ubnt_unifi.php b/ubnt_unifi.php index aa4c315..12ba5f1 100644 --- a/ubnt_unifi.php +++ b/ubnt_unifi.php @@ -1,11 +1,12 @@ #!/usr/bin/php