mirror of
https://github.com/louislam/uptime-kuma.git
synced 2024-11-27 16:54:04 +00:00
Merge branch 'master' into 2.0-last-part
This commit is contained in:
commit
9ff9a9edcc
6 changed files with 57 additions and 119 deletions
|
@ -326,7 +326,7 @@ class Monitor extends BeanModel {
|
||||||
let previousBeat = null;
|
let previousBeat = null;
|
||||||
let retries = 0;
|
let retries = 0;
|
||||||
|
|
||||||
this.prometheus = await Prometheus.createAndInitMetrics(this);
|
this.prometheus = new Prometheus(this);
|
||||||
|
|
||||||
const beat = async () => {
|
const beat = async () => {
|
||||||
|
|
||||||
|
@ -978,7 +978,7 @@ class Monitor extends BeanModel {
|
||||||
await R.store(bean);
|
await R.store(bean);
|
||||||
|
|
||||||
log.debug("monitor", `[${this.name}] prometheus.update`);
|
log.debug("monitor", `[${this.name}] prometheus.update`);
|
||||||
await this.prometheus?.update(bean, tlsInfo);
|
this.prometheus?.update(bean, tlsInfo);
|
||||||
|
|
||||||
previousBeat = bean;
|
previousBeat = bean;
|
||||||
|
|
||||||
|
|
|
@ -139,17 +139,22 @@ class Slack extends NotificationProvider {
|
||||||
|
|
||||||
const title = "Uptime Kuma Alert";
|
const title = "Uptime Kuma Alert";
|
||||||
let data = {
|
let data = {
|
||||||
"text": `${title}\n${msg}`,
|
|
||||||
"channel": notification.slackchannel,
|
"channel": notification.slackchannel,
|
||||||
"username": notification.slackusername,
|
"username": notification.slackusername,
|
||||||
"icon_emoji": notification.slackiconemo,
|
"icon_emoji": notification.slackiconemo,
|
||||||
"attachments": [
|
"attachments": [],
|
||||||
|
};
|
||||||
|
|
||||||
|
if (notification.slackrichmessage) {
|
||||||
|
data.attachments.push(
|
||||||
{
|
{
|
||||||
"color": (heartbeatJSON["status"] === UP) ? "#2eb886" : "#e01e5a",
|
"color": (heartbeatJSON["status"] === UP) ? "#2eb886" : "#e01e5a",
|
||||||
"blocks": Slack.buildBlocks(baseURL, monitorJSON, heartbeatJSON, title, msg),
|
"blocks": Slack.buildBlocks(baseURL, monitorJSON, heartbeatJSON, title, msg),
|
||||||
}
|
}
|
||||||
]
|
);
|
||||||
};
|
} else {
|
||||||
|
data.text = `${title}\n${msg}`;
|
||||||
|
}
|
||||||
|
|
||||||
if (notification.slackbutton) {
|
if (notification.slackbutton) {
|
||||||
await Slack.deprecateURL(notification.slackbutton);
|
await Slack.deprecateURL(notification.slackbutton);
|
||||||
|
|
|
@ -32,20 +32,17 @@ class WeCom extends NotificationProvider {
|
||||||
* @returns {object} Message
|
* @returns {object} Message
|
||||||
*/
|
*/
|
||||||
composeMessage(heartbeatJSON, msg) {
|
composeMessage(heartbeatJSON, msg) {
|
||||||
let title;
|
let title = "UptimeKuma Message";
|
||||||
if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === UP) {
|
if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === UP) {
|
||||||
title = "UptimeKuma Monitor Up";
|
title = "UptimeKuma Monitor Up";
|
||||||
}
|
}
|
||||||
if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === DOWN) {
|
if (msg != null && heartbeatJSON != null && heartbeatJSON["status"] === DOWN) {
|
||||||
title = "UptimeKuma Monitor Down";
|
title = "UptimeKuma Monitor Down";
|
||||||
}
|
}
|
||||||
if (msg != null) {
|
|
||||||
title = "UptimeKuma Message";
|
|
||||||
}
|
|
||||||
return {
|
return {
|
||||||
msgtype: "text",
|
msgtype: "text",
|
||||||
text: {
|
text: {
|
||||||
content: title + msg
|
content: title + "\n" + msg
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,4 +1,3 @@
|
||||||
const { R } = require("redbean-node");
|
|
||||||
const PrometheusClient = require("prom-client");
|
const PrometheusClient = require("prom-client");
|
||||||
const { log } = require("../src/util");
|
const { log } = require("../src/util");
|
||||||
|
|
||||||
|
@ -10,102 +9,36 @@ const commonLabels = [
|
||||||
"monitor_port",
|
"monitor_port",
|
||||||
];
|
];
|
||||||
|
|
||||||
|
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
|
||||||
|
});
|
||||||
|
|
||||||
class Prometheus {
|
class Prometheus {
|
||||||
|
monitorLabelValues = {};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Metric: monitor_cert_days_remaining
|
* @param {object} monitor Monitor object to monitor
|
||||||
* @type {PrometheusClient.Gauge<string> | null}
|
|
||||||
*/
|
*/
|
||||||
static monitorCertDaysRemaining = null;
|
constructor(monitor) {
|
||||||
|
|
||||||
/**
|
|
||||||
* Metric: monitor_cert_is_valid
|
|
||||||
* @type {PrometheusClient.Gauge<string> | null}
|
|
||||||
*/
|
|
||||||
static monitorCertIsValid = null;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Metric: monitor_response_time
|
|
||||||
* @type {PrometheusClient.Gauge<string> | null}
|
|
||||||
*/
|
|
||||||
static monitorResponseTime = null;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Metric: monitor_status
|
|
||||||
* @type {PrometheusClient.Gauge<string> | null}
|
|
||||||
*/
|
|
||||||
static monitorStatus = null;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* All registered metric labels.
|
|
||||||
* @type {string[] | null}
|
|
||||||
*/
|
|
||||||
static monitorLabelNames = null;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Monitor labels/values combination.
|
|
||||||
* @type {{}}
|
|
||||||
*/
|
|
||||||
monitorLabelValues;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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>} `Prometheus` instance
|
|
||||||
*/
|
|
||||||
static async createAndInitMetrics(monitor) {
|
|
||||||
await Prometheus.initMetrics();
|
|
||||||
let tags = await monitor.getTags();
|
|
||||||
return new Prometheus(monitor, tags);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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<LooseObject<any>[]>} tags Tags of the monitor
|
|
||||||
*/
|
|
||||||
constructor(monitor, tags) {
|
|
||||||
this.monitorLabelValues = {
|
this.monitorLabelValues = {
|
||||||
monitor_name: monitor.name,
|
monitor_name: monitor.name,
|
||||||
monitor_type: monitor.type,
|
monitor_type: monitor.type,
|
||||||
|
@ -113,12 +46,6 @@ class Prometheus {
|
||||||
monitor_hostname: monitor.hostname,
|
monitor_hostname: monitor.hostname,
|
||||||
monitor_port: monitor.port
|
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}
|
* @returns {void}
|
||||||
*/
|
*/
|
||||||
update(heartbeat, tlsInfo) {
|
update(heartbeat, tlsInfo) {
|
||||||
|
|
||||||
if (typeof tlsInfo !== "undefined") {
|
if (typeof tlsInfo !== "undefined") {
|
||||||
try {
|
try {
|
||||||
let isValid;
|
let isValid;
|
||||||
|
@ -136,7 +64,7 @@ class Prometheus {
|
||||||
} else {
|
} else {
|
||||||
isValid = 0;
|
isValid = 0;
|
||||||
}
|
}
|
||||||
Prometheus.monitorCertIsValid.set(this.monitorLabelValues, isValid);
|
monitorCertIsValid.set(this.monitorLabelValues, isValid);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
log.error("prometheus", "Caught error");
|
log.error("prometheus", "Caught error");
|
||||||
log.error("prometheus", e);
|
log.error("prometheus", e);
|
||||||
|
@ -144,7 +72,7 @@ class Prometheus {
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (tlsInfo.certInfo != null) {
|
if (tlsInfo.certInfo != null) {
|
||||||
Prometheus.monitorCertDaysRemaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining);
|
monitorCertDaysRemaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining);
|
||||||
}
|
}
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
log.error("prometheus", "Caught error");
|
log.error("prometheus", "Caught error");
|
||||||
|
@ -154,7 +82,7 @@ class Prometheus {
|
||||||
|
|
||||||
if (heartbeat) {
|
if (heartbeat) {
|
||||||
try {
|
try {
|
||||||
Prometheus.monitorStatus.set(this.monitorLabelValues, heartbeat.status);
|
monitorStatus.set(this.monitorLabelValues, heartbeat.status);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
log.error("prometheus", "Caught error");
|
log.error("prometheus", "Caught error");
|
||||||
log.error("prometheus", e);
|
log.error("prometheus", e);
|
||||||
|
@ -162,10 +90,10 @@ class Prometheus {
|
||||||
|
|
||||||
try {
|
try {
|
||||||
if (typeof heartbeat.ping === "number") {
|
if (typeof heartbeat.ping === "number") {
|
||||||
Prometheus.monitorResponseTime.set(this.monitorLabelValues, heartbeat.ping);
|
monitorResponseTime.set(this.monitorLabelValues, heartbeat.ping);
|
||||||
} else {
|
} else {
|
||||||
// Is it good?
|
// Is it good?
|
||||||
Prometheus.monitorResponseTime.set(this.monitorLabelValues, -1);
|
monitorResponseTime.set(this.monitorLabelValues, -1);
|
||||||
}
|
}
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
log.error("prometheus", "Caught error");
|
log.error("prometheus", "Caught error");
|
||||||
|
@ -180,10 +108,10 @@ class Prometheus {
|
||||||
*/
|
*/
|
||||||
remove() {
|
remove() {
|
||||||
try {
|
try {
|
||||||
Prometheus.monitorCertDaysRemaining?.remove(this.monitorLabelValues);
|
monitorCertDaysRemaining.remove(this.monitorLabelValues);
|
||||||
Prometheus.monitorCertIsValid?.remove(this.monitorLabelValues);
|
monitorCertIsValid.remove(this.monitorLabelValues);
|
||||||
Prometheus.monitorResponseTime?.remove(this.monitorLabelValues);
|
monitorResponseTime.remove(this.monitorLabelValues);
|
||||||
Prometheus.monitorStatus?.remove(this.monitorLabelValues);
|
monitorStatus.remove(this.monitorLabelValues);
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
console.error(e);
|
console.error(e);
|
||||||
}
|
}
|
||||||
|
|
|
@ -9,6 +9,12 @@
|
||||||
<label for="slack-channel" class="form-label">{{ $t("Channel Name") }}</label>
|
<label for="slack-channel" class="form-label">{{ $t("Channel Name") }}</label>
|
||||||
<input id="slack-channel-name" v-model="$parent.notification.slackchannel" type="text" class="form-control">
|
<input id="slack-channel-name" v-model="$parent.notification.slackchannel" type="text" class="form-control">
|
||||||
|
|
||||||
|
<label class="form-label">{{ $t("Message format") }}</label>
|
||||||
|
<div class="form-check form-switch">
|
||||||
|
<input id="slack-text-message" v-model="$parent.notification.slackrichmessage" type="checkbox" class="form-check-input">
|
||||||
|
<label for="slack-text-message" class="form-label">{{ $t("Send rich messages") }}</label>
|
||||||
|
</div>
|
||||||
|
|
||||||
<div class="form-text">
|
<div class="form-text">
|
||||||
<span style="color: red;"><sup>*</sup></span>{{ $t("Required") }}
|
<span style="color: red;"><sup>*</sup></span>{{ $t("Required") }}
|
||||||
<i18n-t tag="p" keypath="aboutWebhooks" style="margin-top: 8px;">
|
<i18n-t tag="p" keypath="aboutWebhooks" style="margin-top: 8px;">
|
||||||
|
|
|
@ -895,6 +895,8 @@
|
||||||
"cacheBusterParamDescription": "Randomly generated parameter to skip caches.",
|
"cacheBusterParamDescription": "Randomly generated parameter to skip caches.",
|
||||||
"gamedigGuessPort": "Gamedig: Guess Port",
|
"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.",
|
"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",
|
"Bitrix24 Webhook URL": "Bitrix24 Webhook URL",
|
||||||
"wayToGetBitrix24Webhook": "You can create a webhook by following the steps at {0}",
|
"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.",
|
"bitrix24SupportUserID": "Enter your user ID in Bitrix24. You can find out the ID from the link by going to the user's profile.",
|
||||||
|
|
Loading…
Reference in a new issue