Merge pull request #200 from proffalken/feature/187_add_cert_checks_to_prometheus

Add certificate monitoring to the Prometheus handler

server/model/monitor.js

@@ -80,6 +80,10 @@ class Monitor extends BeanModel {
 
         const beat = async () => {
 
+            // Expose here for prometheus update
+            // undefined if not https
+            let tlsInfo = undefined;
+
             if (! previousBeat) {
                 previousBeat = await R.findOne("heartbeat", " monitor_id = ? ORDER BY time DESC", [
                     this.id,
@@ -133,7 +137,7 @@ class Monitor extends BeanModel {
                     let certInfoStartTime = dayjs().valueOf();
                     if (this.getUrl()?.protocol === "https:") {
                         try {
-                            await this.updateTlsInfo(checkCertificate(res));
+                            tlsInfo = await this.updateTlsInfo(checkCertificate(res));
                         } catch (e) {
                             if (e.message !== "No TLS certificate in response") {
                                 console.error(e.message)
@@ -255,7 +259,7 @@ class Monitor extends BeanModel {
                 console.warn(`Monitor #${this.id} '${this.name}': Failing: ${bean.msg} | Type: ${this.type}`)
             }
 
-            prometheus.update(bean)
+            prometheus.update(bean, tlsInfo)
 
             io.to(this.user_id).emit("heartbeat", bean.toJSON());
 
@@ -290,7 +294,7 @@ class Monitor extends BeanModel {
     /**
      * Store TLS info to database
      * @param checkCertificateResult
-     * @returns {Promise<void>}
+     * @returns {Promise<object>}
      */
     async updateTlsInfo(checkCertificateResult) {
         let tls_info_bean = await R.findOne("monitor_tls_info", "monitor_id = ?", [
@@ -302,6 +306,8 @@ class Monitor extends BeanModel {
         }
         tls_info_bean.info_json = JSON.stringify(checkCertificateResult);
         await R.store(tls_info_bean);
+
+        return checkCertificateResult;
     }
 
     static async sendStats(io, monitorID, userID) {

server/prometheus.js

@@ -1,22 +1,33 @@
-const PrometheusClient = require('prom-client');
+const PrometheusClient = require("prom-client");
 
 const commonLabels = [
-    'monitor_name',
+    "monitor_name",
-    'monitor_type',
+    "monitor_type",
-    'monitor_url',
+    "monitor_url",
-    'monitor_hostname',
+    "monitor_hostname",
-    'monitor_port',
+    "monitor_port",
 ]
 
+const monitor_cert_days_remaining = new PrometheusClient.Gauge({
+    name: "monitor_cert_days_remaining",
+    help: "The number of days remaining until the certificate expires",
+    labelNames: commonLabels
+});
+
+const monitor_cert_is_valid = new PrometheusClient.Gauge({
+    name: "monitor_cert_is_valid",
+    help: "Is the certificate still valid? (1 = Yes, 0= No)",
+    labelNames: commonLabels
+});
 const monitor_response_time = new PrometheusClient.Gauge({
-    name: 'monitor_response_time',
+    name: "monitor_response_time",
-    help: 'Monitor Response Time (ms)',
+    help: "Monitor Response Time (ms)",
     labelNames: commonLabels
 });
 
 const monitor_status = new PrometheusClient.Gauge({
-    name: 'monitor_status',
+    name: "monitor_status",
-    help: 'Monitor Status (1 = UP, 0= DOWN)',
+    help: "Monitor Status (1 = UP, 0= DOWN)",
     labelNames: commonLabels
 });
 
@@ -33,7 +44,27 @@ class Prometheus {
         }
     }
 
-    update(heartbeat) {
+    update(heartbeat, tlsInfo) {
+        if (typeof tlsInfo !== "undefined") {
+            try {
+                let is_valid = 0
+                if (tlsInfo.valid == true) {
+                    is_valid = 1
+                } else {
+                    is_valid = 0
+                }
+                monitor_cert_is_valid.set(this.monitorLabelValues, is_valid)
+            } catch (e) {
+                console.error(e)
+            }
+
+            try {
+                monitor_cert_days_remaining.set(this.monitorLabelValues, tlsInfo.daysRemaining)
+            } catch (e) {
+                console.error(e)
+            }
+        }
+
         try {
             monitor_status.set(this.monitorLabelValues, heartbeat.status)
         } catch (e) {
@@ -41,7 +72,7 @@ class Prometheus {
         }
 
         try {
-            if (typeof heartbeat.ping === 'number') {
+            if (typeof heartbeat.ping === "number") {
                 monitor_response_time.set(this.monitorLabelValues, heartbeat.ping)
             } else {
                 // Is it good?