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

Apply suggestions from code review

Browse source 
Co-authored-by: Frank Elsinga <frank@elsinga.de>
This commit is contained in:
Matt Visnovsky 2024-05-08 10:06:20 -06:00 committed by GitHub
parent 8b4b27f359
commit da8f0d1c31
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 18 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
db/knex_migrations/2024-04-26-0000-snmp-monitor.js
View file

@ -1,11 +1,11 @@
exports.up = function (knex) { exports.up = function (knex) {
return knex.schema return knex.schema
.alterTable("monitor", function (table) { .alterTable("monitor", function (table) {
table.string("snmp_community_string", 255).defaultTo("public"); // Add snmp_community_string column table.string("snmp_community_string", 255).defaultTo("public");
table.string("snmp_oid").defaultTo(null); // Add oid column table.string("snmp_oid").defaultTo(null);
table.enum("snmp_version", [ "0", "1", "3" ]).defaultTo("1"); // Add snmp_version column with enum values (0: SNMPv1, 1: SNMPv2c, 3: SNMPv3) table.enum("snmp_version", [ "1", "2c", "3" ]).defaultTo("2c");
table.float("snmp_control_value").defaultTo(null); // Add control_value column as float table.float("snmp_control_value").defaultTo(null);
table.string("snmp_condition").defaultTo(null); // Add oid column table.string("snmp_condition").defaultTo(null);
}); });
}; };

6
server/monitor-types/snmp.js
View file

@ -14,7 +14,7 @@ class SNMPMonitorType extends MonitorType {
port: monitor.port || "161", port: monitor.port || "161",
retries: monitor.maxretries, retries: monitor.maxretries,
timeout: monitor.timeout * 1000, timeout: monitor.timeout * 1000,
version: parseInt(monitor.snmpVersion), version: snmp.Version[monitor.snmpVersion],
}; };
let session; let session;
@ -37,14 +37,12 @@ class SNMPMonitorType extends MonitorType {
}); });
log.debug("monitor", `SNMP: Received varbinds (Type: ${snmp.ObjectType[varbinds[0].type]} Value: ${varbinds[0].value}`); log.debug("monitor", `SNMP: Received varbinds (Type: ${snmp.ObjectType[varbinds[0].type]} Value: ${varbinds[0].value}`);
// Verify if any varbinds were returned from the SNMP session.
if (varbinds.length === 0) { if (varbinds.length === 0) {
throw new Error(`No varbinds returned from SNMP session (OID: ${monitor.snmpOid})`); throw new Error(`No varbinds returned from SNMP session (OID: ${monitor.snmpOid})`);
} }
// Check if the varbind type indicates a non-existent instance.
if (varbinds[0].type === snmp.ObjectType.NoSuchInstance) { if (varbinds[0].type === snmp.ObjectType.NoSuchInstance) {
throw new Error(`The SNMP query was successful but no varbinds returned for OID: ${monitor.snmpOid}`); throw new Error(`The SNMP query returned that no instance exists for OID ${monitor.snmpOid}`);
} }
// We restrict querying to one OID per monitor, therefore `varbinds[0]` will always contain the value we're interested in. // We restrict querying to one OID per monitor, therefore `varbinds[0]` will always contain the value we're interested in.

24
src/pages/EditMonitor.vue
View file

@ -265,18 +265,18 @@
<!-- SNMP Monitor Type --> <!-- SNMP Monitor Type -->
<div v-if="monitor.type === 'snmp'" class="my-3"> <div v-if="monitor.type === 'snmp'" class="my-3">
<label for="snmp_community_string" class="form-label">{{ $t("Community String") }}</label> <label for="snmp_community_string" class="form-label">{{ $t("Community String") }}</label>
<input id="snmp_community_string" v-model="monitor.snmpCommunityString" type="text" class="form-control" required placeholder="public"> <!-- TODO: Rename monitor.radiusPassword to monitor.password for general use -->
<HiddenInput id="snmp_community_string" v-model="monitor.radiusPassword" autocomplete="false" required="true" placeholder="public"></HiddenInput>
<!-- eslint-disable-next-line vue/no-v-html --> <div class="form-text">{{ $t('snmpCommunityStringHelptext')
<div class="form-text" v-html="$t('snmpCommunityStringHelptext')"></div> }}</div>
</div> </div>
<div v-if="monitor.type === 'snmp'" class="my-3"> <div v-if="monitor.type === 'snmp'" class="my-3">
<label for="snmp_oid" class="form-label">{{ $t("OID (Object Identifier)") }}</label> <label for="snmp_oid" class="form-label">{{ $t("OID (Object Identifier)") }}</label>
<input id="snmp_oid" v-model="monitor.snmpOid" :title="$t('Please enter a valid OID.') + ' ' + $t('Example:', ['1.3.6.1.4.1.9.6.1.101'])" type="text" class="form-control" pattern="^([0-2])((\.0)|(\.[1-9][0-9]*))*$" placeholder="1.3.6.1.4.1.9.6.1.101" required> <input id="snmp_oid" v-model="monitor.snmpOid" :title="$t('Please enter a valid OID.') + ' ' + $t('Example:', ['1.3.6.1.4.1.9.6.1.101'])" type="text" class="form-control" pattern="^([0-2])((\.0)|(\.[1-9][0-9]*))*$" placeholder="1.3.6.1.4.1.9.6.1.101" required>
<div class="form-text">{{
<!-- eslint-disable-next-line vue/no-v-html --> $t('snmpOIDHelptext') }}</div>
<div class="form-text" v-html="$t('snmpOIDHelptext')"></div>
</div> </div>
<div v-if="monitor.type === 'snmp'" class="my-3"> <div v-if="monitor.type === 'snmp'" class="my-3">
@ -303,10 +303,10 @@
<div v-if="monitor.type === 'snmp'" class="my-3"> <div v-if="monitor.type === 'snmp'" class="my-3">
<label for="snmp_version" class="form-label">{{ $t("SNMP Version") }}</label> <label for="snmp_version" class="form-label">{{ $t("SNMP Version") }}</label>
<select id="snmp_version" v-model="monitor.snmpVersion" class="form-select"> <select id="snmp_version" v-model="monitor.snmpVersion" class="form-select">
<option value="0"> <option value="1">
SNMPv1 SNMPv1
</option> </option>
<option value="1"> <option value="2c">
SNMPv2c SNMPv2c
</option> </option>
</select> </select>
@ -1323,13 +1323,11 @@ message HealthCheckResponse {
} }
} }
// Set a default timeout of 1 second for SNMP monitors when querying a single OID.
// Since we're only querying a single OID, a shorter timeout is sufficient to ensure timely responses
// without unnecessary delays. This helps keep the monitoring process lightweight and efficient.
if (this.monitor.type === "snmp") { if (this.monitor.type === "snmp") {
this.monitor.timeout = 1; // snmp is not expected to be executed via the internet => we can choose a lower default timeout
this.monitor.timeout = 5;
} else { } else {
this.monitor.timeout = 48; // Default timeout for other monitor types this.monitor.timeout = 48;
} }
// Set default SNMP version // Set default SNMP version