From 09fd816aae0f032bf020571522569c6588cc5af8 Mon Sep 17 00:00:00 2001
From: Matt Visnovsky <matt@visnovsky.us>
Date: Fri, 3 May 2024 11:52:02 -0600
Subject: [PATCH] Updated code comments

---
 server/monitor-types/snmp.js | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/server/monitor-types/snmp.js b/server/monitor-types/snmp.js
index b14c85953..ea9c3a85c 100644
--- a/server/monitor-types/snmp.js
+++ b/server/monitor-types/snmp.js
@@ -14,6 +14,9 @@ class SNMPMonitorType extends MonitorType {
             port: monitor.port || "161",
             retries: monitor.maxretries,
             timeout: monitor.timeout * 1000,
+
+            // Resolve the net-snmp version identifier from monitor.snmpVersion using the `getKey` method (see utils.ts).
+            // If the specified version exists, use it; otherwise, default to SNMP version 2c.
             version: getKey(snmp.Version, monitor.snmpVersion) || snmp.Version2c,
         };
 
@@ -38,9 +41,14 @@ class SNMPMonitorType extends MonitorType {
                 });
             });
 
+            // Verify if any varbinds were returned from the SNMP session or if the varbind type indicates a non-existent instance.
+            // The `getKey` method retrieves the key associated with the varbind type from the snmp.ObjectType object.
             if (varbinds.length === 0 || getKey(snmp.ObjectType, varbinds[0].type) === "NoSuchInstance") {
                 throw new Error(`No varbinds returned from SNMP session (OID: ${monitor.snmpOid})`);
+
+            // Varbinds succesfully returned
             } else {
+
                 const value = varbinds[0].value;
 
                 // Check if inputs are numeric. If not, re-parse as strings. This ensures comparisons are handled correctly.