Skip to content

Commit

Permalink
removed some monitor drift in terms of code comments (louislam#4820)
Browse files Browse the repository at this point in the history
  • Loading branch information
CommanderStorm authored Jun 7, 2024
2 parents 4794f9e + b6cd21c commit bc25b71
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 23 deletions.
1 change: 0 additions & 1 deletion server/monitor-types/dns.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ const { dnsResolve } = require("../util-server");
const { R } = require("redbean-node");

class DnsMonitorType extends MonitorType {

name = "dns";

/**
Expand Down
4 changes: 1 addition & 3 deletions server/monitor-types/mongodb.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ const { MongoClient } = require("mongodb");
const jsonata = require("jsonata");

class MongodbMonitorType extends MonitorType {

name = "mongodb";

/**
Expand Down Expand Up @@ -49,8 +48,7 @@ class MongodbMonitorType extends MonitorType {
* Connect to and run MongoDB command on a MongoDB database
* @param {string} connectionString The database connection string
* @param {object} command MongoDB command to run on the database
* @returns {Promise<(string[] | object[] | object)>} Response from
* server
* @returns {Promise<(string[] | object[] | object)>} Response from server
*/
async runMongodbCommand(connectionString, command) {
let client = await MongoClient.connect(connectionString);
Expand Down
1 change: 0 additions & 1 deletion server/monitor-types/monitor-type.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ class MonitorType {
async check(monitor, heartbeat, server) {
throw new Error("You need to override check()");
}

}

module.exports = {
Expand Down
7 changes: 1 addition & 6 deletions server/monitor-types/mqtt.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,10 @@ const mqtt = require("mqtt");
const jsonata = require("jsonata");

class MqttMonitorType extends MonitorType {

name = "mqtt";

/**
* Run the monitoring check on the MQTT monitor
* @param {Monitor} monitor Monitor to check
* @param {Heartbeat} heartbeat Monitor heartbeat to update
* @param {UptimeKumaServer} server Uptime Kuma server
* @returns {Promise<void>}
* @inheritdoc
*/
async check(monitor, heartbeat, server) {
const receivedMessage = await this.mqttAsync(monitor.hostname, monitor.mqttTopic, {
Expand Down
14 changes: 2 additions & 12 deletions server/monitor-types/tailscale-ping.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,13 @@ const { MonitorType } = require("./monitor-type");
const { UP } = require("../../src/util");
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 {

name = "tailscale-ping";

/**
* Checks the ping status of the URL associated with the monitor.
* 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
* @inheritdoc
*/
async check(monitor, heartbeat) {
async check(monitor, heartbeat, _server) {
try {
let tailscaleOutput = await this.runTailscalePing(monitor.hostname, monitor.interval);
this.parseTailscaleOutput(tailscaleOutput, heartbeat);
Expand Down

0 comments on commit bc25b71

Please sign in to comment.