mudhorn/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2025-01-12 06:17:30 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Feature: SIP options ping Monitor Type using sipsak binary

Browse source
This commit is contained in:
Eddie Fiorentine 2024-11-19 19:40:23 -05:00
parent 4228dd0a29
commit c40f8e7ba5
4 changed files with 77 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
server/monitor-types/sip-options.js Normal file
View file

@ -0,0 +1,61 @@
const { MonitorType } = require("./monitor-type");
const { UP, log } = require("../../src/util");
const { exec } = require("promisify-child-process");
class SIPMonitorType extends MonitorType {
name = "sip-options";
supportsConditions = false;
/**
* Run the monitoring check on the given monitor
* @param {Monitor} monitor Monitor to check
* @param {Heartbeat} heartbeat Monitor heartbeat to update
* @param {UptimeKumaServer} server Uptime Kuma server
* @returns {Promise<void>}
*/
async check(monitor, heartbeat, _server) {
try {
let sipsakOutput = await this.runSipSak(monitor.hostname, monitor.port, 3000);
this.parseSipsakResponse(sipsakOutput, heartbeat);
} catch (err) {
throw new Error(`Error checking Sipsak: ${err} ${err.message} ${err.stack}`);
}
}
/**
* Runs Sipsak options ping
* @param {string} hostname SIP server address to send options.
* @param {number} timeout timeout of options reply
* @returns {Promise<string>} A Promise that resolves to the output of the Sipsak options ping
* @throws Will throw an error if the command execution encounters any error.
*/
async runSipSak(hostname, port, timeout) {
const { stdout, stderr } = await exec(`sipsak -s sip:${hostname}:${port} --from sip:sipsak@${hostname} -v`,{timeout:timeout});
if (stderr){
console.error(`Error in stderr: ${stderr.toString()}`);
}
if (!stdout && stderr && stderr.toString()) {
throw new Error(`Error in output: ${stderr.toString()}`);
}
if (stdout && stdout.toString()) {
return stdout.toString();
} else {
throw new Error("No output from sipsak");
}
}
parseSipsakResponse(res, heartbeat){
let lines = res.split("\n");
for (let line of lines){
if (line.includes("200 OK")){
heartbeat.status = UP;
heartbeat.msg = line;
break;
}
}
}
}
module.exports = {
SIPMonitorType,
};

4
server/uptime-kuma-server.js
View file

@ -116,6 +116,7 @@ class UptimeKumaServer {
UptimeKumaServer.monitorTypeList["snmp"] = new SNMPMonitorType();
UptimeKumaServer.monitorTypeList["mongodb"] = new MongodbMonitorType();
UptimeKumaServer.monitorTypeList["rabbitmq"] = new RabbitMqMonitorType();
UptimeKumaServer.monitorTypeList["sip-options"] = new SIPMonitorType();
// Allow all CORS origins (polling) in development
let cors = undefined;
@ -554,4 +555,5 @@ const { MqttMonitorType } = require("./monitor-types/mqtt");
const { SNMPMonitorType } = require("./monitor-types/snmp");
const { MongodbMonitorType } = require("./monitor-types/mongodb");
const { RabbitMqMonitorType } = require("./monitor-types/rabbitmq");
const Monitor = require("./model/monitor");
const Monitor = require("./model/monitor");const { SIPMonitorType } = require("./monitor-types/sip-options");

1
src/lang/en.json
View file

@ -405,6 +405,7 @@
"socket": "Socket",
"tcp": "TCP / HTTP",
"tailscalePingWarning": "In order to use the Tailscale Ping monitor, you need to install Uptime Kuma without Docker and also install Tailscale client on your server.",
"sipsakPingWarning": "In order to use the SIP Options Ping monitor, you need to install Uptime Kuma without Docker and also install Sipsak client on your server.",
"Docker Container": "Docker Container",
"Container Name / ID": "Container Name / ID",
"Docker Host": "Docker Host",

17
src/pages/EditMonitor.vue
View file

@ -88,9 +88,12 @@
<option value="redis">
Redis
</option>
<option v-if="!$root.info.isContainer" value="sip-options">
SIP Options Ping
</option>
<option v-if="!$root.info.isContainer" value="tailscale-ping">
Tailscale Ping
</option>
</option>
</optgroup>
</select>
<i18n-t v-if="monitor.type === 'rabbitmq'" keypath="rabbitmqHelpText" tag="div" class="form-text">
@ -106,6 +109,10 @@
{{ $t("tailscalePingWarning") }}
</div>
<div v-if="monitor.type === 'sip-options'" class="alert alert-warning" role="alert">
{{ $t("sipsakPingWarning") }}
</div>
<!-- Friendly Name -->
<div class="my-3">
<label for="name" class="form-label">{{ $t("Friendly Name") }}</label>
@ -281,8 +288,8 @@
</template>
<!-- Hostname -->
<!-- TCP Port / Ping / DNS / Steam / MQTT / Radius / Tailscale Ping / SNMP only -->
<div v-if="monitor.type === 'port' || monitor.type === 'ping' || monitor.type === 'dns' || monitor.type === 'steam' || monitor.type === 'gamedig' || monitor.type === 'mqtt' || monitor.type === 'radius' || monitor.type === 'tailscale-ping' || monitor.type === 'snmp'" class="my-3">
<!-- TCP Port / Ping / DNS / Steam / MQTT / Radius / Tailscale Ping / SNMP only / SIP Options -->
<div v-if="monitor.type === 'port' || monitor.type === 'ping' || monitor.type === 'dns' || monitor.type === 'steam' || monitor.type === 'gamedig' || monitor.type === 'mqtt' || monitor.type === 'radius' || monitor.type === 'tailscale-ping' || monitor.type === 'snmp' || monitor.type ==='sip-options'" class="my-3">
<label for="hostname" class="form-label">{{ $t("Hostname") }}</label>
<input
id="hostname"
@ -296,8 +303,8 @@
</div>
<!-- Port -->
<!-- For TCP Port / Steam / MQTT / Radius Type / SNMP -->
<div v-if="monitor.type === 'port' || monitor.type === 'steam' || monitor.type === 'gamedig' || monitor.type === 'mqtt' || monitor.type === 'radius' || monitor.type === 'snmp'" class="my-3">
<!-- For TCP Port / Steam / MQTT / Radius Type / SNMP / SIP Options -->
<div v-if="monitor.type === 'port' || monitor.type === 'steam' || monitor.type === 'gamedig' || monitor.type === 'mqtt' || monitor.type === 'radius' || monitor.type === 'snmp' || monitor.type === 'sip-options'" class="my-3">
<label for="port" class="form-label">{{ $t("Port") }}</label>
<input id="port" v-model="monitor.port" type="number" class="form-control" required min="0" max="65535" step="1">
</div>