a-bali/janitor

Availability monitoring and alerting for IOT devices

janitor's Issues

Feature Request | Ability to save name in config for MQTT Entries

Howdy,

I use mysensors which does not have a way to provide pretty names in its MQTT topics. I would like to request the ability to tag a name directly on a topic in the config so its easier to know what is broken. And to use that name in the notifications.

• topic: "/mysgw-out/93/3/1/0/0"
  name: "Office Door Temperature"

ESPHome integration possible?

Hey !

this is excactly what I trying to build inside home-assistant and failed with it. So grateful that you share your code. One question I like to monitor my Xiaomi MiFlora devices as the battery sensor is not working. Is it possible to integrate the ESPHome devices using the native ESPHome API?

Would you mind sharing a config snippet? Thank you very much!

Support for Personal Certificate Authority?

Does Janitor have support for specifying a personal certificate authority? My Mosquitto server is protected with a custom CA, and Janitor can't connect.

For example:

  mqtt:
    # Server connection details
    # Host name
    server: mqtts://mosquitto.int.price.gb.net
    # Port number (default: 1883)
    port: 8883
    # User and password if required
    user: admin
    password: ewpojfewhfiosdfsdojsdpoew
    ca: /certs/ca.crt

Custom error thresholds

Less of an issue, more of a feature request.

Would it be possible to have custom error thresholds for some devices; things like motion and door/window sensors which may see clusters of activity during the day, but nothing overnight. This pattern really throws the average out and outs them in an error state when they are actually performing correctly.

Obviously possible to get round this with devices that also send temp or some other consistent output, but not with ones that only have one binary trigger.

Wrong time duration logged when error is resolved

In case of Exec/Ping/HTTP checks, LastError attribute gets updated every cycle, therefore the message logged when the error is resolved contains wrong time duration. E.g.:

[2024-03-12 13:44:58] ⚠ Exec ERROR for cam2 timelapse recent, last seen 2m0s ago
[2024-03-12 13:45:58] ⚠ Exec ERROR for cam1 timelapse recent, last seen 2m0s ago
[2024-03-12 13:59:00] ✓ Exec OK for cam1 timelapse recent, in error since 1m0s ago
[2024-03-12 13:59:01] ✓ Exec OK for cam2 timelapse recent, in error since 1m0s ago

When configuring topic with single level wildcard "+", timeout does not work

Hello, fist thanks for a great tool!

Issue is, when i have signle level wildcard "+" like this in my config:

monitor:
  mqtt:
    server: 192.168.x.x.
    port: 1883
    user: "username"
    password: "pass"
    targets:
    - topic: "zigbee2mqtt/sensor_out/#"
      timeout: 2000
    - topic: "other_gateway/+/1/#"
      timeout: 1200
    - topic: "other_gateway/+/2/#"
      timeout: 1200

then I can see topics like "other_gateway/15/1/2", "other_gateway/17/1/1" ... etc are monitored, but timeout 1200 does not apply for them. Instead, only standardtimeout is applied.

I need this filter because othergateway use this topic structure:
other_gateway/SENSOR_ID/CHILD_ID/MESSAGE_ID/

And I need to monitor all sensors, but just specific child_ids.

As a workaround I can specify all topics separately, but there are quite a lot of them, and each time new sensor is added, I need to modify this config.

Thank You.
pd.

MQTT topics: LWT data

I would like to monitor a Topic to see if a particular payload is there.
e.g. on an LWT topic, my devices publish 'online', 'offline','restarting' etc.
I would like to catch the 'offline' state.

Thanks for a great app!

Release tags and docker tags need

Hello! 1st, Janitor is a great tool! Thank you very much for this!

One notice: it could be better to use tags for git and docker images. It's a common practice (in DevOps world) which allows controlling about what current version is running on your host. Using "latest" tag is definitely bad practice.

Support for mqtts

Hello,

Update: I've raised a PR #12

I'm wondering if you could add support for specifying the URL scheme in the config.yml? I've been running into an issue where my MQTT broker is setup to use SSL and thus the mqtts:// scheme (like https://) but it seems that Janitor doesn't support this?

I've built the Dockerfile locally and hardcoded the scheme in main.go which works for me, for now - the %s before seems to suggest it is supported but doesn't have a corresponding config key? I don't use golang though, so not sure.

// Original:
opts.AddBroker(fmt.Sprintf("%s://%s:%d", getConfig().Monitor.MQTT.Server, getConfig().Monitor.MQTT.Port))

// My change:
opts.AddBroker(fmt.Sprintf("mqtts://%s:%d", getConfig().Monitor.MQTT.Server, getConfig().Monitor.MQTT.Port))

If I don't specify mqtts, I get this error on startup of Janitor:

Unable to connect to MQTT for monitoring: network Error : EOF

If I specify mqtts in the server hostname in config.yml then I get the below error:

monitor:

  # MQTT monitoring
  mqtt:
    # Server connection details
    # Host name
    server: mqtts://mosquitto.int.price.gb.net
    # Port number (default: 1883)
    port: 8883

Unable to connect to MQTT for monitoring: network Error : dial tcp: lookup mqtts on 127.0.0.11:53: no such host

I don't use Golang at all, so don't know enough to propose a PR, but wondering if you could add support for this to be specified in config.yml at some point. Thanks for the great work you've done on Janitor - it's extremely helpful to me!

Refactor goroutines

Currently goroutines are launched at startup for the different types of monitoring, therefore the types of monitoring cannot be changed during runtime (via reloading the config file), only the contents for the different types.

Refactor code so that goroutines are stopped and (re)started upon reloading configuration. Use channels to signal to running goroutines.

docker support?

any plans for docker support?

How to setup MQTT-connection?

Hello,
Thank you for this very clean app; great programming.

Just a question regarding connecting to my MQTT-server for HomeAssistant.

I have HA and Janitor up and running; evrything works fine with Wifi and Ping but the MQTT-flow doesn't show anything.
Can you complete the example at the HomeAssistant-side to get all the necessary info (espacially: "/sensors/#" and "/stats/#".

I presume that this is done in the configuration.yaml off HA? Via MQTT-stream?
I found a link here: https://www.home-assistant.io/integrations/mqtt_statestream/

Thnx again!

Notify issues via MQTT

Would if be possible to report the fact that an IoT device is down via MQTT? I use HomeAssistant (seen you in the forums there), and would like to be able to trigger things when a sensor stops sending, and this would be an easy way to inform HA.

Packr installation instructions no longer work

Installation guide appears to be out of date.

go get github.com/gobuffalo/packr

cannot find package "github.com/gobuffalo/packr/packr" in any of:
        /usr/lib/go-1.15/src/github.com/gobuffalo/packr/packr (from $GOROOT)
        /root/go/src/github.com/gobuffalo/packr/packr (from $GOPATH)
# golang.org/x/sys/unix
/root/go/src/golang.org/x/sys/unix/syscall.go:83:16: undefined: unsafe.Slice
/root/go/src/golang.org/x/sys/unix/syscall_linux.go:2256:9: undefined: unsafe.Slice
/root/go/src/golang.org/x/sys/unix/syscall_unix.go:118:7: undefined: unsafe.Slice
/root/go/src/golang.org/x/sys/unix/sysvshm_unix.go:33:7: undefined: unsafe.Slice

docker container with ports?

Hello,
i have docker containers with different ports with same IP how do i add them?, is this kind of setup is
supported? i tried adding

 http:
  - name: container_name
    address: http://x.x.x.x:port
  - name: container_name2
    address: http://x.x.x.x:port2

error:net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)

Devices not shown for topic with v1.1

Thank you for this! I was looking for an easy way to monitor my MQTT sensors and alert me.

However, I am currently not able to get this to work, even though I don't run a special setup..

I am running this as docker. Log seems to be ok, it's connecting to my MQTT server alright - however, there are no sensors being detected. Checking this now for some time and didn't know why it won't work - maybe someone can help?

Janitor config

{
	"Debug": true,
	"LogSize": 1000,
	"Web": {
		"Host": "",
		"Port": 8080
	},
	"Alert": {
		"Telegram": {
			"Token": "",
			"Chat": 0
		},
		"Gotify": {
			"Token": "",
			"Server": ""
		},
		"Exec": "",
		"MQTT": {
			"Server": "mqtt://hostip",
			"Port": 1883,
			"User": "sensor",
			"Password": "sensorpass",
			"Topic": "/janitor/alerts"
		}
	},
	"Monitor": {
		"MQTT": {
			"Server": "mqtt://hostip",
			"Port": 1883,
			"User": "sensor",
			"Password": "sensorpass",
			"History": 10,
			"StandardTimeout": 1.5,
			"Targets": [
				{
					"Topic": "/zigbee2mqtt/#",
					"Name": "",
					"Timeout": 0
				}
			]
		},
		"Ping": {
			"Interval": 60,
			"Threshold": 2,
			"Targets": null
		},
		"HTTP": {
			"Interval": 60,
			"Timeout": 5000,
			"Threshold": 2,
			"Targets": null
		},
		"Exec": {
			"Interval": 60,
			"Timeout": 5000,
			"Threshold": 2,
			"Targets": null
		}
	}
}

docker compose file

  janitor:
    restart: always
    depends_on:
      - zigbee2mqtt
      - mosquitto
    volumes:
        - "/etc/localtime:/etc/localtime:ro"
        - "[...redacted]/janitor/config.yml:/janitor/config.yml"
    ports:
      - "7200:8080"
    container_name: janitor
    networks:
       - [...redacted]
    image: abali/janitor:v1.1

Logfile

2023-10-15T20:51:10.016978953Z [2023-10-15 22:51:10] Starting Janitor v1.1 (build date 2023-09-04T14:49:49+0000, 199fceb)
2023-10-15T20:51:10.017028395Z [2023-10-15 22:51:10] (Loaded config: [...redacted...]
2023-10-15T20:51:10.018699157Z [2023-10-15 22:51:10] Connected to MQTT server for monitoring at mqtt://localip:1883
2023-10-15T20:51:10.019611551Z [2023-10-15 22:51:10] Connected to MQTT server for alerting at mqtt://localip:1883
2023-10-15T20:51:10.019627822Z [2023-10-15 22:51:10] (Entering monitoring loop)
2023-10-15T20:51:10.019632393Z [2023-10-15 22:51:10] Launching web server at :8080
2023-10-15T20:51:10.019636255Z [2023-10-15 22:51:10] Subscribed to MQTT topics: /zigbee2mqtt/#

mqtt-explorer shows sensors with the relevant topic (zigbee2mqtt)