Add nut server monitor

db/knex_migrations/2023-10-23-add-nut-monitor.js

@@ -0,0 +1,20 @@
+exports.up = function (knex) {
+    // Add new column
+    return knex.schema
+        .alterTable("monitor", function (table) {
+            table.text("ups_name");
+            table.text("nut_username");
+            table.text("nut_password");
+        });
+
+};
+
+exports.down = function (knex) {
+    // Drop nut variable column
+    return knex.schema
+        .alterTable("monitor", function (table) {
+            table.dropColumn("ups_name");
+            table.dropColumn("nut_username");
+            table.dropColumn("nut_password");
+        });
+};

package.json

@@ -166,6 +166,7 @@
         "favico.js": "~0.3.10",
         "jest": "~29.6.1",
         "marked": "~4.2.5",
+        "node-nut": "^1.0.3",
         "node-ssh": "~13.1.0",
         "postcss-html": "~1.5.0",
         "postcss-rtlcss": "~3.7.2",

server/model/monitor.js

@@ -130,6 +130,7 @@ class Monitor extends BeanModel {
             maintenance: await Monitor.isUnderMaintenance(this.id),
             mqttTopic: this.mqttTopic,
             mqttSuccessMessage: this.mqttSuccessMessage,
+            upsName: this.upsName,
             databaseQuery: this.databaseQuery,
             authMethod: this.authMethod,
             grpcUrl: this.grpcUrl,
@@ -173,6 +174,8 @@ class Monitor extends BeanModel {
                 radiusSecret: this.radiusSecret,
                 mqttUsername: this.mqttUsername,
                 mqttPassword: this.mqttPassword,
+                nutUsername: this.nutUsername,
+                nutPassword: this.nutPassword,
                 authWorkstation: this.authWorkstation,
                 authDomain: this.authDomain,
                 tlsCa: this.tlsCa,

server/monitor-types/nut.js

@@ -0,0 +1,64 @@
+const { MonitorType } = require("./monitor-type");
+const { UP, DOWN } = require("../../src/util");
+const dayjs = require("dayjs");
+const jsonata = require("jsonata");
+const Nut = require("node-nut");
+
+const { log } = require("../../src/util");
+
+class NutMonitorType extends MonitorType {
+
+    name = "nut";
+
+    /**
+     * @inheritdoc
+     */
+    async check(monitor, heartbeat, _server) {
+        let startTime = dayjs().valueOf();
+        let expression = jsonata(monitor.jsonPath);
+
+        const nut = new Nut(monitor.port, monitor.hostname);
+
+        nut.on("ready", () => {
+            nut.GetUPSList((upslist, err) => {
+                if (err) {
+                    nut.close();
+                    log.error("NUT Error: " + err);
+                }
+
+                let upsname = upslist[monitor.upsName] && monitor.upsName || Object.keys(upslist)[0];
+
+                nut.GetUPSVars(upsname, async (vars, err) => {
+                    nut.close();
+                    if (err) {
+                        throw new Error("Error getting UPS variables");
+                    } else {
+                        // convert data to object
+                        if (typeof vars === "string") {
+                            vars = JSON.parse(vars);
+                        }
+                        const data = ({ ...vars }); // copy vars
+
+                        // Check device status
+                        let result = await expression.evaluate(data);
+
+                        if (result.toString() === monitor.expectedValue) {
+                            heartbeat.status = UP;
+                            heartbeat.msg = "";
+                            heartbeat.ping = dayjs().valueOf() - startTime;
+                        } else {
+                            heartbeat.status = DOWN;
+                            heartbeat.msg = `Value not expected, value was: [${result}]`;
+                        }
+                    }
+                });
+            });
+        });
+
+        nut.start();
+    }
+}
+
+module.exports = {
+    NutMonitorType,
+};

server/server.js

@@ -796,6 +796,8 @@ let needSetup = false;
                 bean.proxyId = Number.isInteger(monitor.proxyId) ? monitor.proxyId : null;
                 bean.mqttUsername = monitor.mqttUsername;
                 bean.mqttPassword = monitor.mqttPassword;
+                bean.nutUsername = monitor.nutUsername;
+                bean.nutPassword = monitor.nutPassword;
                 bean.mqttTopic = monitor.mqttTopic;
                 bean.mqttSuccessMessage = monitor.mqttSuccessMessage;
                 bean.databaseConnectionString = monitor.databaseConnectionString;
@@ -824,6 +826,7 @@ let needSetup = false;
                 bean.kafkaProducerSaslOptions = JSON.stringify(monitor.kafkaProducerSaslOptions);
                 bean.kafkaProducerMessage = monitor.kafkaProducerMessage;
                 bean.gamedigGivenPortOnly = monitor.gamedigGivenPortOnly;
+                bean.upsName = monitor.upsName;
 
                 bean.validate();
 

server/uptime-kuma-server.js

@@ -115,6 +115,7 @@ class UptimeKumaServer {
         UptimeKumaServer.monitorTypeList["real-browser"] = new RealBrowserMonitorType();
         UptimeKumaServer.monitorTypeList["tailscale-ping"] = new TailscalePing();
         UptimeKumaServer.monitorTypeList["dns"] = new DnsMonitorType();
+        UptimeKumaServer.monitorTypeList["nut"] = new NutMonitorType();
 
         this.io = new Server(this.httpServer);
     }
@@ -433,3 +434,4 @@ module.exports = {
 const { RealBrowserMonitorType } = require("./monitor-types/real-browser-monitor-type");
 const { TailscalePing } = require("./monitor-types/tailscale-ping");
 const { DnsMonitorType } = require("./monitor-types/dns");
+const { NutMonitorType } = require("./monitor-types/nut");

src/pages/Details.vue

@@ -42,6 +42,7 @@
                 <span v-if="monitor.type === 'redis'">{{ filterPassword(monitor.databaseConnectionString) }}</span>
                 <span v-if="monitor.type === 'sqlserver'">SQL Server: {{ filterPassword(monitor.databaseConnectionString) }}</span>
                 <span v-if="monitor.type === 'steam'">Steam Game Server: {{ monitor.hostname }}:{{ monitor.port }}</span>
+                <span v-if="monitor.type === 'nut'">NUT: {{monitor.upsName}} on {{ monitor.hostname }}:{{ monitor.port }}</span>
             </p>
 
             <div class="functions">

src/pages/EditMonitor.vue

@@ -61,6 +61,9 @@
                                         <option value="mqtt">
                                             MQTT
                                         </option>
+                                        <option value="nut">
+                                            Network UPS Tools
+                                        </option>
                                         <option value="kafka-producer">
                                             Kafka Producer
                                         </option>
@@ -144,8 +147,26 @@
                                 </div>
                             </div>
 
-                            <!-- Json Query -->
-                            <div v-if="monitor.type === 'json-query'" class="my-3">
+                            <!-- NUT -->
+                            <!-- For NUT Type -->
+                            <template v-if="monitor.type === 'nut'">
+                                <div class="my-3">
+                                    <label for="upsName" class="form-label">UPS {{ $t("Name") }}</label>
+                                    <input id="upsName" v-model="monitor.upsName" type="text" class="form-control" required>
+                                </div>
+                                <div class="my-3">
+                                    <label for="nutUsername" class="form-label">{{ $t("Username") }}</label>
+                                    <input id="nutUsername" v-model="monitor.nutUsername" type="text" class="form-control">
+                                </div>
+
+                                <div class="my-3">
+                                    <label for="nutPassword" class="form-label">{{ $t("Password") }}</label>
+                                    <input id="nutPassword" v-model="monitor.nutPassword" type="password" class="form-control">
+                                </div>
+                            </template>
+
+                            <!-- Json Query and NUT-->
+                            <div v-if="monitor.type === 'json-query' || monitor.type === 'nut'" class="my-3">
                                 <label for="jsonPath" class="form-label">{{ $t("Json Query") }}</label>
                                 <input id="jsonPath" v-model="monitor.jsonPath" type="text" class="form-control" required>
 
@@ -221,15 +242,15 @@
                             </template>
 
                             <!-- Hostname -->
-                            <!-- TCP Port / Ping / DNS / Steam / MQTT / Radius / Tailscale Ping only -->
-                            <div v-if="monitor.type === 'port' || monitor.type === 'ping' || monitor.type === 'dns' || monitor.type === 'steam' || monitor.type === 'gamedig' ||monitor.type === 'mqtt' || monitor.type === 'radius' || monitor.type === 'tailscale-ping'" class="my-3">
+                            <!-- TCP Port / Ping / DNS / Steam / MQTT / Radius / Tailscale Ping / NUT only -->
+                            <div v-if="monitor.type === 'port' || monitor.type === 'ping' || monitor.type === 'dns' || monitor.type === 'steam' || monitor.type === 'gamedig' ||monitor.type === 'mqtt' || monitor.type === 'radius' || monitor.type === 'tailscale-ping' || monitor.type === 'nut'" class="my-3">
                                 <label for="hostname" class="form-label">{{ $t("Hostname") }}</label>
                                 <input id="hostname" v-model="monitor.hostname" type="text" class="form-control" :pattern="`${monitor.type === 'mqtt' ? mqttIpOrHostnameRegexPattern : ipOrHostnameRegexPattern}`" required>
                             </div>
 
                             <!-- Port -->
-                            <!-- For TCP Port / Steam / MQTT / Radius Type -->
-                            <div v-if="monitor.type === 'port' || monitor.type === 'steam' || monitor.type === 'gamedig' || monitor.type === 'mqtt' || monitor.type === 'radius'" class="my-3">
+                            <!-- For TCP Port / Steam / MQTT / Radius Type / NUT only -->
+                            <div v-if="monitor.type === 'port' || monitor.type === 'steam' || monitor.type === 'gamedig' || monitor.type === 'mqtt' || monitor.type === 'radius' || monitor.type === 'nut'" class="my-3">
                                 <label for="port" class="form-label">{{ $t("Port") }}</label>
                                 <input id="port" v-model="monitor.port" type="number" class="form-control" required min="0" max="65535" step="1">
                             </div>
@@ -1156,12 +1177,14 @@ message HealthCheckResponse {
                 }
             }
 
-            // Set default port for DNS if not already defined
-            if (! this.monitor.port || this.monitor.port === "53" || this.monitor.port === "1812") {
+            // Set default port for DNS, RADIUS, NUT if not already defined
+            if (! this.monitor.port || this.monitor.port === "53" || this.monitor.port === "1812" || this.monitor.port === "3493") {
                 if (this.monitor.type === "dns") {
                     this.monitor.port = "53";
                 } else if (this.monitor.type === "radius") {
                     this.monitor.port = "1812";
+                } else if (this.monitor.type === "nut") {
+                    this.monitor.port = "3493";
                 } else {
                     this.monitor.port = undefined;
                 }