uptime-kuma/server/model/monitor.js

1195 lines
47 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-06-27 04:10:55 -04:00
const axios = require("axios");
2021-07-30 07:18:26 -04:00
const { Prometheus } = require("../prometheus");
const { log, UP, DOWN, PENDING, MAINTENANCE, flipStatus, TimeLogger } = require("../../src/util");
const { tcping, ping, dnsResolve, checkCertificate, checkStatusCode, getTotalClientInRoom, setting, mssqlQuery, postgresQuery, mysqlQuery, mqttAsync, setSetting, httpNtlm, radius, grpcQuery } = 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");
const { Proxy } = require("../proxy");
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");
const { UptimeKumaServer } = require("../uptime-kuma-server");
const { CacheableDnsHttpAgent } = require("../cacheable-dns-http-agent");
const { DockerHost } = require("../docker");
const Maintenance = require("./maintenance");
2021-06-27 04:10:55 -04:00
/**
* status:
* 0 = DOWN
* 1 = UP
2021-07-27 13:53:59 -04:00
* 2 = PENDING
* 3 = MAINTENANCE
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
/**
2022-03-18 05:56:46 -04:00
* Return an object that ready to parse to JSON for public
2021-09-12 14:26:45 -04:00
* Only show necessary data to public
* @returns {Object}
2021-09-12 14:26:45 -04:00
*/
2022-03-18 05:56:46 -04:00
async toPublicJSON(showTags = false) {
let obj = {
id: this.id,
name: this.name,
sendUrl: this.sendUrl,
maintenance: await Monitor.isUnderMaintenance(this.id),
};
if (this.sendUrl) {
obj.url = this.url;
}
2022-03-18 05:56:46 -04:00
if (showTags) {
obj.tags = await this.getTags();
}
return obj;
2021-09-12 14:26:45 -04:00
}
/**
2022-03-18 05:56:46 -04:00
* Return an object that ready to parse to JSON
* @returns {Object}
2021-09-12 14:26:45 -04:00
*/
2022-04-17 07:30:58 -04:00
async toJSON(includeSensitiveData = true) {
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;
}
2022-03-18 05:56:46 -04:00
const tags = await this.getTags();
2022-04-17 07:30:58 -04:00
let data = {
2021-06-25 09:55:49 -04:00
id: this.id,
name: this.name,
url: this.url,
method: this.method,
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,
2022-01-23 09:22:57 -05:00
resendInterval: this.resendInterval,
2021-07-01 05:19:28 -04:00
keyword: this.keyword,
expiryNotification: this.isEnabledExpiryNotification(),
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,
2022-01-13 11:17:07 -05:00
docker_container: this.docker_container,
docker_host: this.docker_host,
proxyId: this.proxy_id,
2021-07-30 07:18:26 -04:00
notificationIDList,
tags: tags,
maintenance: await Monitor.isUnderMaintenance(this.id),
2021-12-18 16:35:18 -05:00
mqttTopic: this.mqttTopic,
2022-05-13 13:58:23 -04:00
mqttSuccessMessage: this.mqttSuccessMessage,
databaseQuery: this.databaseQuery,
2022-05-13 13:58:23 -04:00
authMethod: this.authMethod,
grpcUrl: this.grpcUrl,
grpcProtobuf: this.grpcProtobuf,
grpcMethod: this.grpcMethod,
grpcServiceName: this.grpcServiceName,
grpcEnableTls: this.getGrpcEnableTls(),
2022-05-12 05:48:38 -04:00
radiusCalledStationId: this.radiusCalledStationId,
radiusCallingStationId: this.radiusCallingStationId,
2021-06-25 09:55:49 -04:00
};
2022-04-17 07:30:58 -04:00
if (includeSensitiveData) {
data = {
...data,
headers: this.headers,
body: this.body,
grpcBody: this.grpcBody,
grpcMetadata: this.grpcMetadata,
2022-04-17 07:30:58 -04:00
basic_auth_user: this.basic_auth_user,
basic_auth_pass: this.basic_auth_pass,
pushToken: this.pushToken,
databaseConnectionString: this.databaseConnectionString,
radiusUsername: this.radiusUsername,
radiusPassword: this.radiusPassword,
radiusSecret: this.radiusSecret,
mqttUsername: this.mqttUsername,
mqttPassword: this.mqttPassword,
authWorkstation: this.authWorkstation,
authDomain: this.authDomain,
2022-04-17 07:30:58 -04:00
};
}
data.includeSensitiveData = includeSensitiveData;
2022-04-17 07:30:58 -04:00
return data;
2021-06-25 09:55:49 -04:00
}
/**
* Get all tags applied to this monitor
* @returns {Promise<LooseObject<any>[]>}
*/
2022-03-18 05:56:46 -04:00
async getTags() {
2022-04-17 03:27:35 -04:00
return 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 ]);
2022-03-18 05:56:46 -04:00
}
2021-11-02 07:30:44 -04:00
/**
* Encode user and password to Base64 encoding
* for HTTP "basic" auth, as per RFC-7617
* @returns {string}
*/
2021-11-22 23:59:48 -05:00
encodeBase64(user, pass) {
return Buffer.from(user + ":" + pass).toString("base64");
2021-11-02 08:11:33 -04:00
}
2021-11-02 07:30:44 -04:00
/**
* Is the TLS expiry notification enabled?
* @returns {boolean}
*/
isEnabledExpiryNotification() {
return Boolean(this.expiryNotification);
}
/**
* 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);
}
/**
* Parse to boolean
* @returns {boolean}
*/
getGrpcEnableTls() {
return Boolean(this.grpcEnableTls);
}
/**
* Get accepted status codes
* @returns {Object}
*/
getAcceptedStatuscodes() {
return JSON.parse(this.accepted_statuscodes_json);
}
/**
* Start monitor
* @param {Server} io Socket server instance
*/
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 () => {
2022-02-24 02:11:17 -05:00
let beatInterval = this.interval;
if (! beatInterval) {
beatInterval = 1;
}
if (demoMode) {
if (beatInterval < 20) {
console.log("beat interval too low, reset to 20s");
beatInterval = 20;
}
}
2021-08-10 05:51:30 -04:00
// Expose here for prometheus update
// undefined if not https
let tlsInfo = undefined;
2022-05-09 15:10:12 -04:00
if (!previousBeat || this.type === "push") {
2021-06-29 04:06:20 -04:00
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.isoDateTimeMillis(dayjs.utc());
bean.status = DOWN;
bean.downCount = previousBeat?.downCount || 0;
2021-06-27 04:10:55 -04:00
if (this.isUpsideDown()) {
bean.status = flipStatus(bean.status);
}
// Duration
2021-11-03 21:46:43 -04:00
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 {
if (await Monitor.isUnderMaintenance(this.id)) {
bean.msg = "Monitor under maintenance";
bean.status = MAINTENANCE;
2022-04-30 08:57:08 -04:00
} else 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();
2021-11-02 07:30:44 -04:00
// HTTP basic auth
let basicAuthHeader = {};
2022-05-13 13:58:23 -04:00
if (this.auth_method === "basic") {
basicAuthHeader = {
2021-11-22 23:59:48 -05:00
"Authorization": "Basic " + this.encodeBase64(this.basic_auth_user, this.basic_auth_pass),
2021-11-02 08:11:33 -04:00
};
2021-11-02 07:30:44 -04:00
}
const httpsAgentOptions = {
maxCachedSessions: 0, // Use Custom agent to disable session reuse (https://github.com/nodejs/node/issues/3940)
rejectUnauthorized: !this.getIgnoreTls(),
};
log.debug("monitor", `[${this.name}] Prepare Options for axios`);
// Axios Options
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: {
// Fix #2253
// Read more: https://stackoverflow.com/questions/1759956/curl-error-18-transfer-closed-with-outstanding-read-data-remaining
"Accept-Encoding": "gzip, deflate",
"Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9",
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) : {}),
...(basicAuthHeader),
2021-07-30 07:18:26 -04:00
},
decompress: true,
maxRedirects: this.maxredirects,
validateStatus: (status) => {
return checkStatusCode(status, this.getAcceptedStatuscodes());
},
};
2021-11-07 08:00:47 -05:00
if (this.proxy_id) {
const proxy = await R.load("proxy", this.proxy_id);
if (proxy && proxy.active) {
const { httpAgent, httpsAgent } = Proxy.createAgents(proxy, {
httpsAgentOptions: httpsAgentOptions,
});
options.proxy = false;
options.httpAgent = httpAgent;
options.httpsAgent = httpsAgent;
}
}
if (!options.httpsAgent) {
options.httpsAgent = new https.Agent(httpsAgentOptions);
}
log.debug("monitor", `[${this.name}] Axios Options: ${JSON.stringify(options)}`);
log.debug("monitor", `[${this.name}] Axios Request`);
2022-05-13 13:58:23 -04:00
let res;
if (this.auth_method === "ntlm") {
options.httpsAgent.keepAlive = true;
2022-06-14 09:49:36 -04:00
res = await httpNtlm(options, {
2022-05-13 13:58:23 -04:00
username: this.basic_auth_user,
password: this.basic_auth_pass,
domain: this.authDomain,
2022-06-14 09:49:36 -04:00
workstation: this.authWorkstation ? this.authWorkstation : undefined
});
2022-05-13 13:58:23 -04:00
} else {
2022-06-23 03:54:33 -04:00
res = await axios.request(options);
2022-05-13 13:58:23 -04:00
}
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:") {
log.debug("monitor", `[${this.name}] Check cert`);
try {
let tlsInfoObject = checkCertificate(res);
tlsInfo = await this.updateTlsInfo(tlsInfoObject);
if (!this.getIgnoreTls() && this.isEnabledExpiryNotification()) {
log.debug("monitor", `[${this.name}] call sendCertNotification`);
await this.sendCertNotification(tlsInfoObject);
}
} catch (e) {
if (e.message !== "No TLS certificate in response") {
log.error("monitor", "Caught error");
log.error("monitor", e.message);
}
}
}
2021-07-01 05:19:28 -04:00
if (process.env.TIMELOGGER === "1") {
log.debug("monitor", "Cert Info Query Time: " + (dayjs().valueOf() - certInfoStartTime) + "ms");
}
2021-10-15 06:36:40 -04:00
2022-04-17 03:43:03 -04:00
if (process.env.UPTIME_KUMA_LOG_RESPONSE_BODY_MONITOR_ID === this.id) {
log.info("monitor", res.data);
2021-10-15 06:36:40 -04:00
}
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 {
data = data.replace(/<[^>]*>?|[\n\r]|\s+/gm, " ");
if (data.length > 50) {
data = data.substring(0, 47) + "...";
}
throw new Error(bean.msg + ", but keyword is not in [" + data + "]");
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.port, this.dns_resolve_type);
bean.ping = dayjs().valueOf() - startTime;
2021-08-22 18:05:48 -04:00
2022-04-17 03:43:03 -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(" | ");
2022-04-17 03:43:03 -04:00
} else if (this.dns_resolve_type === "CNAME" || this.dns_resolve_type === "PTR") {
dnsMessage = dnsRes[0];
2022-04-17 03:43:03 -04:00
} else if (this.dns_resolve_type === "CAA") {
dnsMessage = dnsRes[0].issue;
2022-04-17 03:43:03 -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);
2022-04-17 03:43:03 -04:00
} else if (this.dns_resolve_type === "NS") {
dnsMessage += "Servers: ";
2021-08-25 03:31:42 -04:00
dnsMessage += dnsRes.join(" | ");
2022-04-17 03:43:03 -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}`;
2022-04-17 03:43:03 -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
2022-05-27 00:45:56 -04:00
log.debug("monitor", `[${this.name}] Checking monitor at ${dayjs().format("YYYY-MM-DD HH:mm:ss.SSS")}`);
const bufferTime = 1000; // 1s buffer to accommodate clock differences
2021-09-30 12:09:43 -04:00
if (previousBeat) {
const msSinceLastBeat = dayjs.utc().valueOf() - dayjs.utc(previousBeat.time).valueOf();
2021-09-30 12:09:43 -04:00
2022-05-28 11:22:44 -04:00
log.debug("monitor", `[${this.name}] msSinceLastBeat = ${msSinceLastBeat}`);
2021-12-08 01:59:59 -05:00
// If the previous beat was down or pending we use the regular
// beatInterval/retryInterval in the setTimeout further below
if (previousBeat.status !== (this.isUpsideDown() ? DOWN : UP) || msSinceLastBeat > beatInterval * 1000 + bufferTime) {
throw new Error("No heartbeat in the time window");
} else {
let timeout = beatInterval * 1000 - msSinceLastBeat;
if (timeout < 0) {
timeout = bufferTime;
} else {
timeout += bufferTime;
}
// No need to insert successful heartbeat for push type, so end here
retries = 0;
2022-05-27 00:45:56 -04:00
log.debug("monitor", `[${this.name}] timeout = ${timeout}`);
this.heartbeatInterval = setTimeout(beat, timeout);
return;
}
2021-09-30 12:09:43 -04:00
} else {
throw new Error("No heartbeat in the time window");
2021-09-30 12:09:43 -04:00
}
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");
}
2022-06-23 03:54:33 -04:00
let res = await axios.get(steamApiUrl, {
2021-09-27 05:17:57 -04:00
timeout: this.interval * 1000 * 0.8,
headers: {
"Accept": "*/*",
"User-Agent": "Uptime-Kuma/" + version,
},
httpsAgent: CacheableDnsHttpAgent.getHttpsAgent({
2021-09-27 05:17:57 -04:00
maxCachedSessions: 0, // Use Custom agent to disable session reuse (https://github.com/nodejs/node/issues/3940)
2021-11-03 21:46:43 -04:00
rejectUnauthorized: !this.getIgnoreTls(),
2021-09-27 05:17:57 -04:00
}),
httpAgent: CacheableDnsHttpAgent.getHttpAgent({
maxCachedSessions: 0,
}),
2021-09-27 05:17:57 -04:00
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
}
2022-01-13 11:17:07 -05:00
} else if (this.type === "docker") {
2022-05-19 08:35:55 -04:00
log.debug(`[${this.name}] Prepare Options for Axios`);
2022-01-13 11:17:07 -05:00
2022-07-22 11:57:40 -04:00
const dockerHost = await R.load("docker_host", this.docker_host);
2022-01-13 11:17:07 -05:00
const options = {
url: `/containers/${this.docker_container}/json`,
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(),
}),
};
2022-07-22 11:57:40 -04:00
if (dockerHost._dockerType === "socket") {
options.socketPath = dockerHost._dockerDaemon;
} else if (dockerHost._dockerType === "tcp") {
options.baseURL = DockerHost.patchDockerURL(dockerHost._dockerDaemon);
}
2022-05-19 08:35:55 -04:00
log.debug(`[${this.name}] Axios Request`);
2022-01-13 11:17:07 -05:00
let res = await axios.request(options);
if (res.data.State.Running) {
bean.status = UP;
bean.msg = "";
2022-01-13 11:17:07 -05:00
}
2021-11-03 21:46:43 -04:00
} else if (this.type === "mqtt") {
bean.msg = await mqttAsync(this.hostname, this.mqttTopic, this.mqttSuccessMessage, {
port: this.port,
username: this.mqttUsername,
password: this.mqttPassword,
interval: this.interval,
});
bean.status = UP;
2022-05-12 13:48:03 -04:00
} else if (this.type === "sqlserver") {
let startTime = dayjs().valueOf();
2022-05-13 09:57:06 -04:00
await mssqlQuery(this.databaseConnectionString, this.databaseQuery);
2022-05-12 13:48:03 -04:00
2022-06-15 13:12:47 -04:00
bean.msg = "";
bean.status = UP;
bean.ping = dayjs().valueOf() - startTime;
} else if (this.type === "grpc-keyword") {
let startTime = dayjs().valueOf();
const options = {
grpcUrl: this.grpcUrl,
grpcProtobufData: this.grpcProtobuf,
grpcServiceName: this.grpcServiceName,
grpcEnableTls: this.grpcEnableTls,
grpcMethod: this.grpcMethod,
grpcBody: this.grpcBody,
keyword: this.keyword
};
const response = await grpcQuery(options);
bean.ping = dayjs().valueOf() - startTime;
log.debug("monitor:", `gRPC response: ${JSON.stringify(response)}`);
let responseData = response.data;
if (responseData.length > 50) {
responseData = response.substring(0, 47) + "...";
}
if (response.code !== 1) {
bean.status = DOWN;
bean.msg = `Error in send gRPC ${response.code} ${response.errorMessage}`;
} else {
if (response.data.toString().includes(this.keyword)) {
bean.status = UP;
bean.msg = `${responseData}, keyword [${this.keyword}] is found`;
} else {
log.debug("monitor:", `GRPC response [${response.data}] + ", but keyword [${this.keyword}] is not in [" + ${response.data} + "]"`);
bean.status = DOWN;
bean.msg = `, but keyword [${this.keyword}] is not in [" + ${responseData} + "]`;
}
}
2022-06-15 13:12:47 -04:00
} else if (this.type === "postgres") {
let startTime = dayjs().valueOf();
await postgresQuery(this.databaseConnectionString, this.databaseQuery);
bean.msg = "";
bean.status = UP;
bean.ping = dayjs().valueOf() - startTime;
} else if (this.type === "mysql") {
let startTime = dayjs().valueOf();
await mysqlQuery(this.databaseConnectionString, this.databaseQuery);
2022-05-12 13:48:03 -04:00
bean.msg = "";
bean.status = UP;
bean.ping = dayjs().valueOf() - startTime;
2022-05-12 05:48:38 -04:00
} else if (this.type === "radius") {
let startTime = dayjs().valueOf();
// Handle monitors that were created before the
// update and as such don't have a value for
// this.port.
let port;
if (this.port == null) {
port = 1812;
} else {
port = this.port;
}
2022-05-12 05:48:38 -04:00
try {
const resp = await radius(
this.hostname,
this.radiusUsername,
this.radiusPassword,
this.radiusCalledStationId,
this.radiusCallingStationId,
this.radiusSecret,
port
2022-05-12 05:48:38 -04:00
);
if (resp.code) {
bean.msg = resp.code;
}
bean.status = UP;
} catch (error) {
bean.status = DOWN;
if (error.response?.code) {
bean.msg = error.response.code;
} else {
bean.msg = error.message;
}
}
bean.ping = dayjs().valueOf() - startTime;
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
}
log.debug("monitor", `[${this.name}] Check isImportant`);
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;
2021-11-07 08:00:47 -05:00
if (Monitor.isImportantForNotification(isFirstBeat, previousBeat?.status, bean.status)) {
log.debug("monitor", `[${this.name}] sendNotification`);
await Monitor.sendNotification(isFirstBeat, this, bean);
2022-04-30 08:57:08 -04:00
} else {
log.debug("monitor", `[${this.name}] will not sendNotification because it is (or was) under maintenance`);
}
// Reset down count
bean.downCount = 0;
2022-01-23 09:22:57 -05:00
// Clear Status Page Cache
log.debug("monitor", `[${this.name}] apicache clear`);
apicache.clear();
2022-10-15 08:15:50 -04:00
UptimeKumaServer.getInstance().sendMaintenanceListByUserID(this.user_id);
2021-06-29 04:06:20 -04:00
} else {
bean.important = false;
2022-01-23 09:22:57 -05:00
if (bean.status === DOWN && this.resendInterval > 0) {
++bean.downCount;
if (bean.downCount >= this.resendInterval) {
2022-01-23 09:22:57 -05:00
// Send notification again, because we are still DOWN
log.debug("monitor", `[${this.name}] sendNotification again: Down Count: ${bean.downCount} | Resend Interval: ${this.resendInterval}`);
2022-01-23 09:22:57 -05:00
await Monitor.sendNotification(isFirstBeat, this, bean);
// Reset down count
bean.downCount = 0;
2022-01-23 09:22:57 -05:00
}
}
2021-06-29 04:06:20 -04:00
}
if (bean.status === UP) {
log.debug("monitor", `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;
}
log.warn("monitor", `Monitor #${this.id} '${this.name}': Pending: ${bean.msg} | Max retries: ${this.maxretries} | Retry: ${retries} | Retry Interval: ${beatInterval} seconds | Type: ${this.type}`);
} else if (bean.status === MAINTENANCE) {
log.warn("monitor", `Monitor #${this.id} '${this.name}': Under Maintenance | Type: ${this.type}`);
2021-07-20 18:41:38 -04:00
} else {
log.warn("monitor", `Monitor #${this.id} '${this.name}': Failing: ${bean.msg} | Interval: ${beatInterval} seconds | Type: ${this.type} | Down Count: ${bean.downCount} | Resend Interval: ${this.resendInterval}`);
2021-07-20 18:41:38 -04:00
}
log.debug("monitor", `[${this.name}] Send to socket`);
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
log.debug("monitor", `[${this.name}] Store`);
await R.store(bean);
2021-11-07 08:00:47 -05:00
log.debug("monitor", `[${this.name}] prometheus.update`);
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) {
log.debug("monitor", `[${this.name}] SetTimeout for next check.`);
this.heartbeatInterval = setTimeout(safeBeat, beatInterval * 1000);
2021-11-07 08:00:47 -05:00
} else {
log.info("monitor", `[${this.name}] isStop = true, no next check.`);
2021-09-08 08:00:16 -04:00
}
2021-09-17 02:42:19 -04:00
};
2021-06-25 09:55:49 -04:00
/** Get a heartbeat and handle errors */
const safeBeat = async () => {
try {
await beat();
} catch (e) {
console.trace(e);
UptimeKumaServer.errorLog(e, false);
log.error("monitor", "Please report to https://github.com/louislam/uptime-kuma/issues");
if (! this.isStop) {
log.info("monitor", "Try to restart the monitor");
this.heartbeatInterval = setTimeout(safeBeat, this.interval * 1000);
}
}
};
2021-09-30 12:09:43 -04:00
// Delay Push Type
if (this.type === "push") {
setTimeout(() => {
safeBeat();
2021-09-30 12:09:43 -04:00
}, this.interval * 1000);
} else {
safeBeat();
2021-09-30 12:09:43 -04:00
}
2021-06-25 09:55:49 -04:00
}
/** Stop monitor */
2021-06-25 09:55:49 -04:00
stop() {
clearTimeout(this.heartbeatInterval);
2021-09-08 08:00:16 -04:00
this.isStop = true;
this.prometheus().remove();
2021-06-25 09:55:49 -04:00
}
2021-06-30 09:04:58 -04:00
/**
* Get a new prometheus instance
* @returns {Prometheus}
*/
prometheus() {
return new Prometheus(this);
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
* @returns {Promise<Object>}
*/
async updateTlsInfo(checkCertificateResult) {
2022-04-13 12:30:32 -04:00
let tlsInfoBean = await R.findOne("monitor_tls_info", "monitor_id = ?", [
2021-07-30 07:18:26 -04:00
this.id,
]);
2022-04-13 12:30:32 -04:00
if (tlsInfoBean == null) {
tlsInfoBean = R.dispense("monitor_tls_info");
tlsInfoBean.monitor_id = this.id;
} else {
// Clear sent history if the cert changed.
try {
2022-04-13 12:30:32 -04:00
let oldCertInfo = JSON.parse(tlsInfoBean.info_json);
let isValidObjects = oldCertInfo && oldCertInfo.certInfo && checkCertificateResult && checkCertificateResult.certInfo;
if (isValidObjects) {
if (oldCertInfo.certInfo.fingerprint256 !== checkCertificateResult.certInfo.fingerprint256) {
log.debug("monitor", "Resetting sent_history");
await R.exec("DELETE FROM notification_sent_history WHERE type = 'certificate' AND monitor_id = ?", [
this.id
]);
} else {
log.debug("monitor", "No need to reset sent_history");
log.debug("monitor", oldCertInfo.certInfo.fingerprint256);
log.debug("monitor", checkCertificateResult.certInfo.fingerprint256);
}
} else {
log.debug("monitor", "Not valid object");
}
} catch (e) { }
}
2022-04-13 12:30:32 -04:00
tlsInfoBean.info_json = JSON.stringify(checkCertificateResult);
await R.store(tlsInfoBean);
2021-08-10 05:51:30 -04:00
return checkCertificateResult;
}
/**
* Send statistics to clients
* @param {Server} io Socket server instance
* @param {number} monitorID ID of monitor to send
* @param {number} userID ID of user to send to
*/
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 {
log.debug("monitor", "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
/**
* Send the average ping to user
* @param {number} duration Hours
2021-07-01 01:11:16 -04:00
*/
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);
}
/**
* Send certificate information to client
* @param {Server} io Socket server instance
* @param {number} monitorID ID of monitor to send
* @param {number} userID ID of user to send to
*/
static async sendCertInfo(io, monitorID, userID) {
let tlsInfo = await R.findOne("monitor_tls_info", "monitor_id = ?", [
2021-07-30 07:18:26 -04:00
monitorID,
]);
if (tlsInfo != null) {
io.to(userID).emit("certInfo", monitorID, tlsInfo.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
* @param {number} duration Hours
* @param {number} monitorID ID of monitor to calculate
2021-07-01 01:11:16 -04:00
*/
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 OR status = 3)
2021-09-09 03:46:28 -04:00
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
2022-04-25 18:26:26 -04:00
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 {number} duration Hours
* @param {Server} io Socket server instance
* @param {number} monitorID ID of monitor to send
* @param {number} userID ID of user to send to
2021-09-22 03:10:08 -04:00
*/
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
}
/**
* Has status of monitor changed since last beat?
* @param {boolean} isFirstBeat Is this the first beat of this monitor?
* @param {const} previousBeatStatus Status of the previous beat
* @param {const} currentBeatStatus Status of the current beat
* @returns {boolean} True if is an important beat else false
*/
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
// MAINTENANCE -> MAINTENANCE = not important
// * MAINTENANCE -> UP = important
// * MAINTENANCE -> DOWN = important
// * DOWN -> MAINTENANCE = important
// * UP -> MAINTENANCE = important
return isFirstBeat ||
(previousBeatStatus === DOWN && currentBeatStatus === MAINTENANCE) ||
(previousBeatStatus === UP && currentBeatStatus === MAINTENANCE) ||
(previousBeatStatus === MAINTENANCE && currentBeatStatus === DOWN) ||
(previousBeatStatus === MAINTENANCE && currentBeatStatus === UP) ||
(previousBeatStatus === UP && currentBeatStatus === DOWN) ||
(previousBeatStatus === DOWN && currentBeatStatus === UP) ||
(previousBeatStatus === PENDING && currentBeatStatus === DOWN);
}
/**
* Is this beat important for notifications?
* @param {boolean} isFirstBeat Is this the first beat of this monitor?
* @param {const} previousBeatStatus Status of the previous beat
* @param {const} currentBeatStatus Status of the current beat
* @returns {boolean} True if is an important beat else false
*/
static isImportantForNotification(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
// MAINTENANCE -> MAINTENANCE = not important
// MAINTENANCE -> UP = not important
// * MAINTENANCE -> DOWN = important
// DOWN -> MAINTENANCE = not important
// UP -> MAINTENANCE = not important
return isFirstBeat ||
(previousBeatStatus === MAINTENANCE && currentBeatStatus === DOWN) ||
(previousBeatStatus === UP && currentBeatStatus === DOWN) ||
(previousBeatStatus === DOWN && currentBeatStatus === UP) ||
(previousBeatStatus === PENDING && currentBeatStatus === DOWN);
}
/**
* Send a notification about a monitor
* @param {boolean} isFirstBeat Is this beat the first of this monitor?
* @param {Monitor} monitor The monitor to send a notificaton about
* @param {Bean} bean Status information about monitor
*/
static async sendNotification(isFirstBeat, monitor, bean) {
if (!isFirstBeat || bean.status === DOWN) {
const notificationList = await Monitor.getNotificationList(monitor);
let text;
if (bean.status === UP) {
text = "✅ Up";
} else {
text = "🔴 Down";
}
let msg = `[${monitor.name}] [${text}] ${bean.msg}`;
for (let notification of notificationList) {
try {
2022-04-17 07:30:58 -04:00
await Notification.send(JSON.parse(notification.config), msg, await monitor.toJSON(false), bean.toJSON());
} catch (e) {
log.error("monitor", "Cannot send notification to " + notification.name);
log.error("monitor", e);
}
}
}
}
/**
* Get list of notification providers for a given monitor
* @param {Monitor} monitor Monitor to get notification providers for
* @returns {Promise<LooseObject<any>[]>}
*/
static async getNotificationList(monitor) {
let notificationList = await R.getAll("SELECT notification.* FROM notification, monitor_notification WHERE monitor_id = ? AND monitor_notification.notification_id = notification.id ", [
monitor.id,
]);
return notificationList;
}
/**
* Send notification about a certificate
* @param {Object} tlsInfoObject Information about certificate
*/
async sendCertNotification(tlsInfoObject) {
if (tlsInfoObject && tlsInfoObject.certInfo && tlsInfoObject.certInfo.daysRemaining) {
const notificationList = await Monitor.getNotificationList(this);
2022-05-12 06:18:47 -04:00
let notifyDays = await setting("tlsExpiryNotifyDays");
if (notifyDays == null || !Array.isArray(notifyDays)) {
// Reset Default
setSetting("tlsExpiryNotifyDays", [ 7, 14, 21 ], "general");
notifyDays = [ 7, 14, 21 ];
}
if (notifyDays != null && Array.isArray(notifyDays)) {
for (const day of notifyDays) {
log.debug("monitor", "call sendCertNotificationByTargetDays", day);
await this.sendCertNotificationByTargetDays(tlsInfoObject.certInfo.daysRemaining, day, notificationList);
}
}
}
}
/**
* Send a certificate notification when certificate expires in less
* than target days
* @param {number} daysRemaining Number of days remaining on certifcate
* @param {number} targetDays Number of days to alert after
* @param {LooseObject<any>[]} notificationList List of notification providers
* @returns {Promise<void>}
*/
async sendCertNotificationByTargetDays(daysRemaining, targetDays, notificationList) {
if (daysRemaining > targetDays) {
log.debug("monitor", `No need to send cert notification. ${daysRemaining} > ${targetDays}`);
return;
}
if (notificationList.length > 0) {
let row = await R.getRow("SELECT * FROM notification_sent_history WHERE type = ? AND monitor_id = ? AND days = ?", [
"certificate",
this.id,
targetDays,
]);
// Sent already, no need to send again
if (row) {
log.debug("monitor", "Sent already, no need to send again");
return;
}
let sent = false;
log.debug("monitor", "Send certificate notification");
for (let notification of notificationList) {
try {
log.debug("monitor", "Sending to " + notification.name);
await Notification.send(JSON.parse(notification.config), `[${this.name}][${this.url}] Certificate will be expired in ${daysRemaining} days`);
sent = true;
} catch (e) {
log.error("monitor", "Cannot send cert notification to " + notification.name);
log.error("monitor", e);
}
}
if (sent) {
await R.exec("INSERT INTO notification_sent_history (type, monitor_id, days) VALUES(?, ?, ?)", [
"certificate",
this.id,
targetDays,
]);
}
} else {
log.debug("monitor", "No notification, no need to send cert notification");
}
}
2021-12-08 01:59:59 -05:00
/**
* Get the status of the previous heartbeat
* @param {number} monitorID ID of monitor to check
* @returns {Promise<LooseObject<any>>}
*/
2021-12-08 01:59:59 -05:00
static async getPreviousHeartbeat(monitorID) {
return await R.getRow(`
SELECT status, time FROM heartbeat
WHERE id = (select MAX(id) from heartbeat where monitor_id = ?)
`, [
monitorID
]);
}
2022-04-30 09:50:05 -04:00
/**
* Check if monitor is under maintenance
* @param {number} monitorID ID of monitor to check
* @returns {Promise<boolean>}
*/
static async isUnderMaintenance(monitorID) {
let activeCondition = Maintenance.getActiveMaintenanceSQLCondition();
const maintenance = await R.getRow(`
SELECT COUNT(*) AS count
FROM monitor_maintenance mm
JOIN maintenance
ON mm.maintenance_id = maintenance.id
2022-10-10 13:45:30 -04:00
AND mm.monitor_id = ?
LEFT JOIN maintenance_timeslot
ON maintenance_timeslot.maintenance_id = maintenance.id
2022-10-10 13:45:30 -04:00
WHERE ${activeCondition}
LIMIT 1`, [ monitorID ]);
return maintenance.count !== 0;
}
2021-06-25 09:55:49 -04:00
}
module.exports = Monitor;