unifi-poller

by unifi-poller

unifi-poller / unifi-poller

Application: Collect ALL UniFi Controller, Site, Device & Client Data - Export to InfluxDB or Promet...

728 Stars 70 Forks Last release: 4 months ago (v2.0.1) MIT License 795 Commits 35 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

discord twitter grafana pulls DLs

unifi builer stars travis

Collect your UniFi controller data and report it to an InfluxDB instance, or export it for Prometheus collection. Twelve Grafana Dashboards included; with screenshots. Six for InfluxDB and six for Prometheus.

Installation

See the Wiki! We have a special place for Docker Users. I'm willing to help if you have troubles. Open an Issue and we'll figure out how to get things working for you. You can also get help in the #unifi-poller channel on the Ubiquiti Discord server. I've also provided a forum post you may use to get additional help.

Description

Ubiquiti makes networking devices like switches, gateways (routers) and wireless access points. They have a line of equipment named UniFi that uses a controller to keep stats and simplify network device configuration. This controller can be installed on Windows, macOS, FreeBSD, Linux or Docker. Ubiquiti also provides a dedicated hardware device called a CloudKey that runs the controller software. More recently they've developed the Dream Machine; it's still in beta / early access, but UniFi Poller can collect its data!

UniFi Poller is a small Golang application that runs on Windows, macOS, FreeBSD, Linux or Docker. In Influx-mode it polls a UniFi controller every 30 seconds for measurements and exports the data to an Influx database. In Prometheus mode the poller opens a web port and accepts Prometheus polling. It converts the UniFi Controller API data into Prometheus exports on the fly.

This application requires your controller to be running all the time. If you run a UniFi controller, there's no excuse not to install Influx or Prometheus, Grafana and this app. You'll have a plethora of data at your fingertips and the ability to craft custom graphs to slice the data any way you choose. Good luck!

Backstory

I found a simple piece of code on GitHub that sorta did what I needed; we all know that story. I wanted more data, so I added more data collection. I probably wouldn't have made it this far if Garrett hadn't written the original code I started with. Many props my man. The original code pulled only the client data. This app now pulls data for clients, access points, security gateways, dream machines and switches.

I've been trying to get my UAP data into Grafana. Sure, google search that. You'll find this. What if you don't want to deal with SNMP? Well, here you go. I've replicated 400% of what you see on those SNMP-powered dashboards with this Go app running on the same mac as my UniFi controller. All without enabling SNMP nor trying to understand those OIDs. Mad props to waterside for making this dashboard; it gave me a fantastic start to making my own dashboards.

Operation

You can control this app with puppet, chef, saltstack, homebrew or a simple bash script if you needed to. Packages are available for macOS, Linux, FreeBSD and Docker. It works just fine on Windows too. Most people prefer Docker, and this app is right at home in that environment.

What's it look like?

There are 12 total dashboards available; the 6 InfluxDB dashboards are very similar to the 6 Prometheus dashboards. Below you'll find screenshots of the first four dashboards.

Client Dashboard (InfluxDB)

UniFi Clients Dashboard Image

USG Dashboard (InfluxDB)

USG Dashboard Image

UAP Dashboard (InfluxDB)

UAP Dashboard Image

USW / Switch Dashboard (InfluxDB)

You can drill down into specific sites, switches, and ports. Compare ports in different sites side-by-side. So easy! This screenshot barely does it justice. USW Dashboard Image

Integrations

The following fine folks are providing their services, completely free! These service integrations are used for things like storage, building, compiling, distribution and documentation support. This project succeeds because of them. Thank you!

Copyright & License

  • Copyright © 2018-2020 David Newhall II.
  • See LICENSE for license information.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.