tborychowski/unifi-event-monitor

Monitors Unifi Controller events and push them as notifications to slack (or any other platform)

Unifi Event Monitor

Listens for events from Unifi controller and pushes them as notifications to apprise.

Get started

1. Apprise config

Create .apprise file with your channels, e.g.:

slack://<token1>/<token2>/<token3>
mailtos://<userid>:<pass>@<domain.com>

2. Unifi Controller credentials

Create .env file with the following:

HOST=https://<controllerIP>:8443
USERNAME=<username>
PASSWORD=<password>

Setup using docker image

1. Create docker-compose.yml file:

---
version: "3.7"
services:
  unifi-event-monitor:
    container_name: unifi-event-monitor
    image: tborychowski/unifi-event-monitor
    restart: unless-stopped
    env_file:
      - ./.env
    volumes:
      - ./.apprise:/app/.apprise
      - ./blacklist.txt:/app/blacklist.txt

2a. Run:

docker-compose up -d

2b. Alternatively, you can run:

docker run -d --rm --env-file=./.env \
  --mount "type=bind,src=/absolute/path/to/.apprise,dst=/app/.apprise" \
  --mount "type=bind,src=/absolute/path/to/blacklist.txt,dst=/app/blacklist.txt" \
  tborychowski/unifi-event-monitor:latest

Filtering events

By default the app listens to all events and forwards the messages as notifications. It is possible to filter out some of the messages.

• Create blacklist.txt file (in the same folder as the .apprise)
• Add text of a message that you don't want to be pushed to your selected notification platform
• You can have multiple filters, but keep 1 filter per line, e.g.

  my laptop disconnected from
  my laptop has connected to
  

• This file is re-read before every event, so there's no need to restart the app after changing the file.

Setup locally (with nodejs)

git clone https://github.com/tborychowski/unifi-event-monitor.git
cd unifi-event-monitor
npm ci
node index.js

Credit

I used some code from: https://github.com/oznu/unifi-events

unifi-event-monitor's Issues

Events not pulling into UniFi Event Monitor

First and foremost, this is an awesome project, and I'm excited to run it in my environment!

I'm currently running unifi-event-monitor in a Kubernetes cluster, and have it pointed to my UniFi Controller on the public Internet.

Looking at the environment vars, the three expected ones from the documentation are there:

HOST=https://unifi.[redacted]:8443
USERNAME=my-service-account
PASSWORD=[absolutely redacted]

And looking at the filesystem within the container, the volume mounts for the other two flat files are present, as well:

/app/.apprise

slack://[redacted]/[redacted]/[redacted]

/app/blacklist.txt

dummy text to blacklist
ensure that something is in this file and that it is populated

Looking at the pod logs, I see the following being sent to stdout:

Connected To UniFi Controller

But no events make it through to the event monitor, despite being very active within the UniFi Controller, and seeing a number of events enter the pane in the web console over the past hour. A sampling is here:

Admin Admin [REDACTED] log in from [PUBLIC IP]	1:15 am	Oct 05 2022	
[SOME SWITCH] was upgraded from "4.0.80.10875" to "6.3.13.14104"	1:10 am	Oct 05 2022	
[MAC ADDRESS] disconnected from [NETWORK NAME] (7m connected, 0 B)	1:07 am	Oct 05 2022	
[MAC ADDRESS] has connected to  with SSID [SSID] on channel 11	1:06 am	Oct 05 2022	
[SOME SWITCH] was scheduled for upgrade by Admin [USERNAME]	1:05 am	Oct 05 2022	
[MAC ADDRESS] disconnected from [SSID] (1h 43m connected, 119 KB, last )	1:05 am	Oct 05 2022	
Admin Admin [REDACTED] log in from [PUBLIC IP]	12:59 am	Oct 05 2022	

Looking in the source code, I don't see a method of turning on a debug mode via an environment variable or similar, but am open to suggestions. Any thoughts?

Thanks!

What events is it looking at?

Thank you so much for this. We have it up and running. We are using SNS notifications to push unifi events to Sumo Logic.

Wondering what events it looks for and how to control what is picked up...

In the Unifi controller I can see "push me", "alert me" and "email me" ....

Is this looking to one of those options?

thanks again!