Add Flashduty notification (#3475)

* feat: add FlashDuty notification channel * refactor: #3475 nofify with Up or Down; refactor code; add en zh-hk zh-tw lang * refactor: default select Info * refactor: add space in word * refactor the flashduty notification code * refactor:compatible when Test flashduty nofication * refactor: add function param description * refactor: revert zh-hk zh-tw changes of flashduty
2025-08-10 01:17:33 +08:00 · 2023-08-01 02:13:04 +08:00
parent ae2867e305
commit 587d9e4781
8 changed files with 140 additions and 3 deletions
--- a/server/notification-providers/flashduty.js
+++ b/server/notification-providers/flashduty.js
@@ -0,0 +1,98 @@
+const NotificationProvider = require("./notification-provider");
+const axios = require("axios");
+const { UP, DOWN, getMonitorRelativeURL } = require("../../src/util");
+const { setting } = require("../util-server");
+const successMessage = "Sent Successfully.";
+
+class FlashDuty extends NotificationProvider {
+    name = "FlashDuty";
+
+    async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
+        try {
+            if (heartbeatJSON == null) {
+                const title = "Uptime Kuma Alert";
+                const monitor = {
+                    type: "ping",
+                    url: msg,
+                    name: "https://flashcat.cloud"
+                };
+                return this.postNotification(notification, title, msg, monitor);
+            }
+
+            if (heartbeatJSON.status === UP) {
+                const title = "Uptime Kuma Monitor ✅ Up";
+
+                return this.postNotification(notification, title, heartbeatJSON.msg, monitorJSON, "Ok");
+            }
+
+            if (heartbeatJSON.status === DOWN) {
+                const title = "Uptime Kuma Monitor 🔴 Down";
+                return this.postNotification(notification, title, heartbeatJSON.msg, monitorJSON, notification.flashdutySeverity);
+            }
+        } catch (error) {
+            this.throwGeneralAxiosError(error);
+        }
+    }
+    /**
+     * Generate a monitor url from the monitors infomation
+     * @param {Object} monitorInfo Monitor details
+     * @returns {string|undefined}
+     */
+
+    genMonitorUrl(monitorInfo) {
+        if (monitorInfo.type === "port" && monitorInfo.port) {
+            return monitorInfo.hostname + ":" + monitorInfo.port;
+        }
+        if (monitorInfo.hostname != null) {
+            return monitorInfo.hostname;
+        }
+        return monitorInfo.url;
+    }
+
+    /**
+     * Send the message
+     * @param {BeanModel} notification Message title
+     * @param {string} title Message
+     * @param {string} body Message
+     * @param {Object} monitorInfo Monitor details
+     * @param {string} eventStatus Monitor status (Info, Warning, Critical, Ok)
+     * @returns {string}
+     */
+    async postNotification(notification, title, body, monitorInfo, eventStatus) {
+        const options = {
+            method: "POST",
+            url: "https://api.flashcat.cloud/event/push/alert/standard?integration_key=" + notification.flashdutyIntegrationKey,
+            headers: { "Content-Type": "application/json" },
+            data: {
+                description: `[${title}] [${monitorInfo.name}] ${body}`,
+                title,
+                event_status: eventStatus || "Info",
+                alert_key: String(monitorInfo.id) || Math.random().toString(36).substring(7),
+                labels: monitorInfo?.tags?.reduce((acc, item) => ({ ...acc,
+                    [item.name]: item.value
+                }), { resource: this.genMonitorUrl(monitorInfo) }),
+            }
+        };
+
+        const baseURL = await setting("primaryBaseURL");
+        if (baseURL && monitorInfo) {
+            options.client = "Uptime Kuma";
+            options.client_url = baseURL + getMonitorRelativeURL(monitorInfo.id);
+        }
+
+        let result = await axios.request(options);
+        if (result.status == null) {
+            throw new Error("FlashDuty notification failed with invalid response!");
+        }
+        if (result.status < 200 || result.status >= 300) {
+            throw new Error("FlashDuty notification failed with status code " + result.status);
+        }
+        if (result.statusText != null) {
+            return "FlashDuty notification succeed: " + result.statusText;
+        }
+
+        return successMessage;
+    }
+}
+
+module.exports = FlashDuty;