Add unpoller support

Author: lukegiuliani

README.md

@@ -23,6 +23,7 @@ Other features:
   - **Shelly Plug Monitoring**: Installs a [`shelly-plug-prometheus` exporter](https://github.com/geerlingguy/shelly-plug-prometheus) and a Grafana dashboard, which tracks and displays power usage on a Shelly Plug running on the local network. (Disabled by default. Enable and configure using the `shelly_plug_*` vars in `config.yml`.)
   - **AirGradient Monitoring**: Configures [`airgradient-prometheus`](https://github.com/geerlingguy/airgradient-prometheus) and a Grafana dashboard, which tracks and displays air quality over time via one or more AirGradient DIY monitors. (Disabled by default. Enable and configure using the `airgradient_enable` var in `config.yml`. See example configuration for ability to monitor multiple AirGradient DIY stations.)
   - **Starlink Monitoring**: Installs a [`starlink` prometheus exporter](https://github.com/danopstech/starlink_exporter) and a Grafana dashboard, which tracks and displays Starlink statistics. (Disabled by default. Enable and configure using the `starlink_enable` var in `config.yml`.)
+  - **UniFi Monitoring**: Installs the [`unpoller` prometheus exporter](https://unpoller.com/) which queries your UniFi hardware. (Disabled by default. Enable and configure using the `unpoller_enable` var in `config.yml`.)
 
 **IMPORTANT NOTE**: If you use the included Internet monitoring, it will download a decently-large amount of data through your Internet connection on a daily basis. Don't use it, or tune the `internet-monitoring` setup to not run the speedtests as often, if you have a metered connection!
 
@@ -87,6 +88,12 @@ prometheus_node_exporter_targets:
   - 'another-server.local:9100'
 ```
 
+#### Unifi monitoring
+
+Optionally, you can enable monitoring of your unifi gear by adding the [UnPoller](https://unpoller.com/) image. In your config, set `unifi_unpoller_enable` to true, add the ip of your controller, [the password of a user you are creating for this purpose](https://unpoller.com/docs/install/gettingstarted#configuring-the-controller), and you are good to go. 
+
+There are plenty of useful [predefined grafana dashboards](https://grafana.com/grafana/dashboards/?search=unifi-poller) that can be used.
+
 ## Updating
 
 ### pi-hole

example.config.yml

@@ -47,3 +47,13 @@ airgradient_sensors:
 
 # Starlink configuration. (Also requires `monitoring_enable`)
 starlink_enable: false
+
+# Unifi Unpoller configuration
+unpoller_enable: false
+# URL for the UniFi Controller. Do not add any paths after the host:port
+# Do not use port 8443 if you have a UDM; just use "https://ip".
+unpoller_unifi_url: https://192.168.1.1
+# The password for the user created in the unifi admin, insructions at
+# https://unpoller.com/docs/install/gettingstarted#configuring-the-controller
+unpoller_unifi_admin_username: "unifipoller"
+unpoller_unifi_admin_password: "change-this-password"

files/unpoller-overview.json

@@ -49,3 +49,7 @@
     - name: Set up Starlink Monitoring.
       ansible.builtin.import_tasks: tasks/starlink.yml
       when: starlink_enable
+
+    - name: Set up Unpoller Monitoring.
+      ansible.builtin.import_tasks: tasks/unpoller.yml
+      when: unpoller_enable

main.yml

@@ -26,3 +26,10 @@
     build: false
     restarted: true
   become: false
+
+- name: Restart unpoller-exporter
+  community.docker.docker_compose:
+    project_src: "{{ config_dir }}/unpoller-exporter/"
+    build: false
+    restarted: true
+  become: false

tasks/handlers.yml

@@ -0,0 +1,28 @@
+---
+- name: Ensure unpoller directory exists.
+  file:
+    path: "{{ config_dir }}/unpoller-exporter"
+    state: directory
+    mode: 0755
+  become: false
+
+- name: Copy unpoller docker-compose template to Pi.
+  ansible.builtin.template:
+    src: templates/unpoller-docker-compose.yml.j2
+    dest: "{{ config_dir }}/unpoller-exporter/docker-compose.yml"
+    mode: '0640'
+  become: false
+  notify: Restart unpoller-exporter
+
+- name: Ensure unpoller Prometheus exporter is running.
+  community.docker.docker_compose:
+    project_src: "{{ config_dir }}/unpoller-exporter/"
+    build: false
+  become: false
+
+- name: Copy unpoller dashboard config to grafana.
+  ansible.builtin.copy:
+    src: files/unpoller-overview.json
+    dest: "{{ config_dir }}/internet-monitoring/grafana/provisioning/dashboards/"
+    mode: 0644
+  become: false

tasks/unpoller.yml

@@ -81,6 +81,13 @@ scrape_configs:
       - targets: ['{{ pihole_hostname }}:9617']
 {% endif %}
 
+{% if unpoller_enable %}
+  - job_name: 'unpoller'
+    scrape_interval: 30s
+    static_configs:
+    - targets: ['unpoller:9130']
+{% endif %}
+
 {% filter indent(width=2,first=True) %}
 {{ prometheus_extra_scrape_configs }}
 {% endfilter %}

templates/prometheus.yml.j2

@@ -0,0 +1,28 @@
+# {{ ansible_managed }}
+---
+version: "3.5"
+
+networks:
+  back-tier:
+    name: internet-monitoring-back-tier
+
+services:
+  unpoller:
+    container_name: unpoller
+    hostname: 'unpoller'
+    restart: unless-stopped
+    image: golift/unifi-poller:latest
+    expose:
+      - 9130
+    ports:
+      - 9130:9130
+    networks:
+      - back-tier
+    environment:
+    # The documentation on these vars isn't great. The best example can be found at
+    # https://github.com/unpoller/unpoller/blob/51d0b2109ffe455c8ed2ef711e1a9ae46a6c15c7/init/docker/docker-compose.yml
+      UP_INFLUXDB_DISABLE: 'true'
+      UP_UNIFI_DEFAULT_SAVE_DPI: 'true'
+      UP_UNIFI_DEFAULT_USER: '{{ unpoller_unifi_admin_username }}'
+      UP_UNIFI_DEFAULT_PASS: '{{ unpoller_unifi_admin_password }}'
+      UP_UNIFI_DEFAULT_URL: '{{ unpoller_unifi_url }}'