ric/uptime-kuma
1
0
Fork 0
mirror of https://github.com/louislam/uptime-kuma.git synced 2024-11-23 14:54:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

removed some monitor drift in terms of code comments (#4820)

Browse source
This commit is contained in:
Frank Elsinga 2024-06-07 16:03:12 +02:00 committed by GitHub
commit bc25b719db
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 4 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
server/monitor-types/dns.js
View file

@ -5,7 +5,6 @@ const { dnsResolve } = require("../util-server");
const { R } = require("redbean-node"); const { R } = require("redbean-node");
class DnsMonitorType extends MonitorType { class DnsMonitorType extends MonitorType {
name = "dns"; name = "dns";
/** /**

4
server/monitor-types/mongodb.js
View file

@ -4,7 +4,6 @@ const { MongoClient } = require("mongodb");
const jsonata = require("jsonata"); const jsonata = require("jsonata");
class MongodbMonitorType extends MonitorType { class MongodbMonitorType extends MonitorType {
name = "mongodb"; name = "mongodb";
/** /**
@ -49,8 +48,7 @@ class MongodbMonitorType extends MonitorType {
* Connect to and run MongoDB command on a MongoDB database * Connect to and run MongoDB command on a MongoDB database
* @param {string} connectionString The database connection string * @param {string} connectionString The database connection string
* @param {object} command MongoDB command to run on the database * @param {object} command MongoDB command to run on the database
* @returns {Promise<(string[] | object[] | object)>} Response from * @returns {Promise<(string[] | object[] | object)>} Response from server
* server
*/ */
async runMongodbCommand(connectionString, command) { async runMongodbCommand(connectionString, command) {
let client = await MongoClient.connect(connectionString); let client = await MongoClient.connect(connectionString);

1
server/monitor-types/monitor-type.js
View file

@ -11,7 +11,6 @@ class MonitorType {
async check(monitor, heartbeat, server) { async check(monitor, heartbeat, server) {
throw new Error("You need to override check()"); throw new Error("You need to override check()");
} }
} }
module.exports = { module.exports = {

7
server/monitor-types/mqtt.js
View file

@ -4,15 +4,10 @@ const mqtt = require("mqtt");
const jsonata = require("jsonata"); const jsonata = require("jsonata");
class MqttMonitorType extends MonitorType { class MqttMonitorType extends MonitorType {
name = "mqtt"; name = "mqtt";
/** /**
* Run the monitoring check on the MQTT monitor * @inheritdoc
* @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) { async check(monitor, heartbeat, server) {
const receivedMessage = await this.mqttAsync(monitor.hostname, monitor.mqttTopic, { const receivedMessage = await this.mqttAsync(monitor.hostname, monitor.mqttTopic, {

14
server/monitor-types/tailscale-ping.js
View file

@ -2,23 +2,13 @@ const { MonitorType } = require("./monitor-type");
const { UP } = require("../../src/util"); const { UP } = require("../../src/util");
const childProcessAsync = require("promisify-child-process"); const childProcessAsync = require("promisify-child-process");
/**
* A TailscalePing class extends the MonitorType.
* It runs Tailscale ping to monitor the status of a specific node.
*/
class TailscalePing extends MonitorType { class TailscalePing extends MonitorType {
name = "tailscale-ping"; name = "tailscale-ping";
/** /**
* Checks the ping status of the URL associated with the monitor. * @inheritdoc
* It then parses the Tailscale ping command output to update the heatrbeat.
* @param {object} monitor The monitor object associated with the check.
* @param {object} heartbeat The heartbeat object to update.
* @returns {Promise<void>}
* @throws Error if checking Tailscale ping encounters any error
*/ */
async check(monitor, heartbeat) { async check(monitor, heartbeat, _server) {
try { try {
let tailscaleOutput = await this.runTailscalePing(monitor.hostname, monitor.interval); let tailscaleOutput = await this.runTailscalePing(monitor.hostname, monitor.interval);
this.parseTailscaleOutput(tailscaleOutput, heartbeat); this.parseTailscaleOutput(tailscaleOutput, heartbeat);