From 6476e58907305992694024372c5f7daa4e2dc95b Mon Sep 17 00:00:00 2001 From: Xiaoyu <614422099@QQ.com> Date: Tue, 8 Oct 2024 17:39:22 +0800 Subject: [PATCH 1/3] Fix: Resolve notice title definition issue and add newline between title and content in notification (#5166) --- server/notification-providers/wecom.js | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/server/notification-providers/wecom.js b/server/notification-providers/wecom.js index 03fa7c18..1eb06909 100644 --- a/server/notification-providers/wecom.js +++ b/server/notification-providers/wecom.js @@ -32,20 +32,17 @@ class WeCom extends NotificationProvider { * @returns {object} Message */ composeMessage(heartbeatJSON, msg) { - let title; + let title = "UptimeKuma Message"; if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === UP) { title = "UptimeKuma Monitor Up"; } if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === DOWN) { title = "UptimeKuma Monitor Down"; } - if (msg != null) { - title = "UptimeKuma Message"; - } return { msgtype: "text", text: { - content: title + msg + content: title + "\n" + msg } }; } From 59e70cb7635e6986be3ded4ec5bc8f21432b72c5 Mon Sep 17 00:00:00 2001 From: Daan Meijer Date: Tue, 8 Oct 2024 12:09:58 +0200 Subject: [PATCH 2/3] [slack] allow the user to choose the message format to send (#5167) Co-authored-by: Louis Lam Co-authored-by: Frank Elsinga --- server/notification-providers/slack.js | 13 +++++++++---- src/components/notifications/Slack.vue | 6 ++++++ src/lang/en.json | 2 ++ 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/server/notification-providers/slack.js b/server/notification-providers/slack.js index 98ed1a90..77264205 100644 --- a/server/notification-providers/slack.js +++ b/server/notification-providers/slack.js @@ -139,17 +139,22 @@ class Slack extends NotificationProvider { const title = "Uptime Kuma Alert"; let data = { - "text": `${title}\n${msg}`, "channel": notification.slackchannel, "username": notification.slackusername, "icon_emoji": notification.slackiconemo, - "attachments": [ + "attachments": [], + }; + + if (notification.slackrichmessage) { + data.attachments.push( { "color": (heartbeatJSON["status"] === UP) ? "#2eb886" : "#e01e5a", "blocks": Slack.buildBlocks(baseURL, monitorJSON, heartbeatJSON, title, msg), } - ] - }; + ); + } else { + data.text = `${title}\n${msg}`; + } if (notification.slackbutton) { await Slack.deprecateURL(notification.slackbutton); diff --git a/src/components/notifications/Slack.vue b/src/components/notifications/Slack.vue index dead709c..dc07bf37 100644 --- a/src/components/notifications/Slack.vue +++ b/src/components/notifications/Slack.vue @@ -9,6 +9,12 @@ + +
+ + +
+
*{{ $t("Required") }} diff --git a/src/lang/en.json b/src/lang/en.json index 3a4ca715..968a3d9f 100644 --- a/src/lang/en.json +++ b/src/lang/en.json @@ -895,6 +895,8 @@ "cacheBusterParamDescription": "Randomly generated parameter to skip caches.", "gamedigGuessPort": "Gamedig: Guess Port", "gamedigGuessPortDescription": "The port used by Valve Server Query Protocol may be different from the client port. Try this if the monitor cannot connect to your server.", + "Message format": "Message format", + "Send rich messages": "Send rich messages", "Bitrix24 Webhook URL": "Bitrix24 Webhook URL", "wayToGetBitrix24Webhook": "You can create a webhook by following the steps at {0}", "bitrix24SupportUserID": "Enter your user ID in Bitrix24. You can find out the ID from the link by going to the user's profile.", From 4829ad8c5dfa73fcd3d661b6da70f7a5f9a1410b Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 9 Oct 2024 07:17:11 +0800 Subject: [PATCH 3/3] Revert "Extend Prometheus Labels to include tags (requires restart for NEW labels on the monitor to be visible)" (#5174) --- server/model/monitor.js | 4 +- server/prometheus.js | 144 ++++++++++------------------------------ 2 files changed, 38 insertions(+), 110 deletions(-) diff --git a/server/model/monitor.js b/server/model/monitor.js index 78485c4c..ff73036c 100644 --- a/server/model/monitor.js +++ b/server/model/monitor.js @@ -326,7 +326,7 @@ class Monitor extends BeanModel { let previousBeat = null; let retries = 0; - this.prometheus = await Prometheus.createAndInitMetrics(this); + this.prometheus = new Prometheus(this); const beat = async () => { @@ -978,7 +978,7 @@ class Monitor extends BeanModel { await R.store(bean); log.debug("monitor", `[${this.name}] prometheus.update`); - await this.prometheus?.update(bean, tlsInfo); + this.prometheus?.update(bean, tlsInfo); previousBeat = bean; diff --git a/server/prometheus.js b/server/prometheus.js index 05a02839..f26125d2 100644 --- a/server/prometheus.js +++ b/server/prometheus.js @@ -1,4 +1,3 @@ -const { R } = require("redbean-node"); const PrometheusClient = require("prom-client"); const { log } = require("../src/util"); @@ -10,102 +9,36 @@ const commonLabels = [ "monitor_port", ]; -class Prometheus { - - /** - * Metric: monitor_cert_days_remaining - * @type {PrometheusClient.Gauge | null} - */ - static monitorCertDaysRemaining = null; - - /** - * Metric: monitor_cert_is_valid - * @type {PrometheusClient.Gauge | null} - */ - static monitorCertIsValid = null; - - /** - * Metric: monitor_response_time - * @type {PrometheusClient.Gauge | null} - */ - static monitorResponseTime = null; - - /** - * Metric: monitor_status - * @type {PrometheusClient.Gauge | null} - */ - static monitorStatus = null; - - /** - * All registered metric labels. - * @type {string[] | null} - */ - static monitorLabelNames = null; - - /** - * Monitor labels/values combination. - * @type {{}} - */ - monitorLabelValues; +const monitorCertDaysRemaining = new PrometheusClient.Gauge({ + name: "monitor_cert_days_remaining", + help: "The number of days remaining until the certificate expires", + labelNames: commonLabels +}); + +const monitorCertIsValid = new PrometheusClient.Gauge({ + name: "monitor_cert_is_valid", + help: "Is the certificate still valid? (1 = Yes, 0= No)", + labelNames: commonLabels +}); +const monitorResponseTime = new PrometheusClient.Gauge({ + name: "monitor_response_time", + help: "Monitor Response Time (ms)", + labelNames: commonLabels +}); + +const monitorStatus = new PrometheusClient.Gauge({ + name: "monitor_status", + help: "Monitor Status (1 = UP, 0= DOWN, 2= PENDING, 3= MAINTENANCE)", + labelNames: commonLabels +}); - /** - * Initialize metrics and get all label names the first time called. - * @returns {void} - */ - static async initMetrics() { - if (!this.monitorLabelNames) { - let labelNames = await R.getCol("SELECT name FROM tag"); - this.monitorLabelNames = [ ...commonLabels, ...labelNames ]; - } - if (!this.monitorCertDaysRemaining) { - this.monitorCertDaysRemaining = new PrometheusClient.Gauge({ - name: "monitor_cert_days_remaining", - help: "The number of days remaining until the certificate expires", - labelNames: this.monitorLabelNames - }); - } - if (!this.monitorCertIsValid) { - this.monitorCertIsValid = new PrometheusClient.Gauge({ - name: "monitor_cert_is_valid", - help: "Is the certificate still valid? (1 = Yes, 0 = No)", - labelNames: this.monitorLabelNames - }); - } - if (!this.monitorResponseTime) { - this.monitorResponseTime = new PrometheusClient.Gauge({ - name: "monitor_response_time", - help: "Monitor Response Time (ms)", - labelNames: this.monitorLabelNames - }); - } - if (!this.monitorStatus) { - this.monitorStatus = new PrometheusClient.Gauge({ - name: "monitor_status", - help: "Monitor Status (1 = UP, 0 = DOWN, 2 = PENDING, 3 = MAINTENANCE)", - labelNames: this.monitorLabelNames - }); - } - } - - /** - * Wrapper to create a `Prometheus` instance and ensure metrics are initialized. - * @param {Monitor} monitor Monitor object to monitor - * @returns {Promise} `Prometheus` instance - */ - static async createAndInitMetrics(monitor) { - await Prometheus.initMetrics(); - let tags = await monitor.getTags(); - return new Prometheus(monitor, tags); - } +class Prometheus { + monitorLabelValues = {}; /** - * Creates a prometheus metric instance. - * - * Note: Make sure to call `Prometheus.initMetrics()` once prior creating Prometheus instances. - * @param {Monitor} monitor Monitor object to monitor - * @param {Promise[]>} tags Tags of the monitor + * @param {object} monitor Monitor object to monitor */ - constructor(monitor, tags) { + constructor(monitor) { this.monitorLabelValues = { monitor_name: monitor.name, monitor_type: monitor.type, @@ -113,12 +46,6 @@ class Prometheus { monitor_hostname: monitor.hostname, monitor_port: monitor.port }; - Object.values(tags) - // only label names that were known at first metric creation. - .filter(tag => Prometheus.monitorLabelNames.includes(tag.name)) - .forEach(tag => { - this.monitorLabelValues[tag.name] = tag.value; - }); } /** @@ -128,6 +55,7 @@ class Prometheus { * @returns {void} */ update(heartbeat, tlsInfo) { + if (typeof tlsInfo !== "undefined") { try { let isValid; @@ -136,7 +64,7 @@ class Prometheus { } else { isValid = 0; } - Prometheus.monitorCertIsValid.set(this.monitorLabelValues, isValid); + monitorCertIsValid.set(this.monitorLabelValues, isValid); } catch (e) { log.error("prometheus", "Caught error"); log.error("prometheus", e); @@ -144,7 +72,7 @@ class Prometheus { try { if (tlsInfo.certInfo != null) { - Prometheus.monitorCertDaysRemaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining); + monitorCertDaysRemaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining); } } catch (e) { log.error("prometheus", "Caught error"); @@ -154,7 +82,7 @@ class Prometheus { if (heartbeat) { try { - Prometheus.monitorStatus.set(this.monitorLabelValues, heartbeat.status); + monitorStatus.set(this.monitorLabelValues, heartbeat.status); } catch (e) { log.error("prometheus", "Caught error"); log.error("prometheus", e); @@ -162,10 +90,10 @@ class Prometheus { try { if (typeof heartbeat.ping === "number") { - Prometheus.monitorResponseTime.set(this.monitorLabelValues, heartbeat.ping); + monitorResponseTime.set(this.monitorLabelValues, heartbeat.ping); } else { // Is it good? - Prometheus.monitorResponseTime.set(this.monitorLabelValues, -1); + monitorResponseTime.set(this.monitorLabelValues, -1); } } catch (e) { log.error("prometheus", "Caught error"); @@ -180,10 +108,10 @@ class Prometheus { */ remove() { try { - Prometheus.monitorCertDaysRemaining?.remove(this.monitorLabelValues); - Prometheus.monitorCertIsValid?.remove(this.monitorLabelValues); - Prometheus.monitorResponseTime?.remove(this.monitorLabelValues); - Prometheus.monitorStatus?.remove(this.monitorLabelValues); + monitorCertDaysRemaining.remove(this.monitorLabelValues); + monitorCertIsValid.remove(this.monitorLabelValues); + monitorResponseTime.remove(this.monitorLabelValues); + monitorStatus.remove(this.monitorLabelValues); } catch (e) { console.error(e); }