README
¶
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 Documentation! We're 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 #unpoller channel on the GoLift Discord server. There is also 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, and UnPoller can collect its data!
UnPoller 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!
Supported as of Poller v2.0.2, are Loki and the collection of UniFi events, alarms, anomalies and IDS data. This data can be exported to Loki or InfluxDB, or both!
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.
What does it look like?
There are 12 total dashboards available; the 6 InfluxDB dashboards are very similar to the 6 Prometheus dashboards. On the documentation website you'll find screenshots of some of the dashboards.
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.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
datadogunifi
Package datadogunifi provides the methods to turn UniFi measurements into Datadog data points with appropriate tags and fields.
|
Package datadogunifi provides the methods to turn UniFi measurements into Datadog data points with appropriate tags and fields. |
|
influxunifi
Package influxunifi provides the methods to turn UniFi measurements into influx data-points with appropriate tags and fields.
|
Package influxunifi provides the methods to turn UniFi measurements into influx data-points with appropriate tags and fields. |
|
inputunifi
Package inputunifi implements the poller.Input interface and bridges the gap between metrics from the unifi library, and the augments required to pump them into unifi-poller.
|
Package inputunifi implements the poller.Input interface and bridges the gap between metrics from the unifi library, and the augments required to pump them into unifi-poller. |
|
mysqlunifi
command
|
|
|
poller
Package poller provides the CLI interface to setup unifi-poller.
|
Package poller provides the CLI interface to setup unifi-poller. |
|
promunifi
Package promunifi provides the bridge between unpoller metrics and prometheus.
|
Package promunifi provides the bridge between unpoller metrics and prometheus. |
|
webserver
Package webserver is a UniFi Poller plugin that exports running data to a web interface.
|
Package webserver is a UniFi Poller plugin that exports running data to a web interface. |