mirrors
/
uptime-kuma
mirror of https://github.com/louislam/uptime-kuma.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add ping, status badge

This commit is contained in:
Jens Neuber 2022-01-04 12:21:53 +01:00
parent d74404e106
commit 3625915a85
3 changed files with 152 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
server/config.js
View File

@ -1,7 +1,15 @@
const args = require("args-parser")(process.argv);
const demoMode = args["demo"] || false;
const badgeConstants = {
naColor: "#999",
defaultUpColor: "#66c20a",
defaultDownColor: "#c2290a",
defaultPingColor: "blue", // as defined by badge-maker / shields.io
};
module.exports = {
args,
demoMode
demoMode,
badgeConstants
};

158
server/routers/api-router.js
View File

@ -1,5 +1,5 @@
let express = require("express");
const { allowDevAllOrigin, getSettings, setting, percentageToColor } = require("../util-server");
const { allowDevAllOrigin, getSettings, setting, percentageToColor, allowAllOrigin } = require("../util-server");
const { R } = require("redbean-node");
const server = require("../server");
const apicache = require("../modules/apicache");
@ -7,6 +7,7 @@ const Monitor = require("../model/monitor");
const dayjs = require("dayjs");
const { UP, flipStatus, debug } = require("../../src/util");
const { makeBadge } = require("badge-maker");
const { badgeConstants } = require("../config");
let router = express.Router();
let cache = apicache.middleware;
@ -215,22 +216,23 @@ router.get("/api/status-page/heartbeat", cache("5 minutes"), async (_request, re
}
});
router.get("/api/badge/:id/:type", cache("5 minutes"), async (request, response) => {
allowDevAllOrigin(response);
router.get("/api/badge/:id/status", cache("5 minutes"), async (request, response) => {
allowAllOrigin(response);
const {
label,
labelPrefix,
labelSuffix = "h",
prefix,
suffix,
upLabel = "Up",
downLabel = "Down",
upColor = badgeConstants.defaultUpColor,
downColor = badgeConstants.defaultDownColor,
value // for demo purpose only
} = request.query;
try {
await checkPublished();
const requestedMonitorId = parseInt(request.params.id, 10);
const requestedType = parseInt(request.params.type, 10) ?? 24;
const overrideValue = value !== undefined ? parseInt(value) : undefined;
let publicMonitor = await R.getRow(`
SELECT monitor_group.monitor_id FROM monitor_group, \`group\`
@ -244,23 +246,146 @@ router.get("/api/badge/:id/:type", cache("5 minutes"), async (request, response)
const badgeValues = {};
if (!publicMonitor) {
// return a "n/a" badge in grey, if monitor is not public / not available / non exsitant
// return a "N/A" badge in naColor (grey), if monitor is not public / not available / non exsitant
badgeValues.message = "N/A";
badgeValues.color = "#999";
badgeValues.color = badgeConstants.naColor;
} else {
const uptime = await Monitor.calcUptime(
requestedType,
const heartbeat = await Monitor.getPreviousHeartbeat(requestedMonitorId);
const state = overrideValue !== undefined ? overrideValue : heartbeat.status === 1;
badgeValues.color = state ? upColor : downColor;
badgeValues.message = label ?? state ? upLabel : downLabel;
}
// build the svg based on given values
const svg = makeBadge(badgeValues);
response.type("image/svg+xml");
response.send(svg);
} catch (error) {
send403(response, error.message);
}
});
router.get("/api/badge/:id/uptime/:duration?", cache("5 minutes"), async (request, response) => {
allowAllOrigin(response);
const {
label,
labelPrefix,
labelSuffix = "h",
prefix,
suffix = "%",
color,
labelColor,
value // for demo purpose only
} = request.query;
try {
await checkPublished();
const requestedMonitorId = parseInt(request.params.id, 10);
// if no duration is given, set value to 24 (h)
const requestedDuration = request.params.duration !== undefined ? parseInt(request.params.duration, 10) : 24;
const overrideValue = value && parseFloat(value);
let publicMonitor = await R.getRow(`
SELECT monitor_group.monitor_id FROM monitor_group, \`group\`
WHERE monitor_group.group_id = \`group\`.id
AND monitor_group.monitor_id = ?
AND public = 1
`,
[requestedMonitorId]
);
const badgeValues = {};
if (!publicMonitor) {
// return a "N/A" badge in naColor (grey), if monitor is not public / not available / non exsitant
badgeValues.message = "N/A";
badgeValues.color = badgeConstants.naColor;
} else {
const uptime = overrideValue ?? await Monitor.calcUptime(
requestedDuration,
requestedMonitorId
);
badgeValues.color = percentageToColor(uptime);
badgeValues.color = color ?? percentageToColor(uptime);
badgeValues.labelColor = labelColor ?? "";
badgeValues.label = [labelPrefix, label ?? requestedType, labelSuffix]
badgeValues.label = [labelPrefix, label ?? requestedDuration, labelSuffix]
.filter((part) => part ?? part !== "")
.join("");
badgeValues.message = [prefix, `${uptime * 100} %`, suffix]
badgeValues.message = [prefix, `${uptime * 100}`, suffix]
.filter((part) => part ?? part !== "")
.join("");
}
// build the SVG based on given values
const svg = makeBadge(badgeValues);
response.type("image/svg+xml");
response.send(svg);
} catch (error) {
send403(response, error.message);
}
});
router.get("/api/badge/:id/ping/:duration?", cache("5 minutes"), async (request, response) => {
allowAllOrigin(response);
const {
label,
labelPrefix,
labelSuffix = "h",
prefix,
suffix = "ms",
color = badgeConstants.defaultPingColor,
labelColor,
value
} = request.query;
try {
await checkPublished();
const requestedMonitorId = parseInt(request.params.id, 10);
// Default duration is 24 (h) if not defined in queryParam, limited to 720h (30d)
const requestedDuration = Math.min(request.params.duration ? parseInt(request.params.duration, 10) : 24, 720);
const overrideValue = value && parseFloat(value);
const publicAvgPing = parseInt(await R.getCell(`
SELECT AVG(ping) FROM monitor_group, \`group\`, heartbeat
WHERE monitor_group.group_id = \`group\`.id
AND heartbeat.time > DATETIME('now', ? || ' hours')
AND heartbeat.ping IS NOT NULL
AND public = 1
AND heartbeat.monitor_id = ?
`,
[-requestedDuration, requestedMonitorId]
));
const badgeValues = {};
if (!publicAvgPing) {
// return a "N/A" badge in naColor (grey), if monitor is not public / not available / non exsitant
badgeValues.message = "N/A";
badgeValues.color = badgeConstants.naColor;
} else {
const avgPing = parseInt(overrideValue ?? publicAvgPing);
badgeValues.color = color;
badgeValues.labelColor = labelColor ?? "";
badgeValues.label = [labelPrefix, label ?? requestedDuration, labelSuffix]
.filter((part) => part ?? part !== "")
.join("");
badgeValues.message = [prefix, avgPing, suffix]
.filter((part) => part ?? part !== "")
.join("");
}
@ -273,8 +398,7 @@ router.get("/api/badge/:id/:type", cache("5 minutes"), async (request, response)
} catch (error) {
send403(response, error.message);
}
}
);
});
async function checkPublished() {
if (! await isPublished()) {

3
server/util-server.js
View File

@ -11,6 +11,7 @@ const chardet = require("chardet");
const fs = require("fs");
const nodeJsUtil = require("util");
const chroma = require("chroma-js");
const { badgeConstants } = require("./config");
// From ping-lite
exports.WIN = /^win/.test(process.platform);
@ -387,6 +388,6 @@ exports.percentageToColor = (percentage, maxHue = 90, minHue = 10) => {
try {
return chroma(`hsl(${hue}, 90%, 40%)`).hex();
} catch (err) {
return "#999";
return badgeConstants.naColor;
}
};