Merge pull request #1636 from christopherpickering/master

Add SQLServer Monitor

db/patch-add-sqlserver-monitor.sql

@@ -0,0 +1,10 @@
+BEGIN TRANSACTION;
+
+ ALTER TABLE monitor
+     ADD database_connection_string VARCHAR(2000);
+
+ ALTER TABLE monitor
+     ADD database_query TEXT;
+
+
+ COMMIT

package.json

@@ -96,6 +96,7 @@
         "jwt-decode": "^3.1.2",
         "limiter": "^2.1.0",
         "mqtt": "^4.2.8",
+        "mssql": "^8.1.0",
         "node-cloudflared-tunnel": "~1.0.9",
         "nodemailer": "~6.6.5",
         "notp": "~2.0.3",

server/database.js

@@ -58,6 +58,7 @@ class Database {
         "patch-monitor-expiry-notification.sql": true,
         "patch-status-page-footer-css.sql": true,
         "patch-added-mqtt-monitor.sql": true,
+        "patch-add-sqlserver-monitor.sql": true,
     };
 
     /**

server/model/monitor.js

@@ -7,7 +7,7 @@ dayjs.extend(timezone);
 const axios = require("axios");
 const { Prometheus } = require("../prometheus");
 const { log, UP, DOWN, PENDING, flipStatus, TimeLogger } = require("../../src/util");
-const { tcping, ping, dnsResolve, checkCertificate, checkStatusCode, getTotalClientInRoom, setting, mqttAsync } = require("../util-server");
+const { tcping, ping, dnsResolve, checkCertificate, checkStatusCode, getTotalClientInRoom, setting, mssqlQuery, mqttAsync } = require("../util-server");
 const { R } = require("redbean-node");
 const { BeanModel } = require("redbean-node/dist/bean-model");
 const { Notification } = require("../notification");
@@ -87,7 +87,9 @@ class Monitor extends BeanModel {
             mqttUsername: this.mqttUsername,
             mqttPassword: this.mqttPassword,
             mqttTopic: this.mqttTopic,
-            mqttSuccessMessage: this.mqttSuccessMessage
+            mqttSuccessMessage: this.mqttSuccessMessage,
+            databaseConnectionString: this.databaseConnectionString,
+            databaseQuery: this.databaseQuery,
         };
 
         if (includeSensitiveData) {
@@ -447,6 +449,14 @@ class Monitor extends BeanModel {
                         interval: this.interval,
                     });
                     bean.status = UP;
+                } else if (this.type === "sqlserver") {
+                    let startTime = dayjs().valueOf();
+
+                    await mssqlQuery(this.databaseConnectionString, this.databaseQuery);
+
+                    bean.msg = "";
+                    bean.status = UP;
+                    bean.ping = dayjs().valueOf() - startTime;
                 } else {
                     bean.msg = "Unknown Monitor Type";
                     bean.status = PENDING;

server/server.js

@@ -669,6 +669,8 @@ let needSetup = false;
                 bean.mqttPassword = monitor.mqttPassword;
                 bean.mqttTopic = monitor.mqttTopic;
                 bean.mqttSuccessMessage = monitor.mqttSuccessMessage;
+                bean.databaseConnectionString = monitor.databaseConnectionString;
+                bean.databaseQuery = monitor.databaseQuery;
 
                 await R.store(bean);
 

server/util-server.js

@@ -10,6 +10,7 @@ const chardet = require("chardet");
 const mqtt = require("mqtt");
 const chroma = require("chroma-js");
 const { badgeConstants } = require("./config");
+const mssql = require("mssql");
 
 // From ping-lite
 exports.WIN = /^win/.test(process.platform);
@@ -207,6 +208,31 @@ exports.dnsResolve = function (hostname, resolverServer, resolverPort, rrtype) {
     });
 };
 
+/**
+ * Run a query on SQL Server
+ * @param {string} connectionString The database connection string
+ * @param {string} query The query to validate the database with
+ * @returns {Promise<(string[]|Object[]|Object)>}
+ */
+exports.mssqlQuery = function (connectionString, query) {
+    return new Promise((resolve, reject) => {
+        mssql.on("error", err => {
+            reject(err);
+        });
+
+        mssql.connect(connectionString).then(pool => {
+            return pool.request()
+                .query(query);
+        }).then(result => {
+            resolve(result);
+        }).catch(err => {
+            reject(err);
+        }).finally(() => {
+            mssql.close();
+        });
+    });
+};
+
 /**
  * Retrieve value of setting based on key
  * @param {string} key Key of setting to retrieve

src/languages/en.js

@@ -525,4 +525,6 @@ export default {
     "Go back to the previous page.": "Go back to the previous page.",
     "Coming Soon": "Coming Soon",
     wayToGetClickSendSMSToken: "You can get API Username and API Key from {0} .",
+    "Connection String": "Connection String",
+    "Query": "Query",
 };

src/pages/EditMonitor.vue

@@ -35,6 +35,9 @@
                                     <option value="mqtt">
                                         MQTT
                                     </option>
+                                    <option value="sqlserver">
+                                        SQL Server
+                                    </option>
                                 </select>
                             </div>
 
@@ -157,6 +160,18 @@
                                 </div>
                             </template>
 
+                            <!-- SQL Server -->
+                            <template v-if="monitor.type === 'sqlserver'">
+                                <div class="my-3">
+                                    <label for="sqlserverConnectionString" class="form-label">SQL Server {{ $t("Connection String") }}</label>
+                                    <input id="sqlserverConnectionString" v-model="monitor.databaseConnectionString" type="text" class="form-control">
+                                </div>
+                                <div class="my-3">
+                                    <label for="sqlserverQuery" class="form-label">SQL Server {{ $t("Query") }}</label>
+                                    <textarea id="sqlserverQuery" v-model="monitor.databaseQuery" class="form-control" placeholder="Example: select getdate()"></textarea>
+                                </div>
+                            </template>
+
                             <!-- Interval -->
                             <div class="my-3">
                                 <label for="interval" class="form-label">{{ $t("Heartbeat Interval") }} ({{ $t("checkEverySecond", [ monitor.interval ]) }})</label>