Skip to content
Collect ALL UniFi Controller, Site, Device & Client Data - Export to InfluxDB
Go Makefile Shell Dockerfile
Branch: master
Clone or download
Latest commit 2b9b3f9 Oct 9, 2019

README.md

discord twitter grafana pulls DLs

unifi builer stars travis

Collect your UniFi controller data and export it to an InfluxDB instance. Five Grafana Dashboards included; with screenshots. Updated 2019.

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.

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 and Linux. 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, Linux or Docker. It polls a UniFi controller every 30 seconds for measurements and exports the data to an Influx database. A small setup with 2 access points, 1 switch, 1 gateway and 40 clients produces over 3000 fields (metrics).

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, 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

Okay, so here's the deal. 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 believe I've completely rewritten every piece of original code, except the copyright/license file and that's fine with me. 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 and switches. I used to own two UAP-AC-PROs, one USG-3 and one US-24-250W, but have since upgraded a few devices. Many other users have also provided feedback to improve this app, and we have reports of it working on nearly every switch, AP and gateway; UDM included.

What's this data good for?

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. This app is up to five dashboards now!

Update 9/2019

Some new "prometheus exporters" are showing up. I admit I don't know much about Prometheus, but so far the prometheus exporting apps I've seen are missing many data points. Let me know if Prometheus is something you'd like to see support for.

I've also created another forum post you may use to get additional help.

Development

The "What now..." section below used to be a lot longer. I've received a lot of support, feedback and assistance from the community. Many thanks! This app is extremely stable with a tiny memory and cpu footprint. I imagine one day we'll figure out how to make it run on a CloudKey or UDM directly; once I have one personally that will be my goal. In addition to stability, this app provides an intuitive installation and configuration process. Maintenance is a breeze too.

You can control this app with puppet, chef, saltstack, homebrew or a simple bash script if you needed to. It's available for macOS, Linux and Docker. It comes with a systemd service unit that allows you automatically start it up on most Linux hosts. It works just fine on Windows too. Most people prefer Docker, and this app is right at home in that environment.

The UniFi data extraction is provided as an external library, and you can import that code directly without futzing with this application. That means, if you wanted to do something like make telegraf collect your data instead of UniFi Poller you can achieve that with a little bit of Go code. You could write a small app that acts as a telegraf input plugin using the unifi library to grab the data from your controller. As a bonus, all of the code in UniFi Poller is also a library and can be used in other projects.

What now...

We are at a point where the application works as intended, and we are trying to maintain the status quo. Ubiquiti releases updates, things break, we fix it; round and round we go. If you have new hardware or a new controller version, and something is not showing up, please open an Issue so we can fix it.

What's it look like?

There are five total dashboards available. Below you'll find screenshots of a few.

Client Dashboard

UniFi Clients Dashboard Image

USG Dashboard

USG Dashboard Image

UAP Dashboard

UAP Dashboard Image

USW / Switch Dashboard

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

Copyright & License

  • Copyright © 2016 Garrett Bjerkhoel.
  • Copyright © 2018-2019 David Newhall II.
  • See LICENSE for license information.
You can’t perform that action at this time.