uptime-kuma/server/model/monitor.js

610 lines
22 KiB
JavaScript
Raw Normal View History

2021-07-30 07:18:26 -04:00
const https = require("https");
2021-06-25 09:55:49 -04:00
const dayjs = require("dayjs");
2021-09-17 02:42:19 -04:00
const utc = require("dayjs/plugin/utc");
let timezone = require("dayjs/plugin/timezone");
dayjs.extend(utc);
dayjs.extend(timezone);
2021-06-27 04:10:55 -04:00
const axios = require("axios");
2021-07-30 07:18:26 -04:00
const { Prometheus } = require("../prometheus");
const { debug, UP, DOWN, PENDING, flipStatus, TimeLogger } = require("../../src/util");
const { tcping, ping, dnsResolve, checkCertificate, checkStatusCode, getTotalClientInRoom, setting } = require("../util-server");
2021-07-30 07:18:26 -04:00
const { R } = require("redbean-node");
const { BeanModel } = require("redbean-node/dist/bean-model");
2021-09-17 02:42:19 -04:00
const { Notification } = require("../notification");
2021-10-15 12:57:26 -04:00
const { demoMode } = require("../config");
2021-08-12 12:13:46 -04:00
const version = require("../../package.json").version;
const apicache = require("../modules/apicache");
2021-06-27 04:10:55 -04:00
/**
* status:
* 0 = DOWN
* 1 = UP
2021-07-27 13:53:59 -04:00
* 2 = PENDING
2021-06-27 04:10:55 -04:00
*/
2021-06-25 09:55:49 -04:00
class Monitor extends BeanModel {
2021-09-12 14:26:45 -04:00
/**
* Return a object that ready to parse to JSON for public
* Only show necessary data to public
*/
async toPublicJSON() {
return {
id: this.id,
name: this.name,
};
2021-09-12 14:26:45 -04:00
}
/**
* Return a object that ready to parse to JSON
*/
async toJSON() {
let notificationIDList = {};
let list = await R.find("monitor_notification", " monitor_id = ? ", [
2021-07-30 07:18:26 -04:00
this.id,
2021-09-17 02:42:19 -04:00
]);
for (let bean of list) {
notificationIDList[bean.notification_id] = true;
}
const tags = await R.getAll("SELECT mt.*, tag.name, tag.color FROM monitor_tag mt JOIN tag ON mt.tag_id = tag.id WHERE mt.monitor_id = ?", [this.id]);
2021-06-25 09:55:49 -04:00
return {
id: this.id,
name: this.name,
url: this.url,
method: this.method,
body: this.body,
headers: this.headers,
2021-07-01 02:03:06 -04:00
hostname: this.hostname,
port: this.port,
maxretries: this.maxretries,
2021-07-01 01:11:16 -04:00
weight: this.weight,
2021-06-25 09:55:49 -04:00
active: this.active,
type: this.type,
interval: this.interval,
retryInterval: this.retryInterval,
2021-07-01 05:19:28 -04:00
keyword: this.keyword,
ignoreTls: this.getIgnoreTls(),
upsideDown: this.isUpsideDown(),
maxredirects: this.maxredirects,
accepted_statuscodes: this.getAcceptedStatuscodes(),
2021-08-22 18:05:48 -04:00
dns_resolve_type: this.dns_resolve_type,
dns_resolve_server: this.dns_resolve_server,
2021-08-28 15:20:25 -04:00
dns_last_result: this.dns_last_result,
2021-09-30 12:09:43 -04:00
pushToken: this.pushToken,
2021-07-30 07:18:26 -04:00
notificationIDList,
tags: tags,
2021-06-25 09:55:49 -04:00
};
}
/**
* Parse to boolean
* @returns {boolean}
*/
getIgnoreTls() {
2021-09-17 02:42:19 -04:00
return Boolean(this.ignoreTls);
}
/**
* Parse to boolean
* @returns {boolean}
*/
isUpsideDown() {
return Boolean(this.upsideDown);
}
getAcceptedStatuscodes() {
return JSON.parse(this.accepted_statuscodes_json);
}
2021-06-25 09:55:49 -04:00
start(io) {
2021-06-29 04:06:20 -04:00
let previousBeat = null;
let retries = 0;
2021-06-29 04:06:20 -04:00
2021-07-27 12:52:31 -04:00
let prometheus = new Prometheus(this);
2021-06-27 04:10:55 -04:00
const beat = async () => {
2021-08-10 05:51:30 -04:00
// Expose here for prometheus update
// undefined if not https
let tlsInfo = undefined;
2021-06-29 04:06:20 -04:00
if (! previousBeat) {
previousBeat = await R.findOne("heartbeat", " monitor_id = ? ORDER BY time DESC", [
2021-07-30 07:18:26 -04:00
this.id,
2021-09-17 02:42:19 -04:00
]);
2021-06-29 04:06:20 -04:00
}
const isFirstBeat = !previousBeat;
2021-09-17 02:42:19 -04:00
let bean = R.dispense("heartbeat");
2021-06-27 04:10:55 -04:00
bean.monitor_id = this.id;
bean.time = R.isoDateTime(dayjs.utc());
bean.status = DOWN;
2021-06-27 04:10:55 -04:00
if (this.isUpsideDown()) {
bean.status = flipStatus(bean.status);
}
// Duration
if (! isFirstBeat) {
2021-07-30 07:18:26 -04:00
bean.duration = dayjs(bean.time).diff(dayjs(previousBeat.time), "second");
} else {
bean.duration = 0;
}
2021-06-27 04:10:55 -04:00
try {
2021-07-01 05:19:28 -04:00
if (this.type === "http" || this.type === "keyword") {
// Do not do any queries/high loading things before the "bean.ping"
2021-06-27 04:10:55 -04:00
let startTime = dayjs().valueOf();
const options = {
url: this.url,
method: (this.method || "get").toLowerCase(),
...(this.body ? { data: JSON.parse(this.body) } : {}),
2021-08-11 11:12:38 -04:00
timeout: this.interval * 1000 * 0.8,
2021-07-30 07:18:26 -04:00
headers: {
"Accept": "*/*",
2021-08-11 13:31:07 -04:00
"User-Agent": "Uptime-Kuma/" + version,
2021-10-09 15:51:24 -04:00
...(this.headers ? JSON.parse(this.headers) : {}),
2021-07-30 07:18:26 -04:00
},
httpsAgent: new https.Agent({
maxCachedSessions: 0, // Use Custom agent to disable session reuse (https://github.com/nodejs/node/issues/3940)
rejectUnauthorized: ! this.getIgnoreTls(),
}),
maxRedirects: this.maxredirects,
validateStatus: (status) => {
return checkStatusCode(status, this.getAcceptedStatuscodes());
},
};
let res = await axios.request(options);
2021-09-17 02:42:19 -04:00
bean.msg = `${res.status} - ${res.statusText}`;
2021-06-27 04:10:55 -04:00
bean.ping = dayjs().valueOf() - startTime;
2021-07-01 05:19:28 -04:00
// Check certificate if https is used
let certInfoStartTime = dayjs().valueOf();
2021-07-22 04:13:58 -04:00
if (this.getUrl()?.protocol === "https:") {
try {
2021-08-10 05:51:30 -04:00
tlsInfo = await this.updateTlsInfo(checkCertificate(res));
} catch (e) {
if (e.message !== "No TLS certificate in response") {
2021-09-17 02:42:19 -04:00
console.error(e.message);
}
}
}
2021-07-01 05:19:28 -04:00
if (process.env.TIMELOGGER === "1") {
debug("Cert Info Query Time: " + (dayjs().valueOf() - certInfoStartTime) + "ms");
}
2021-10-15 06:36:40 -04:00
if (process.env.UPTIME_KUMA_LOG_RESPONSE_BODY_MONITOR_ID == this.id) {
console.log(res.data);
}
2021-07-01 05:19:28 -04:00
if (this.type === "http") {
bean.status = UP;
2021-07-01 05:19:28 -04:00
} else {
2021-07-11 22:52:41 -04:00
let data = res.data;
// Convert to string for object/array
if (typeof data !== "string") {
2021-09-17 02:42:19 -04:00
data = JSON.stringify(data);
2021-07-11 22:52:41 -04:00
}
if (data.includes(this.keyword)) {
2021-09-17 02:42:19 -04:00
bean.msg += ", keyword is found";
bean.status = UP;
2021-07-01 05:19:28 -04:00
} else {
2021-09-17 02:42:19 -04:00
throw new Error(bean.msg + ", but keyword is not found");
2021-07-01 05:19:28 -04:00
}
}
2021-07-01 02:03:06 -04:00
} else if (this.type === "port") {
bean.ping = await tcping(this.hostname, this.port);
2021-09-17 02:42:19 -04:00
bean.msg = "";
bean.status = UP;
2021-07-01 05:00:23 -04:00
} else if (this.type === "ping") {
bean.ping = await ping(this.hostname);
2021-09-17 02:42:19 -04:00
bean.msg = "";
bean.status = UP;
2021-08-22 18:05:48 -04:00
} else if (this.type === "dns") {
let startTime = dayjs().valueOf();
let dnsMessage = "";
2021-08-22 18:05:48 -04:00
let dnsRes = await dnsResolve(this.hostname, this.dns_resolve_server, this.dns_resolve_type);
bean.ping = dayjs().valueOf() - startTime;
2021-08-22 18:05:48 -04:00
2021-08-25 03:31:42 -04:00
if (this.dns_resolve_type == "A" || this.dns_resolve_type == "AAAA" || this.dns_resolve_type == "TXT") {
dnsMessage += "Records: ";
2021-08-25 03:31:42 -04:00
dnsMessage += dnsRes.join(" | ");
} else if (this.dns_resolve_type == "CNAME" || this.dns_resolve_type == "PTR") {
dnsMessage = dnsRes[0];
2021-08-23 10:30:11 -04:00
} else if (this.dns_resolve_type == "CAA") {
dnsMessage = dnsRes[0].issue;
2021-08-23 10:30:11 -04:00
} else if (this.dns_resolve_type == "MX") {
2021-08-22 18:05:48 -04:00
dnsRes.forEach(record => {
dnsMessage += `Hostname: ${record.exchange} - Priority: ${record.priority} | `;
2021-08-22 18:05:48 -04:00
});
2021-09-17 02:42:19 -04:00
dnsMessage = dnsMessage.slice(0, -2);
2021-08-23 10:30:11 -04:00
} else if (this.dns_resolve_type == "NS") {
dnsMessage += "Servers: ";
2021-08-25 03:31:42 -04:00
dnsMessage += dnsRes.join(" | ");
2021-08-23 10:30:11 -04:00
} else if (this.dns_resolve_type == "SOA") {
2021-08-22 18:05:48 -04:00
dnsMessage += `NS-Name: ${dnsRes.nsname} | Hostmaster: ${dnsRes.hostmaster} | Serial: ${dnsRes.serial} | Refresh: ${dnsRes.refresh} | Retry: ${dnsRes.retry} | Expire: ${dnsRes.expire} | MinTTL: ${dnsRes.minttl}`;
2021-08-23 10:30:11 -04:00
} else if (this.dns_resolve_type == "SRV") {
2021-08-22 18:05:48 -04:00
dnsRes.forEach(record => {
dnsMessage += `Name: ${record.name} | Port: ${record.port} | Priority: ${record.priority} | Weight: ${record.weight} | `;
});
2021-09-17 02:42:19 -04:00
dnsMessage = dnsMessage.slice(0, -2);
2021-08-22 18:05:48 -04:00
}
2021-08-28 15:29:24 -04:00
if (this.dnsLastResult !== dnsMessage) {
2021-08-28 15:20:25 -04:00
R.exec("UPDATE `monitor` SET dns_last_result = ? WHERE id = ? ", [
dnsMessage,
this.id
]);
}
2021-08-22 18:05:48 -04:00
bean.msg = dnsMessage;
bean.status = UP;
2021-09-30 12:09:43 -04:00
} else if (this.type === "push") { // Type: Push
const time = R.isoDateTime(dayjs.utc().subtract(this.interval, "second"));
let heartbeatCount = await R.count("heartbeat", " monitor_id = ? AND time > ? ", [
this.id,
time
]);
debug("heartbeatCount" + heartbeatCount + " " + time);
if (heartbeatCount <= 0) {
throw new Error("No heartbeat in the time window");
} else {
// No need to insert successful heartbeat for push type, so end here
retries = 0;
this.heartbeatInterval = setTimeout(beat, this.interval * 1000);
return;
}
2021-09-27 05:17:57 -04:00
} else if (this.type === "steam") {
const steamApiUrl = "https://api.steampowered.com/IGameServersService/GetServerList/v1/";
const steamAPIKey = await setting("steamAPIKey");
2021-09-27 05:17:57 -04:00
const filter = `addr\\${this.hostname}:${this.port}`;
if (!steamAPIKey) {
throw new Error("Steam API Key not found");
}
2021-09-27 05:17:57 -04:00
let res = await axios.get(steamApiUrl, {
timeout: this.interval * 1000 * 0.8,
headers: {
"Accept": "*/*",
"User-Agent": "Uptime-Kuma/" + version,
},
httpsAgent: new https.Agent({
maxCachedSessions: 0, // Use Custom agent to disable session reuse (https://github.com/nodejs/node/issues/3940)
rejectUnauthorized: ! this.getIgnoreTls(),
}),
maxRedirects: this.maxredirects,
validateStatus: (status) => {
return checkStatusCode(status, this.getAcceptedStatuscodes());
},
params: {
filter: filter,
key: steamAPIKey,
2021-09-27 05:17:57 -04:00
}
});
if (res.data.response && res.data.response.servers && res.data.response.servers.length > 0) {
bean.status = UP;
bean.msg = res.data.response.servers[0].name;
2021-09-27 05:17:57 -04:00
try {
bean.ping = await ping(this.hostname);
} catch (_) { }
2021-09-27 05:17:57 -04:00
} else {
throw new Error("Server not found on Steam");
2021-09-27 05:17:57 -04:00
}
2021-09-30 12:09:43 -04:00
} else {
bean.msg = "Unknown Monitor Type";
bean.status = PENDING;
2021-06-27 04:10:55 -04:00
}
if (this.isUpsideDown()) {
bean.status = flipStatus(bean.status);
if (bean.status === DOWN) {
throw new Error("Flip UP to DOWN");
}
}
retries = 0;
2021-06-27 04:10:55 -04:00
} catch (error) {
bean.msg = error.message;
// If UP come in here, it must be upside down mode
// Just reset the retries
if (this.isUpsideDown() && bean.status === UP) {
retries = 0;
} else if ((this.maxretries > 0) && (retries < this.maxretries)) {
retries++;
bean.status = PENDING;
}
2021-06-27 04:10:55 -04:00
}
2021-09-30 12:09:43 -04:00
let beatInterval = this.interval;
let isImportant = Monitor.isImportantBeat(isFirstBeat, previousBeat?.status, bean.status);
// Mark as important if status changed, ignore pending pings,
// Don't notify if disrupted changes to up
if (isImportant) {
2021-06-29 04:06:20 -04:00
bean.important = true;
await Monitor.sendNotification(isFirstBeat, this, bean);
2021-06-29 04:06:20 -04:00
} else {
bean.important = false;
}
if (bean.status === UP) {
2021-09-17 02:42:19 -04:00
console.info(`Monitor #${this.id} '${this.name}': Successful Response: ${bean.ping} ms | Interval: ${beatInterval} seconds | Type: ${this.type}`);
} else if (bean.status === PENDING) {
2021-09-29 05:20:35 -04:00
if (this.retryInterval > 0) {
beatInterval = this.retryInterval;
}
2021-09-17 02:42:19 -04:00
console.warn(`Monitor #${this.id} '${this.name}': Pending: ${bean.msg} | Max retries: ${this.maxretries} | Retry: ${retries} | Retry Interval: ${beatInterval} seconds | Type: ${this.type}`);
2021-07-20 18:41:38 -04:00
} else {
2021-09-17 02:42:19 -04:00
console.warn(`Monitor #${this.id} '${this.name}': Failing: ${bean.msg} | Interval: ${beatInterval} seconds | Type: ${this.type}`);
2021-07-20 18:41:38 -04:00
}
2021-06-29 04:06:20 -04:00
io.to(this.user_id).emit("heartbeat", bean.toJSON());
2021-09-17 02:42:19 -04:00
Monitor.sendStats(io, this.id, this.user_id);
2021-06-29 04:06:20 -04:00
await R.store(bean);
prometheus.update(bean, tlsInfo);
2021-06-29 04:06:20 -04:00
previousBeat = bean;
2021-09-08 08:00:16 -04:00
if (! this.isStop) {
2021-10-09 14:23:27 -04:00
if (demoMode) {
if (beatInterval < 20) {
2021-10-09 14:36:20 -04:00
console.log("beat interval too low, reset to 20s");
2021-10-09 14:23:27 -04:00
beatInterval = 20;
}
}
this.heartbeatInterval = setTimeout(beat, beatInterval * 1000);
2021-09-08 08:00:16 -04:00
}
2021-09-17 02:42:19 -04:00
};
2021-06-25 09:55:49 -04:00
2021-09-30 12:09:43 -04:00
// Delay Push Type
if (this.type === "push") {
setTimeout(() => {
beat();
}, this.interval * 1000);
} else {
beat();
}
2021-06-25 09:55:49 -04:00
}
stop() {
clearTimeout(this.heartbeatInterval);
2021-09-08 08:00:16 -04:00
this.isStop = true;
2021-06-25 09:55:49 -04:00
}
2021-06-30 09:04:58 -04:00
/**
* Helper Method:
* returns URL object for further usage
* returns null if url is invalid
* @returns {null|URL}
*/
getUrl() {
try {
return new URL(this.url);
} catch (_) {
return null;
}
}
/**
* Store TLS info to database
* @param checkCertificateResult
2021-08-10 05:51:30 -04:00
* @returns {Promise<object>}
*/
async updateTlsInfo(checkCertificateResult) {
let tls_info_bean = await R.findOne("monitor_tls_info", "monitor_id = ?", [
2021-07-30 07:18:26 -04:00
this.id,
]);
if (tls_info_bean == null) {
tls_info_bean = R.dispense("monitor_tls_info");
tls_info_bean.monitor_id = this.id;
}
tls_info_bean.info_json = JSON.stringify(checkCertificateResult);
await R.store(tls_info_bean);
2021-08-10 05:51:30 -04:00
return checkCertificateResult;
}
2021-06-30 09:04:58 -04:00
static async sendStats(io, monitorID, userID) {
const hasClients = getTotalClientInRoom(io, userID) > 0;
if (hasClients) {
await Monitor.sendAvgPing(24, io, monitorID, userID);
await Monitor.sendUptime(24, io, monitorID, userID);
await Monitor.sendUptime(24 * 30, io, monitorID, userID);
await Monitor.sendCertInfo(io, monitorID, userID);
} else {
debug("No clients in the room, no need to send stats");
}
2021-06-30 09:04:58 -04:00
}
2021-07-01 01:11:16 -04:00
/**
*
* @param duration : int Hours
*/
2021-06-30 09:04:58 -04:00
static async sendAvgPing(duration, io, monitorID, userID) {
2021-08-16 14:09:40 -04:00
const timeLogger = new TimeLogger();
2021-06-30 09:04:58 -04:00
let avgPing = parseInt(await R.getCell(`
SELECT AVG(ping)
FROM heartbeat
2021-07-10 00:04:40 -04:00
WHERE time > DATETIME('now', ? || ' hours')
2021-07-01 01:11:16 -04:00
AND ping IS NOT NULL
2021-06-30 09:04:58 -04:00
AND monitor_id = ? `, [
-duration,
2021-07-30 07:18:26 -04:00
monitorID,
2021-06-30 09:04:58 -04:00
]));
2021-08-16 14:09:40 -04:00
timeLogger.print(`[Monitor: ${monitorID}] avgPing`);
2021-06-30 09:04:58 -04:00
io.to(userID).emit("avgPing", monitorID, avgPing);
}
static async sendCertInfo(io, monitorID, userID) {
2021-07-30 07:18:26 -04:00
let tls_info = await R.findOne("monitor_tls_info", "monitor_id = ?", [
monitorID,
]);
if (tls_info != null) {
io.to(userID).emit("certInfo", monitorID, tls_info.info_json);
}
}
2021-07-01 01:11:16 -04:00
/**
2021-07-09 02:14:03 -04:00
* Uptime with calculation
* Calculation based on:
* https://www.uptrends.com/support/kb/reporting/calculation-of-uptime-and-downtime
2021-07-01 01:11:16 -04:00
* @param duration : int Hours
*/
2021-09-22 03:10:08 -04:00
static async calcUptime(duration, monitorID) {
2021-08-16 14:09:40 -04:00
const timeLogger = new TimeLogger();
2021-09-09 03:46:28 -04:00
const startTime = R.isoDateTime(dayjs.utc().subtract(duration, "hour"));
// Handle if heartbeat duration longer than the target duration
// e.g. If the last beat's duration is bigger that the 24hrs window, it will use the duration between the (beat time - window margin) (THEN case in SQL)
let result = await R.getRow(`
SELECT
-- SUM all duration, also trim off the beat out of time window
SUM(
CASE
WHEN (JULIANDAY(\`time\`) - JULIANDAY(?)) * 86400 < duration
THEN (JULIANDAY(\`time\`) - JULIANDAY(?)) * 86400
ELSE duration
END
) AS total_duration,
-- SUM all uptime duration, also trim off the beat out of time window
SUM(
CASE
WHEN (status = 1)
THEN
CASE
WHEN (JULIANDAY(\`time\`) - JULIANDAY(?)) * 86400 < duration
THEN (JULIANDAY(\`time\`) - JULIANDAY(?)) * 86400
ELSE duration
END
END
) AS uptime_duration
2021-07-01 01:11:16 -04:00
FROM heartbeat
2021-09-09 03:46:28 -04:00
WHERE time > ?
AND monitor_id = ?
`, [
startTime, startTime, startTime, startTime, startTime,
2021-07-30 07:18:26 -04:00
monitorID,
2021-07-01 05:00:23 -04:00
]);
2021-08-16 14:09:40 -04:00
timeLogger.print(`[Monitor: ${monitorID}][${duration}] sendUptime`);
2021-09-09 03:46:28 -04:00
let totalDuration = result.total_duration;
let uptimeDuration = result.uptime_duration;
let uptime = 0;
2021-07-01 01:11:16 -04:00
if (totalDuration > 0) {
uptime = uptimeDuration / totalDuration;
if (uptime < 0) {
uptime = 0;
}
2021-07-11 08:07:03 -04:00
} else {
// Handle new monitor with only one beat, because the beat's duration = 0
let status = parseInt(await R.getCell("SELECT `status` FROM heartbeat WHERE monitor_id = ?", [ monitorID ]));
2021-09-17 02:42:19 -04:00
if (status === UP) {
uptime = 1;
}
2021-07-01 05:00:23 -04:00
}
2021-09-22 03:10:08 -04:00
return uptime;
}
/**
* Send Uptime
* @param duration : int Hours
*/
static async sendUptime(duration, io, monitorID, userID) {
const uptime = await this.calcUptime(duration, monitorID);
2021-07-01 01:11:16 -04:00
io.to(userID).emit("uptime", monitorID, duration, uptime);
2021-06-30 09:04:58 -04:00
}
static isImportantBeat(isFirstBeat, previousBeatStatus, currentBeatStatus) {
// * ? -> ANY STATUS = important [isFirstBeat]
// UP -> PENDING = not important
// * UP -> DOWN = important
// UP -> UP = not important
// PENDING -> PENDING = not important
// * PENDING -> DOWN = important
// PENDING -> UP = not important
// DOWN -> PENDING = this case not exists
// DOWN -> DOWN = not important
// * DOWN -> UP = important
let isImportant = isFirstBeat ||
(previousBeatStatus === UP && currentBeatStatus === DOWN) ||
(previousBeatStatus === DOWN && currentBeatStatus === UP) ||
(previousBeatStatus === PENDING && currentBeatStatus === DOWN);
return isImportant;
}
static async sendNotification(isFirstBeat, monitor, bean) {
if (!isFirstBeat || bean.status === DOWN) {
let notificationList = await R.getAll("SELECT notification.* FROM notification, monitor_notification WHERE monitor_id = ? AND monitor_notification.notification_id = notification.id ", [
monitor.id,
]);
let text;
if (bean.status === UP) {
text = "✅ Up";
} else {
text = "🔴 Down";
}
let msg = `[${monitor.name}] [${text}] ${bean.msg}`;
for (let notification of notificationList) {
try {
await Notification.send(JSON.parse(notification.config), msg, await monitor.toJSON(), bean.toJSON());
} catch (e) {
console.error("Cannot send notification to " + notification.name);
console.log(e);
}
}
// Clear Status Page Cache
apicache.clear();
}
}
2021-06-25 09:55:49 -04:00
}
module.exports = Monitor;