Merge pull request #687 from gnmyt/features/prometheus

🔥 Prometheus Endpunkt hinzugefügt

Author: gnmyt

README.de.md

@@ -25,6 +25,8 @@ MySpeed ist eine Speedtest-Analyse-Software, welche die Geschwindigkeit deines I
 - 🗄️ Füge mehrere Server direkt zu einer MySpeed-Instanz hinzu
 - 🩺 Es lassen sich Healthchecks konfigurieren, welche dich bei Fehlern oder Ausfällen über E-Mail, Signal, WhatsApp oder Telegram benachrichtigen können
 - 📆 Testergebnisse lassen sich bis zu 30 Tage lang speichern
+- 🔥 Unterstützung für Prometheus und Grafana
+- 🗳️ Wähle zwischen Ookla, LibreSpeed und Cloudflare Speedtest-Servern
 - 💁 Erfahre mehr zu MySpeed auf unserer [Website](https://myspeed.dev)
 
 ### ⬇️ Installation

README.md

@@ -25,6 +25,8 @@ MySpeed is a speed test analysis software that records your internet speed for u
 - 🗄️ Add multiple servers directly to a MySpeed instance
 - 🩺 Configure health checks to notify you via email, Signal, WhatsApp, or Telegram in case of errors or downtime
 - 📆 Test results can be stored for up to 30 days
+- 🔥 Support for Prometheus and Grafana
+- 🗳️ Choose between Ookla, LibreSpeed and Cloudflare speed test servers
 - 💁 Learn more about MySpeed on our [website](https://myspeed.dev)
 
 ### ⬇️ Installation

package-lock.json

@@ -17,6 +17,7 @@
     "express": "^4.19.2",
     "mysql2": "^3.9.7",
     "node-schedule": "^2.1.1",
+    "prom-client": "^15.1.2",
     "sequelize": "^6.37.3",
     "sqlite3": "^5.1.7",
     "tmp": "^0.2.3"

package.json

@@ -144,4 +144,19 @@ module.exports.removeOld = async () => {
         }
     });
     return true;
+}
+
+module.exports.getLatest = async () => {
+    let latest = await tests.findOne({order: [["created", "DESC"]]});
+    if (latest.error === null) delete latest.error;
+    if (latest.resultId === null) delete latest.resultId;
+    return latest;
+}
+
+module.exports.getLatest = async () => {
+    let latest = await tests.findOne({order: [["created", "DESC"]]});
+    if (latest === null) return undefined;
+    if (latest.error === null) delete latest.error;
+    if (latest.resultId === null) delete latest.resultId;
+    return latest;
 }

server/controller/speedtests.js

@@ -24,6 +24,7 @@ app.use("/api/storage", require('./routes/storage'));
 app.use("/api/recommendations", require('./routes/recommendations'));
 app.use("/api/nodes", require('./routes/nodes'));
 app.use("/api/integrations", require('./routes/integrations'));
+app.use("/api/prometheus", require('./routes/prometheus'));
 app.use("/api*", (req, res) => res.status(404).json({message: "Route not found"}));
 
 if (process.env.NODE_ENV === 'production') {

server/index.js

@@ -0,0 +1,49 @@
+const express = require('express');
+const app = express.Router();
+const testController = require('../controller/speedtests');
+const promClient = require('prom-client');
+const config = require('../controller/config');
+const bcrypt = require('bcrypt');
+
+const pingGauge = new promClient.Gauge({name: 'myspeed_ping', help: 'Current ping in ms'});
+const downloadGauge = new promClient.Gauge({name: 'myspeed_download', help: 'Current download speed in Mbps'});
+const uploadGauge = new promClient.Gauge({name: 'myspeed_upload', help: 'Current upload speed in Mbps'});
+const currentServerGauge = new promClient.Gauge({name: 'myspeed_server', help: 'Current server ID',});
+const timeGauge = new promClient.Gauge({name: 'myspeed_time', help: 'Time of the test'});
+
+app.get('/metrics', async (req, res) => {
+    let passwordHash = await config.getValue("password");
+
+    if (passwordHash !== "none") {
+        if (!req.headers.authorization || req.headers.authorization.indexOf('Basic ') === -1) {
+            res.setHeader('WWW-Authenticate', 'Basic realm="User Visible Realm"');
+            return res.status(401).end('Unauthorized');
+        }
+
+        const base64Credentials =  req.headers.authorization.split(' ')[1];
+        const credentials = Buffer.from(base64Credentials, 'base64').toString('ascii');
+        const [username, password] = credentials.split(':');
+
+        if (username !== "prometheus" || !bcrypt.compareSync(password, passwordHash)) {
+            res.setHeader('WWW-Authenticate', 'Basic realm="User Visible Realm"');
+            return res.status(401).end('Unauthorized');
+        }
+    }
+
+    const latest = await testController.getLatest();
+    if (!latest) return res.status(500).end('No test found');
+
+    if (latest.error || latest.ping === -1)
+        return res.status(500).end('Error in the latest test');
+
+    pingGauge.set(latest.ping);
+    downloadGauge.set(latest.download);
+    uploadGauge.set(latest.upload);
+    currentServerGauge.set(latest.serverId);
+    timeGauge.set(latest.time);
+
+    res.set('Content-Type', promClient.register.contentType);
+    res.end(await promClient.register.metrics());
+});
+
+module.exports = app;