Adding NUT (Network UPS Tools) Monitor Type

[johnelliott]

⚠️ Please verify that this feature request has NOT been suggested before.

• [X] I checked and didn't find similar feature request

🏷️ Feature Request Type

New Monitor

🔖 Feature description

NUT (Network UPS Tools) is a standard protocol for monitoring uninteruptable power supplies, AKA battery backups.

Common examples are on in datacenters, but home users have Synology NAS devices with most UPS with USB ports.

✔️ Solution

I add a monitor type for NUT and ask others in the community to test it.

❓ Alternatives

Current work-around without this feature: A user runs an additional docker container, a side-car like nut-exporter and makes an HTTP keyword monitor.

📝 Additional Context

There was already a similar APCUPSD issue, and this may address that use case too since NUT supports APC devices.

[CommanderStorm]

New monitor types are always appreciated. See our contribution guide: https://github.com/louislam/uptime-kuma/blob/87b2e45fbf31be91d19d89e6bead3b9653a1cd6e/CONTRIBUTING.md

See https://github.com/louislam/uptime-kuma/blob/master/server/monitor-types/dns.js for a reference on how to implement a monitor-type using the newer syntax and https://github.com/louislam/uptime-kuma/pull/3178/files for the other files that need editing

[FoxxMD]

For anyone else looking for NUT monitoring it can be pretty easily done without new code:

• Spin up a docker compose stack for PeaNUT and connect it to your existing nut server
• Use the [json api](https://github.com/Brandawg93/PeaNUT?tab=readme-ov-file#api to get the endpoint for your ups EX http://192.168.0.100:1234/api/v1/devices/apc1500
  • You can view this URL in any web browser to see the data it returns
  • Likely you'll want to use the value of ups.status
• Set up a new uptime kuma monitor:
  • Monitor Type -- HTTP(s) - Keyword
  • URL -- the ups endpoint from above
  • Keyword -- Think this will be dependent on the UPS used but for APC brand as an example:
  • OL CHRG => online charging
  • OL => charged and online
  • OB DISCHRG => on battery and discharging
  • So I use Keyword: OB DISCHRG with Invert Keyword so the monitor is DOWN when the keyword is found
  • Once uptime kuma 2.0 is released we could use json query with regex or comparison operators on vars.ups.status to achieve the same thing wit more flexibility

alternatively, use a Json Query monitor with the expression

`ups.status` in ["OL CHRG", "OL"]

and Expected Value true