uptime-kuma/server/prometheus.js

124 lines
3.5 KiB
JavaScript
Raw Permalink Normal View History

2021-08-10 09:51:30 +00:00
const PrometheusClient = require("prom-client");
const { log } = require("../src/util");
2021-07-27 16:52:31 +00:00
const commonLabels = [
2021-08-10 09:51:30 +00:00
"monitor_name",
"monitor_type",
"monitor_url",
"monitor_hostname",
"monitor_port",
2021-10-10 08:37:53 +00:00
];
2021-07-27 16:52:31 +00:00
const monitorCertDaysRemaining = new PrometheusClient.Gauge({
2021-08-10 09:51:30 +00:00
name: "monitor_cert_days_remaining",
help: "The number of days remaining until the certificate expires",
labelNames: commonLabels
});
const monitorCertIsValid = new PrometheusClient.Gauge({
2021-08-10 09:51:30 +00:00
name: "monitor_cert_is_valid",
help: "Is the certificate still valid? (1 = Yes, 0= No)",
labelNames: commonLabels
});
const monitorResponseTime = new PrometheusClient.Gauge({
2021-08-10 09:51:30 +00:00
name: "monitor_response_time",
help: "Monitor Response Time (ms)",
2021-07-27 16:52:31 +00:00
labelNames: commonLabels
});
const monitorStatus = new PrometheusClient.Gauge({
2021-08-10 09:51:30 +00:00
name: "monitor_status",
help: "Monitor Status (1 = UP, 0= DOWN, 2= PENDING, 3= MAINTENANCE)",
2021-07-27 16:52:31 +00:00
labelNames: commonLabels
});
class Prometheus {
2022-04-25 23:26:57 +00:00
monitorLabelValues = {};
2021-07-27 16:52:31 +00:00
/**
* @param {object} monitor Monitor object to monitor
*/
2021-07-27 16:52:31 +00:00
constructor(monitor) {
this.monitorLabelValues = {
monitor_name: monitor.name,
monitor_type: monitor.type,
monitor_url: monitor.url,
monitor_hostname: monitor.hostname,
monitor_port: monitor.port
2021-10-10 08:37:53 +00:00
};
2021-07-27 16:52:31 +00:00
}
/**
* Update the metrics page
* @param {object} heartbeat Heartbeat details
* @param {object} tlsInfo TLS details
* @returns {void}
*/
2021-08-10 09:51:30 +00:00
update(heartbeat, tlsInfo) {
2021-10-10 08:37:53 +00:00
2021-08-10 12:00:59 +00:00
if (typeof tlsInfo !== "undefined") {
try {
2022-04-17 07:43:03 +00:00
let isValid;
if (tlsInfo.valid === true) {
2022-04-13 16:30:32 +00:00
isValid = 1;
} else {
2022-04-13 16:30:32 +00:00
isValid = 0;
}
monitorCertIsValid.set(this.monitorLabelValues, isValid);
} catch (e) {
log.error("prometheus", "Caught error");
log.error("prometheus", e);
}
try {
if (tlsInfo.certInfo != null) {
monitorCertDaysRemaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining);
}
} catch (e) {
log.error("prometheus", "Caught error");
log.error("prometheus", e);
}
}
2021-08-10 09:51:30 +00:00
if (heartbeat) {
try {
monitorStatus.set(this.monitorLabelValues, heartbeat.status);
} catch (e) {
log.error("prometheus", "Caught error");
log.error("prometheus", e);
}
2021-07-27 16:52:31 +00:00
try {
if (typeof heartbeat.ping === "number") {
monitorResponseTime.set(this.monitorLabelValues, heartbeat.ping);
} else {
// Is it good?
monitorResponseTime.set(this.monitorLabelValues, -1);
}
} catch (e) {
log.error("prometheus", "Caught error");
log.error("prometheus", e);
2021-07-27 16:52:31 +00:00
}
}
}
/**
* Remove monitor from prometheus
* @returns {void}
*/
remove() {
try {
monitorCertDaysRemaining.remove(this.monitorLabelValues);
monitorCertIsValid.remove(this.monitorLabelValues);
monitorResponseTime.remove(this.monitorLabelValues);
monitorStatus.remove(this.monitorLabelValues);
} catch (e) {
console.error(e);
}
}
2021-07-27 16:52:31 +00:00
}
module.exports = {
Prometheus
2021-10-10 08:37:53 +00:00
};