unpoller_unpoller/integrations/influxunifi/cmd/unifi-poller
DN2 bd8c11ed50 switch to dep, another test, add flags - minor features 2019-01-11 20:36:29 -08:00
..
README.md switch to dep, another test, add flags - minor features 2019-01-11 20:36:29 -08:00
config.go Cleanup. 2019-01-11 02:32:00 -08:00
main.go switch to dep, another test, add flags - minor features 2019-01-11 20:36:29 -08:00

README.md

unifi-poller(1) -- Utility to poll Unifi Metrics and drop them into InfluxDB

SYNOPSIS

unifi-poller -c /usr/local/etc/unifi-poller.conf

DESCRIPTION

  • This application polls a Unifi Controller API for Client and Device Metrics.
  • The metrics are then stored in an InfluxDB instance.

OPTIONS

unifi-poller [-c <config file>] [-D] [-q] [-s] [-h] [-v]

-c, --config <file_path>
    Provide a configuration file (instead of the default).

-D, --debug
    Turns on line numbers, microsecond logging, and a per-device log.

-q, --quiet
    Turns off per-device log and per-interval log. Logs only errors.
    Recommend using -D with this setting for better error logging.

-s, --verify-ssl
    If your Unifi controller has a valid SSL certificate, you can enable
    this option to validate it. Otherwise, any SSL certificate is valid.

-v, --version
    Display version and exit.

-h, --help
    Display usage and exit.

GO DURATION

This application uses the Go Time Durations for a polling interval. The format is an integer followed by a time unit. You may append multiple time units to add them together. Some valid time units are:

 `us` (microsecond)
 `ns` (nanosecond)
 `ms` (millisecond)
 `s`  (second)
 `m`  (minute)
 `h`  (hour)

Example Use: 1m, 5h, 100ms, 17s, 1s45ms, 1m3s

AUTHOR

  • Garrett Bjerkhoel (original code) ~ 2016
  • David Newhall II (rewritten) ~ 4/20/2018

LOCATION