Merge branch 'master' into snmp-monitor

server/monitor-types/dns.js

@@ -5,7 +5,6 @@ const { dnsResolve } = require("../util-server");
 const { R } = require("redbean-node");
 
 class DnsMonitorType extends MonitorType {
-
     name = "dns";
 
     /**

server/monitor-types/mongodb.js

@@ -0,0 +1,63 @@
+const { MonitorType } = require("./monitor-type");
+const { UP } = require("../../src/util");
+const { MongoClient } = require("mongodb");
+const jsonata = require("jsonata");
+
+class MongodbMonitorType extends MonitorType {
+    name = "mongodb";
+
+    /**
+     * @inheritdoc
+     */
+    async check(monitor, heartbeat, _server) {
+        let command = { "ping": 1 };
+        if (monitor.databaseQuery) {
+            command = JSON.parse(monitor.databaseQuery);
+        }
+
+        let result = await this.runMongodbCommand(monitor.databaseConnectionString, command);
+
+        if (result["ok"] !== 1) {
+            throw new Error("MongoDB command failed");
+        } else {
+            heartbeat.msg = "Command executed successfully";
+        }
+
+        if (monitor.jsonPath) {
+            let expression = jsonata(monitor.jsonPath);
+            result = await expression.evaluate(result);
+            if (result) {
+                heartbeat.msg = "Command executed successfully and the jsonata expression produces a result.";
+            } else {
+                throw new Error("Queried value not found.");
+            }
+        }
+
+        if (monitor.expectedValue) {
+            if (result.toString() === monitor.expectedValue) {
+                heartbeat.msg = "Command executed successfully and expected value was found";
+            } else {
+                throw new Error("Query executed, but value is not equal to expected value, value was: [" + JSON.stringify(result) + "]");
+            }
+        }
+
+        heartbeat.status = UP;
+    }
+
+    /**
+     * Connect to and run MongoDB command on a MongoDB database
+     * @param {string} connectionString The database connection string
+     * @param {object} command MongoDB command to run on the database
+     * @returns {Promise<(string[] | object[] | object)>} Response from server
+     */
+    async runMongodbCommand(connectionString, command) {
+        let client = await MongoClient.connect(connectionString);
+        let result = await client.db().command(command);
+        await client.close();
+        return result;
+    }
+}
+
+module.exports = {
+    MongodbMonitorType,
+};

server/monitor-types/monitor-type.js

@@ -11,7 +11,6 @@ class MonitorType {
     async check(monitor, heartbeat, server) {
         throw new Error("You need to override check()");
     }
-
 }
 
 module.exports = {

server/monitor-types/mqtt.js

@@ -4,15 +4,10 @@ const mqtt = require("mqtt");
 const jsonata = require("jsonata");
 
 class MqttMonitorType extends MonitorType {
-
     name = "mqtt";
 
     /**
-     * Run the monitoring check on the MQTT monitor
-     * @param {Monitor} monitor Monitor to check
-     * @param {Heartbeat} heartbeat Monitor heartbeat to update
-     * @param {UptimeKumaServer} server Uptime Kuma server
-     * @returns {Promise<void>}
+     * @inheritdoc
      */
     async check(monitor, heartbeat, server) {
         const receivedMessage = await this.mqttAsync(monitor.hostname, monitor.mqttTopic, {

server/monitor-types/tailscale-ping.js

@@ -2,23 +2,13 @@ const { MonitorType } = require("./monitor-type");
 const { UP } = require("../../src/util");
 const childProcessAsync = require("promisify-child-process");
 
-/**
- * A TailscalePing class extends the MonitorType.
- * It runs Tailscale ping to monitor the status of a specific node.
- */
 class TailscalePing extends MonitorType {
-
     name = "tailscale-ping";
 
     /**
-     * Checks the ping status of the URL associated with the monitor.
-     * It then parses the Tailscale ping command output to update the heatrbeat.
-     * @param {object} monitor The monitor object associated with the check.
-     * @param {object} heartbeat The heartbeat object to update.
-     * @returns {Promise<void>}
-     * @throws Error if checking Tailscale ping encounters any error
+     * @inheritdoc
      */
-    async check(monitor, heartbeat) {
+    async check(monitor, heartbeat, _server) {
         try {
             let tailscaleOutput = await this.runTailscalePing(monitor.hostname, monitor.interval);
             this.parseTailscaleOutput(tailscaleOutput, heartbeat);