Feature: true ping, rename old ping to siteMonitor (#2215)

src/components/services/item.jsx

@@ -4,6 +4,7 @@ import { useContext, useState } from "react";
 import Status from "./status";
 import Widget from "./widget";
 import Ping from "./ping";
+import SiteMonitor from "./site-monitor";
 import KubernetesStatus from "./kubernetes-status";
 
 import Docker from "widgets/docker/component";
@@ -93,6 +94,13 @@ export default function Item({ service, group }) {
               </div>
             )}
 
+            {service.siteMonitor && (
+              <div className="flex-shrink-0 flex items-center justify-center service-tag service-site-monitor">
+                <SiteMonitor group={group} service={service.name} style={statusStyle} />
+                <span className="sr-only">Site monitor status</span>
+              </div>
+            )}
+
             {service.container && (
               <button
                 type="button"

src/components/services/ping.jsx

@@ -9,7 +9,7 @@ export default function Ping({ group, service, style }) {
 
   let colorClass = "text-black/20 dark:text-white/40 opacity-20";
   let backgroundClass = "bg-theme-500/10 dark:bg-theme-900/50 px-1.5 py-0.5";
-  let statusTitle = t("ping.http_status");
+  let statusTitle = t("ping.ping");
   let statusText = "";
 
   if (error) {
@@ -19,18 +19,13 @@ export default function Ping({ group, service, style }) {
   } else if (!data) {
     statusText = t("ping.ping");
     statusTitle += ` ${t("ping.not_available")}`;
-  } else if (data.status > 403) {
+  } else if (!data.alive) {
     colorClass = "text-rose-500/80";
-    statusTitle += ` ${data.status}`;
-
-    if (style === "basic") {
-      statusText = t("ping.down");
-    } else {
-      statusText = data.status;
-    }
-  } else if (data) {
-    const ping = t("common.ms", { value: data.latency, style: "unit", unit: "millisecond", maximumFractionDigits: 0 });
-    statusTitle += ` ${data.status} (${ping})`;
+    statusTitle += ` ${t("ping.down")}`;
+    statusText = t("ping.down");
+  } else if (data.alive) {
+    const ping = t("common.ms", { value: data.time, style: "unit", unit: "millisecond", maximumFractionDigits: 0 });
+    statusTitle += ` ${t("ping.up")} (${ping})`;
     colorClass = "text-emerald-500/80";
 
     if (style === "basic") {

src/components/services/site-monitor.jsx

@@ -0,0 +1,63 @@
+import { useTranslation } from "react-i18next";
+import useSWR from "swr";
+
+export default function SiteMonitor({ group, service, style }) {
+  const { t } = useTranslation();
+  const { data, error } = useSWR(`/api/siteMonitor?${new URLSearchParams({ group, service }).toString()}`, {
+    refreshInterval: 30000,
+  });
+
+  let colorClass = "text-black/20 dark:text-white/40 opacity-20";
+  let backgroundClass = "bg-theme-500/10 dark:bg-theme-900/50 px-1.5 py-0.5";
+  let statusTitle = t("siteMonitor.http_status");
+  let statusText = "";
+
+  if (error) {
+    colorClass = "text-rose-500";
+    statusText = t("siteMonitor.error");
+    statusTitle += ` ${t("siteMonitor.error")}`;
+  } else if (!data) {
+    statusText = t("siteMonitor.response");
+    statusTitle += ` ${t("siteMonitor.not_available")}`;
+  } else if (data.status > 403) {
+    colorClass = "text-rose-500/80";
+    statusTitle += ` ${data.status}`;
+
+    if (style === "basic") {
+      statusText = t("siteMonitor.down");
+    } else {
+      statusText = data.status;
+    }
+  } else if (data) {
+    const responseTime = t("common.ms", {
+      value: data.latency,
+      style: "unit",
+      unit: "millisecond",
+      maximumFractionDigits: 0,
+    });
+    statusTitle += ` ${data.status} (${responseTime})`;
+    colorClass = "text-emerald-500/80";
+
+    if (style === "basic") {
+      statusText = t("siteMonitor.up");
+    } else {
+      statusText = responseTime;
+      colorClass += " lowercase";
+    }
+  }
+
+  if (style === "dot") {
+    backgroundClass = "p-4";
+    colorClass = colorClass.replace(/text-/g, "bg-").replace(/\/\d\d/g, "");
+  }
+
+  return (
+    <div
+      className={`w-auto text-center rounded-b-[3px] overflow-hidden site-monitor-status ${backgroundClass}`}
+      title={statusTitle}
+    >
+      {style !== "dot" && <div className={`font-bold uppercase text-[8px] ${colorClass}`}>{statusText}</div>}
+      {style === "dot" && <div className={`rounded-full h-3 w-3 ${colorClass}`} />}
+    </div>
+  );
+}

src/pages/api/ping.js

@@ -1,8 +1,7 @@
-import { performance } from "perf_hooks";
+import { promise as ping } from "ping";
 
 import { getServiceItem } from "utils/config/service-helpers";
 import createLogger from "utils/logger";
-import { httpProxy } from "utils/proxy/http";
 
 const logger = createLogger("ping");
 
@@ -16,35 +15,28 @@ export default async function handler(req, res) {
     });
   }
 
-  const { ping: pingURL } = serviceItem;
+  const { ping: pingHostOrURL } = serviceItem;
 
-  if (!pingURL) {
-    logger.debug("No ping URL specified");
+  if (!pingHostOrURL) {
+    logger.debug("No ping host specified");
     return res.status(400).send({
-      error: "No ping URL given",
+      error: "No ping host given",
     });
   }
 
+  let hostname = pingHostOrURL;
   try {
-    let startTime = performance.now();
-    let [status] = await httpProxy(pingURL, {
-      method: "HEAD",
-    });
-    let endTime = performance.now();
-
-    if (status > 403) {
-      // try one more time as a GET in case HEAD is rejected for whatever reason
-      startTime = performance.now();
-      [status] = await httpProxy(pingURL);
-      endTime = performance.now();
-    }
-
-    return res.status(200).json({
-      status,
-      latency: endTime - startTime,
-    });
+    // maintain backwards compatibility with old ping where may be http://...
+    hostname = new URL(pingHostOrURL).hostname;
   } catch (e) {
-    logger.debug("Error attempting ping: %s", JSON.stringify(e));
+    // eslint-disable-line no-empty
+  }
+
+  try {
+    const response = await ping.probe(hostname);
+    return res.status(200).json(response);
+  } catch (e) {
+    logger.debug("Error attempting ping: %s", e);
     return res.status(400).send({
       error: "Error attempting ping, see logs.",
     });

src/pages/api/siteMonitor.js

@@ -0,0 +1,52 @@
+import { performance } from "perf_hooks";
+
+import { getServiceItem } from "utils/config/service-helpers";
+import createLogger from "utils/logger";
+import { httpProxy } from "utils/proxy/http";
+
+const logger = createLogger("siteMonitor");
+
+export default async function handler(req, res) {
+  const { group, service } = req.query;
+  const serviceItem = await getServiceItem(group, service);
+  if (!serviceItem) {
+    logger.debug(`No service item found for group ${group} named ${service}`);
+    return res.status(400).send({
+      error: "Unable to find service, see log for details.",
+    });
+  }
+
+  const { siteMonitor: monitorURL } = serviceItem;
+
+  if (!monitorURL) {
+    logger.debug("No http monitor URL specified");
+    return res.status(400).send({
+      error: "No http monitor URL given",
+    });
+  }
+
+  try {
+    let startTime = performance.now();
+    let [status] = await httpProxy(monitorURL, {
+      method: "HEAD",
+    });
+    let endTime = performance.now();
+
+    if (status > 403) {
+      // try one more time as a GET in case HEAD is rejected for whatever reason
+      startTime = performance.now();
+      [status] = await httpProxy(monitorURL);
+      endTime = performance.now();
+    }
+
+    return res.status(200).json({
+      status,
+      latency: endTime - startTime,
+    });
+  } catch (e) {
+    logger.debug("Error attempting http monitor: %s", e);
+    return res.status(400).send({
+      error: "Error attempting http monitor, see logs.",
+    });
+  }
+}

src/utils/config/service-helpers.js

@@ -258,6 +258,9 @@ export async function servicesFromKubernetes() {
         if (ingress.metadata.annotations[`${ANNOTATION_BASE}/ping`]) {
           constructedService.ping = ingress.metadata.annotations[`${ANNOTATION_BASE}/ping`];
         }
+        if (ingress.metadata.annotations[`${ANNOTATION_BASE}/siteMonitor`]) {
+          constructedService.siteMonitor = ingress.metadata.annotations[`${ANNOTATION_BASE}/siteMonitor`];
+        }
         if (ingress.metadata.annotations[`${ANNOTATION_BASE}/statusStyle`]) {
           constructedService.statusStyle = ingress.metadata.annotations[`${ANNOTATION_BASE}/statusStyle`];
         }