Skip to content

Prometheus exporter that exposes metrics from a Ubiquiti UniFi Controller and UniFi devices. MIT Licensed.

License

Notifications You must be signed in to change notification settings

akramer/unifi_exporter

 
 

Repository files navigation

unifi_exporter GoDoc Build Status Coverage Status

Command unifi_exporter provides a Prometheus exporter for a Ubiquiti UniFi Controller API and UniFi devices.

Package unifiexporter provides the Exporter type used in the unifi_exporter Prometheus exporter.

MIT Licensed.

Usage

Available flags for unifi_exporter include:

$ ./unifi_exporter -h
Usage of ./unifi_exporter:
  -telemetry.addr string
        host:port for UniFi exporter (default ":9130")
  -telemetry.path string
        URL path for surfacing collected metrics (default "/metrics")
  -unifi.addr string
        address of UniFi Controller API
  -unifi.insecure
        [optional] do not verify TLS certificate for UniFi Controller API (warning: please use carefully)
  -unifi.password string
        password for authentication against UniFi Controller API
  -unifi.site string
        [optional] description of site to collect metrics for using UniFi Controller API; if none specified, all sites will be scraped
  -unifi.timeout duration
        [optional] timeout for UniFi Controller API requests (default 5s)
  -unifi.username string
        username for authentication against UniFi Controller API

An example of using unifi_exporter with authentication:

$ ./unifi_exporter -unifi.addr https://unifi.example.com:8443/ -unifi.username admin -unifi.password password
2016/02/24 13:41:34 Starting UniFi exporter on ":9130" for site(s): Foo, Bar, Baz

Sample

Here is a screenshot of a sample dashboard created using grafana with metrics from exported from unifi_exporter.

sample

Thanks

Special thanks to Vaibhav Bhembre for his work on ceph_exporter. ceph_exporter was used frequently as a reference Prometheus exporter while implementing unifi_exporter.

About

Prometheus exporter that exposes metrics from a Ubiquiti UniFi Controller and UniFi devices. MIT Licensed.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 99.8%
  • Makefile 0.2%