update docs and examples

This commit is contained in:
davidnewhall2 2020-06-15 02:19:09 -07:00
parent 5a2e21a1f6
commit 9f58c65acc
7 changed files with 44 additions and 17 deletions

View File

@ -8,6 +8,7 @@ file with `.json`, and YAML with `.yaml`. The default
format is always TOML and may have any _other_ suffix.
#### Dashboards
This folder used to contain Grafana Dashboards.
**They are now located at [Grafana.com](https://grafana.com/dashboards?search=unifi-poller).**
Also see [Grafana Dashboards](https://github.com/unifi-poller/unifi-poller/wiki/Grafana-Dashboards) Wiki.
- This folder used to contain Grafana Dashboards.
- **They are now located at [Grafana.com](https://grafana.com/dashboards?search=unifi-poller).**
- [Grafana Dashboards Wiki](https://github.com/unifi-poller/unifi-poller/wiki/Grafana-Dashboards)

View File

@ -53,7 +53,9 @@
# The following section contains the default credentials/configuration for any
# dynamic controller (see above section), or the primary controller if you do not
# provide one and dynamic is disabled. In other words, you can just add your
# controller here and delete the following section.
# controller here and delete the following section. The internal defaults are
# shown below. Any missing values will assume these displayed defaults, except
# the role; if omitted the role is set to the url. See comments below for details.
[unifi.defaults]
#role = "main controller"
url = "https://127.0.0.1:8443"
@ -63,21 +65,27 @@
save_ids = false
save_dpi = false
save_sites = true
hash_pii = false
verify_ssl = false
# The following is optional and used for configurations with multiple controllers.
# You may repeat the following section to poll multiple controllers.
# Any ommitted variables will have their values taken from the defaults, above.
#[[unifi.controller]]
# Friendly name used in dashboards. Uses URL if left empty; which is fine.
# Role is a friendly name used in dashboards. Uses URL if left empty; which is fine.
# Avoid changing this later because it will live forever in your database.
# Multiple controllers may share a role. This allows grouping during scrapes.
#role = ""
# --- This will be deprecated in a future version of UniFi Poller. ---
#role = "https://127.0.0.1:8443"
# URL for the UniFi Controller. Do not add any paths after the host:port.
# Do not use port 8443 if you have a UDM.
#url = "https://127.0.0.1:8443"
# Make a read-only user in the UniFi Admin Settings, allow it access to all sites.
#user = "unifipoller"
#pass = "4BB9345C-2341-48D7-99F5-E01B583FF77F"
#pass = "unifipoller"
# If the controller has more than one site, specify which sites to poll here.
# Set this to ["default"] to poll only the first site on the controller.
@ -100,6 +108,10 @@
# It's not valuable to everyone and setting this to false will save resources.
#save_sites = true
# Hash, with md5, client names and MAC addresses. This attempts to protect
# personally identifiable information. Most users won't want to enable this.
#hash_pii = false
# If your UniFi controller has a valid SSL certificate (like lets encrypt),
# you can enable this option to validate it. Otherwise, any SSL certificate is
# valid. If you don't know if you have a valid SSL cert, then you don't have one.

View File

@ -32,6 +32,7 @@
"save_ids": false,
"save_dpi": false,
"save_sites": true,
"hash_pii": false,
"verify_ssl": false
},
"controllers": [
@ -41,9 +42,10 @@
"pass": "unifipoller",
"url": "https://127.0.0.1:8443",
"sites": ["all"],
"save_dpi": false,
"save_ids": false,
"save_dpi": false,
"save_sites": true,
"hash_pii": false,
"verify_ssl": false
}
]

View File

@ -6,7 +6,7 @@
# See up.conf.example! v2 #
#############################################
<plugin> and <site> are lists of strings and may be repeated.
NOTE: <plugin> and <site> are lists of strings and may be repeated.
-->
<poller debug="false" quiet="false">
<!-- plugin></plugin -->
@ -31,10 +31,11 @@
<user>unifipoller</user>
<pass>unifipoller</pass>
<url>https://127.0.0.1:8443</url>
<verify_ssl>false</verify_ssl>
<save_ids>false</save_ids>
<save_dpi>false</save_dpi>
<save_sites>true</save_sites>
<hash_pii>false</hash_pii>
<verify_ssl>false</verify_ssl>
</default>
<!-- Repeat this stanza to poll additional controllers. -->
@ -43,10 +44,11 @@
<user>unifipoller</user>
<pass>unifipoller</pass>
<url>https://127.0.0.1:8443</url>
<verify_ssl>false</verify_ssl>
<save_ids>false</save_ids>
<save_dpi>false</save_dpi>
<save_sites>true</save_sites>
<hash_pii>false</hash_pii>
<verify_ssl>false</verify_ssl>
</controller>
</unifi>

View File

@ -33,10 +33,11 @@ unifi:
url: "https://127.0.0.1:8443"
sites:
- all
verify_ssl: false
save_ids: false
save_dpi: false
save_sites: true
hash_pii: false
verify_ssl: false
controllers:
@ -47,7 +48,8 @@ unifi:
url: "https://127.0.0.1:8443"
sites:
- all
verify_ssl: false
save_ids: false
save_dpi: false
hash_pii: false
save_sites: true
verify_ssl: false

8
go.mod
View File

@ -7,12 +7,12 @@ require (
github.com/influxdata/influxdb1-client v0.0.0-20200515024757-02f0bf5dbca3 // indirect
github.com/mattn/go-colorable v0.1.4 // indirect
github.com/mattn/go-isatty v0.0.11 // indirect
github.com/prometheus/procfs v0.1.2 // indirect
github.com/prometheus/procfs v0.1.3 // indirect
github.com/russross/blackfriday v2.0.0+incompatible // indirect
github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect
github.com/unifi-poller/influxunifi v0.0.9-0.20200614094130-d25a8fece6bc
github.com/unifi-poller/inputunifi v0.0.7-0.20200614024217-51cd08a0421e
github.com/unifi-poller/influxunifi v0.0.9
github.com/unifi-poller/inputunifi v0.0.7-0.20200615090539-b2b14e56a5ee
github.com/unifi-poller/poller v0.0.6
github.com/unifi-poller/promunifi v0.0.7-0.20200614034834-a8547d57cfdc
github.com/unifi-poller/promunifi v0.0.7
github.com/unifi-poller/unifi v0.0.5
)

8
go.sum
View File

@ -103,6 +103,8 @@ github.com/prometheus/procfs v0.1.1 h1:/ZKcW+ixpq2dOl4yeH4qvACNXnkiDCp5e/F5Tq07X
github.com/prometheus/procfs v0.1.1/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU=
github.com/prometheus/procfs v0.1.2 h1:DS2izEFqEVp1gPg5yvEF/YzS6Ajo8YdKRJjQKiQm59A=
github.com/prometheus/procfs v0.1.2/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU=
github.com/prometheus/procfs v0.1.3 h1:F0+tqvhOksq22sc6iCHF5WGlWjdwj92p0udFh1VFBS8=
github.com/prometheus/procfs v0.1.3/go.mod h1:lV6e/gmhEcM9IjHGsFOCxxuZ+z1YqCvr4OA4YeYWdaU=
github.com/russross/blackfriday v2.0.0+incompatible h1:cBXrhZNUf9C+La9/YpS+UHpUT8YD6Td9ZMSU9APFcsk=
github.com/russross/blackfriday v2.0.0+incompatible/go.mod h1:JO/DiYxRf+HjHt06OyowR9PTA263kcR/rfWxYHBV53g=
github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
@ -134,6 +136,8 @@ github.com/unifi-poller/influxunifi v0.0.9-0.20200614084044-5974cdc8af4f h1:09QF
github.com/unifi-poller/influxunifi v0.0.9-0.20200614084044-5974cdc8af4f/go.mod h1:CfMvHVp3TPnp8flNvsiUSz09LWop1kmig/Sukg+hkAg=
github.com/unifi-poller/influxunifi v0.0.9-0.20200614094130-d25a8fece6bc h1:IwCBppmj6Gh5VwA8dLHdhjdJCUIeuX0xst89cJpG1F0=
github.com/unifi-poller/influxunifi v0.0.9-0.20200614094130-d25a8fece6bc/go.mod h1:CfMvHVp3TPnp8flNvsiUSz09LWop1kmig/Sukg+hkAg=
github.com/unifi-poller/influxunifi v0.0.9 h1:ZDiDbFwoGfNWTXgVOUkkxTOUvkvS8RwweiDRhtntfCU=
github.com/unifi-poller/influxunifi v0.0.9/go.mod h1:CfMvHVp3TPnp8flNvsiUSz09LWop1kmig/Sukg+hkAg=
github.com/unifi-poller/inputunifi v0.0.5 h1:go+5j7WS1y0N/2pKKPvjzn8bkPpFXurQnoYGYajJD04=
github.com/unifi-poller/inputunifi v0.0.5/go.mod h1:X1Vd5uAtO5etZveY0WpMVMQBM/iLoMwZ/SvN1iXLxHo=
github.com/unifi-poller/inputunifi v0.0.6-0.20200203055955-411a49dea2e7 h1:CXMB+6tTJJZEoyMmH24PN/7evm3yuvily9Df4sujeT0=
@ -158,6 +162,8 @@ github.com/unifi-poller/inputunifi v0.0.7-0.20200614011400-ccef115c2def h1:rInzM
github.com/unifi-poller/inputunifi v0.0.7-0.20200614011400-ccef115c2def/go.mod h1:ctlM3l9voxrRif2Y8obpkBr4LNSseJwZYsMSOysAHSs=
github.com/unifi-poller/inputunifi v0.0.7-0.20200614024217-51cd08a0421e h1:cF6YNgJS9bBZiaROF+UzH6ehsPH2T7w3mfDgUasv3bU=
github.com/unifi-poller/inputunifi v0.0.7-0.20200614024217-51cd08a0421e/go.mod h1:ctlM3l9voxrRif2Y8obpkBr4LNSseJwZYsMSOysAHSs=
github.com/unifi-poller/inputunifi v0.0.7-0.20200615090539-b2b14e56a5ee h1:AqEqrunRXfiFc8PKefdog+T0WSBjo8JVsZGz06kWWkA=
github.com/unifi-poller/inputunifi v0.0.7-0.20200615090539-b2b14e56a5ee/go.mod h1:sNdMyJPSSxm+IfM6H2g2ovWzn+fXOeIPhRGJbK35tOw=
github.com/unifi-poller/poller v0.0.3/go.mod h1:ugy3FyZEH1rFyC3panBiJpXbLf7EZ4GkjiOtydB2CwQ=
github.com/unifi-poller/poller v0.0.4 h1:TYCdQeCYwUmmFcj1H75iGKAFbAOBFwo/XIJDX2Id+cY=
github.com/unifi-poller/poller v0.0.4/go.mod h1:LbOCEdNth7invhaOTpcadW/sDlD2WsU+IE3GRXKzOCg=
@ -179,6 +185,8 @@ github.com/unifi-poller/promunifi v0.0.7-0.20200614032856-bb7f58485c41 h1:cdqSEw
github.com/unifi-poller/promunifi v0.0.7-0.20200614032856-bb7f58485c41/go.mod h1:eMjnSpCSuNvHnm4ofAgwRX/tZauGDjHPHdgflH/JATU=
github.com/unifi-poller/promunifi v0.0.7-0.20200614034834-a8547d57cfdc h1:XoSJxz3eGxH8vTKbawecdN42EMem57ydqh9F6XXuZec=
github.com/unifi-poller/promunifi v0.0.7-0.20200614034834-a8547d57cfdc/go.mod h1:gi19r6SSGIOpuYn6aKLOrlScegP/HUIaXY/1tBC7Xdw=
github.com/unifi-poller/promunifi v0.0.7 h1:VylwjZ0qdY6yifMlPTzhvsfaDwdiYgvulKXfTwLPEwI=
github.com/unifi-poller/promunifi v0.0.7/go.mod h1:YXNpofH3Tw707nHJaHXZWVnTlosc4Jdia1RpaVkLTd4=
github.com/unifi-poller/unifi v0.0.2/go.mod h1:DagVD/I+VMnVUHmTT4Fi76lPI+DHbuMwwtMIzanwMxM=
github.com/unifi-poller/unifi v0.0.3 h1:6pmjW7MuEEDKKvYoxjL3EZlaLOgmhYyxJBAg4X7GliI=
github.com/unifi-poller/unifi v0.0.3/go.mod h1:DagVD/I+VMnVUHmTT4Fi76lPI+DHbuMwwtMIzanwMxM=