public_git
/
unpoller_unpoller
mirror of https://github.com/unpoller/unpoller.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

doc updates

This commit is contained in:
davidnewhall2 2019-12-01 22:19:57 -08:00
parent 64d861dd15
commit e984f1e3f6
3 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -110,7 +110,7 @@ sites side-by-side. So easy! This screenshot barely does it justice.
![USW Dashboard Image](https://grafana.com/api/dashboards/10417/images/6664/image) ![USW Dashboard Image](https://grafana.com/api/dashboards/10417/images/6664/image)
## Copyright & License ## Copyright & License
<img style="float: right;" align="right" width="200px" src="https://raw.githubusercontent.com/wiki/davidnewhall/unifi-poller/images/unifi-poller-logo.png"> <img style="float: right;" align="right" width="200px" src="https://raw.githubusercontent.com/wiki/davidnewhall/unifi-poller/images/unifi-poller-prometheus-logo-small.png">
- Copyright © 2016 Garrett Bjerkhoel. - Copyright © 2016 Garrett Bjerkhoel.
- Copyright © 2018-2019 David Newhall II. - Copyright © 2018-2019 David Newhall II.

11
examples/MANUAL.md
View File

@ -107,6 +107,10 @@ is provided so the application can be easily adapted to any environment.
measurements at /metrics for collection by prometheus. Enabling this measurements at /metrics for collection by prometheus. Enabling this
mode disables InfluxDB usage entirely. mode disables InfluxDB usage entirely.
* Value: both
Setting the mode to "both" will cause the InfluxDB poller routine to run
along with the Prometheus exporter. You can run both at the same time.
http_listen default: 0.0.0.0:9130 http_listen default: 0.0.0.0:9130
This option controls the IP and port the http listener uses when the This option controls the IP and port the http listener uses when the
mode is set to prometheus. This setting has no effect when other modes mode is set to prometheus. This setting has no effect when other modes
@ -143,13 +147,18 @@ is provided so the application can be easily adapted to any environment.
Password used to authenticate with UniFi controller. This can also be Password used to authenticate with UniFi controller. This can also be
set in an environment variable instead of a configuration file. set in an environment variable instead of a configuration file.
collect_ids default: false save_ids default: false
Setting this parameter to true will enable collection of Intrusion Setting this parameter to true will enable collection of Intrusion
Detection System data. IDS and IPS are the same data set. This is off Detection System data. IDS and IPS are the same data set. This is off
by default because most controllers do not have this enabled. It also by default because most controllers do not have this enabled. It also
creates a lot of new metrics from controllers with a lot of IDS entries. creates a lot of new metrics from controllers with a lot of IDS entries.
IDS data does not contain metrics, so this doesn't work with Prometheus. IDS data does not contain metrics, so this doesn't work with Prometheus.
save_sites
Setting this parameter to false will disable saving Network Site data.
This data populates the Sites dashboard, and this setting affects influx
and prometheus.
reauthenticate default: false reauthenticate default: false
Setting this parameter to true will make UniFi Poller send a new login Setting this parameter to true will make UniFi Poller send a new login
request on every interval. This generates a new cookie. Some controller request on every interval. This generates a new cookie. Some controller

5
examples/up.conf.example
View File

@ -25,7 +25,7 @@ quiet = false
# an invalid mode will also result in "influx". In this default mode the application # an invalid mode will also result in "influx". In this default mode the application
# runs as a daemon and polls the controller at the configured interval. # runs as a daemon and polls the controller at the configured interval.
# #
# There are two other options at this time: "influxlambda" and "prometheus" # Other options: "influxlambda", "prometheus", "both"
# #
# Mode "influxlambda" makes the application exit after collecting and reporting metrics # Mode "influxlambda" makes the application exit after collecting and reporting metrics
# to InfluxDB one time. This mode requires an external process like an AWS Lambda # to InfluxDB one time. This mode requires an external process like an AWS Lambda
@ -33,6 +33,9 @@ quiet = false
# #
# Mode "prometheus" opens an HTTP server on port 9130 and exports the metrics at # Mode "prometheus" opens an HTTP server on port 9130 and exports the metrics at
# /metrics for polling collection by a prometheus server. This disables influxdb. # /metrics for polling collection by a prometheus server. This disables influxdb.
#
# Mode "both" runs the Prometheus HTTP server and InfluxDB poller interval at
# the same time.
mode = "influx" mode = "influx"
# This controls on which ip and port /metrics is exported when mode is "prometheus". # This controls on which ip and port /metrics is exported when mode is "prometheus".