@daemonitor/plugins 1.1.2 → 1.1.4

package/dist/plugins/index.js

@@ -7,6 +7,7 @@ import { createWebsitePlugin } from "./monitoring/WebsitePlugin";
 import { createWordpressPlugin } from "./monitoring/WordpressPlugin";
 import { createLogWatchPlugin } from "./monitoring/LogWatchPlugin";
 import { createNetScanPlugin } from "./monitoring/NetScanPlugin";
+import { createSnmpPlugin } from "./monitoring/SnmpPlugin";
 // In future, implement other plugin factory functions using the same pattern
 // import { createOSPlugin } from "./monitoring/OSPlugin"
 // import { createMongoDBPlugin } from "./monitoring/MongoDBPlugin"
@@ -25,6 +26,7 @@ export default {
     Wordpress: createWordpressPlugin,
     Logwatch: createLogWatchPlugin,
     Netscan: createNetScanPlugin,
+    Snmp: createSnmpPlugin,
     // CloudflarePlugin: createCloudflarePlugin,
     // EwelinkPlugin: createEwelinkPlugin,
     // MongoDBPlugin: createMongoDBPlugin,

package/dist/plugins/monitoring/SnmpPlugin.js

@@ -0,0 +1,166 @@
+import { execFile } from "node:child_process";
+import { promisify } from "node:util";
+import { createMonitoringPlugin } from "../../lib/MonitoringPlugin";
+// SNMP monitor. First target class: printers (standard Printer-MIB) — model,
+// serial, lifetime page count, and per-supply toner/consumable levels. Shells
+// out to net-snmp's snmpget/snmpwalk (add `snmp` to the client image) rather
+// than pulling an npm SNMP stack, matching the other CLI-backed plugins.
+//
+// One client_state per target (type "snmp-printer", uid snmp-<slug>). Severity
+// is decided server-side (clientstate/update.put.ts): a supply at/under its
+// warn threshold → warning; an error/offline printer status → error.
+const pexec = promisify(execFile);
+// Printer-MIB / HOST-RESOURCES OIDs
+const OID = {
+    model: "1.3.6.1.2.1.25.3.2.1.3.1", // hrDeviceDescr
+    serial: "1.3.6.1.2.1.43.5.1.1.17.1", // prtGeneralSerialNumber
+    pages: "1.3.6.1.2.1.43.10.2.1.4.1.1", // prtMarkerLifeCount
+    status: "1.3.6.1.2.1.25.3.5.1.1.1", // hrPrinterStatus (3=idle,4=printing,5=warmup)
+    supplyDesc: "1.3.6.1.2.1.43.11.1.1.6", // prtMarkerSuppliesDescription (walk)
+    supplyMax: "1.3.6.1.2.1.43.11.1.1.8", // prtMarkerSuppliesMaxCapacity (walk)
+    supplyLevel: "1.3.6.1.2.1.43.11.1.1.9", // prtMarkerSuppliesLevel (walk)
+};
+const PRINTER_STATUS = { "1": "other", "2": "unknown", "3": "idle", "4": "printing", "5": "warmup" };
+// Generic SYSTEM / IF-MIB OIDs (switches, APs, anything SNMP-capable).
+const SYS = {
+    descr: "1.3.6.1.2.1.1.1.0", // sysDescr
+    uptime: "1.3.6.1.2.1.1.3.0", // sysUpTime (timeticks, 1/100s)
+    name: "1.3.6.1.2.1.1.5.0", // sysName
+    ifOper: "1.3.6.1.2.1.2.2.1.8", // ifOperStatus (walk): 1=up 2=down
+    ifAdmin: "1.3.6.1.2.1.2.2.1.7", // ifAdminStatus (walk): 1=up (enabled)
+};
+function slug(s) {
+    return s.replace(/[^a-zA-Z0-9_.-]+/g, "-").replace(/^-+|-+$/g, "");
+}
+async function snmpGet(t, oid, timeout = 8000) {
+    try {
+        const { stdout } = await pexec("snmpget", ["-v", t.version || "2c", "-c", t.community || "public", "-Ovq", "-t", "2", "-r", "1", t.ip, oid], { timeout });
+        const v = stdout.trim().replace(/^"|"$/g, "");
+        return v && !/No Such|no response|Timeout/i.test(v) ? v : null;
+    }
+    catch {
+        return null;
+    }
+}
+async function snmpWalk(t, oid, timeout = 10000) {
+    try {
+        const { stdout } = await pexec("snmpwalk", ["-v", t.version || "2c", "-c", t.community || "public", "-Oqv", "-t", "2", "-r", "1", t.ip, oid], { timeout });
+        return stdout.split("\n").map((l) => l.trim().replace(/^"|"$/g, "")).filter(Boolean);
+    }
+    catch {
+        return [];
+    }
+}
+async function collectPrinter(t) {
+    const warnPct = t.tonerWarnPct ?? 10;
+    const [model, serial, pagesRaw, statusRaw, descs, maxes, levels] = await Promise.all([
+        snmpGet(t, OID.model),
+        snmpGet(t, OID.serial),
+        snmpGet(t, OID.pages),
+        snmpGet(t, OID.status),
+        snmpWalk(t, OID.supplyDesc),
+        snmpWalk(t, OID.supplyMax),
+        snmpWalk(t, OID.supplyLevel),
+    ]);
+    // No response at all → the printer is unreachable / SNMP off.
+    if (model == null && serial == null && pagesRaw == null && !descs.length) {
+        return { name: t.name, ip: t.ip, kind: "printer", reachable: false };
+    }
+    // Pair descriptions with levels. prtMarkerSuppliesLevel semantics: -2 =
+    // unknown, -3 = "some remaining" (a level the device won't quantify); else a
+    // count out of MaxCapacity (which can itself be -2 = unknown).
+    const supplies = descs.map((desc, i) => {
+        const max = Number(maxes[i]);
+        const lvl = Number(levels[i]);
+        let pct = null;
+        if (lvl === -3)
+            pct = 100; // "ok / some remaining"
+        else if (lvl >= 0 && max > 0)
+            pct = Math.round((lvl / max) * 100);
+        return { name: desc, level: lvl, max, pct };
+    });
+    const low = supplies.filter((s) => s.pct != null && s.pct <= warnPct);
+    return {
+        name: t.name,
+        ip: t.ip,
+        kind: "printer",
+        reachable: true,
+        model: model || undefined,
+        serial: serial || undefined,
+        pages: pagesRaw != null ? Number(pagesRaw) : undefined,
+        status: statusRaw != null ? PRINTER_STATUS[statusRaw] || statusRaw : undefined,
+        supplies,
+        lowSupplies: low.map((s) => ({ name: s.name, pct: s.pct })),
+        warnPct,
+    };
+}
+// Generic SNMP device (switch/AP/…): identity, uptime, and enabled-port link
+// state so a down uplink or dead switch surfaces. Reachability via SNMP is more
+// reliable than ICMP — many devices drop ping but answer SNMP.
+async function collectDevice(t) {
+    const [descr, name, uptimeRaw, oper, admin] = await Promise.all([
+        snmpGet(t, SYS.descr),
+        snmpGet(t, SYS.name),
+        snmpGet(t, SYS.uptime),
+        snmpWalk(t, SYS.ifOper),
+        snmpWalk(t, SYS.ifAdmin),
+    ]);
+    if (descr == null && name == null && !oper.length) {
+        return { name: t.name, ip: t.ip, kind: t.kind || "device", reachable: false };
+    }
+    // Only count ADMIN-enabled ports; an enabled port that's operationally down is
+    // a real link-down (ignore the many disabled ports on a big switch).
+    let portsTotal = 0;
+    let portsUp = 0;
+    for (let i = 0; i < oper.length; i++) {
+        if (Number(admin[i]) === 1) {
+            portsTotal++;
+            if (Number(oper[i]) === 1)
+                portsUp++;
+        }
+    }
+    // sysUpTime timeticks → seconds
+    const upSecs = uptimeRaw != null ? Math.round((Number(String(uptimeRaw).replace(/[^0-9]/g, "")) || 0) / 100) : undefined;
+    return {
+        name: t.name,
+        ip: t.ip,
+        kind: t.kind || "device",
+        reachable: true,
+        sysDescr: descr || undefined,
+        sysName: name || undefined,
+        uptimeSecs: upSecs,
+        portsUp,
+        portsTotal,
+    };
+}
+export function createSnmpPlugin() {
+    let refreshTimer = null;
+    const targetsOf = (plugin) => {
+        const cfg = (plugin.config || {});
+        return (Array.isArray(cfg.targets) ? cfg.targets : [])
+            .filter((t) => t?.ip)
+            .map((t) => ({ ...t, community: t.community || cfg.community || "public" }));
+    };
+    const refreshFn = async (plugin) => {
+        await Promise.all(targetsOf(plugin).map(async (t) => {
+            try {
+                const data = t.kind === "printer" || !t.kind ? await collectPrinter(t) : await collectDevice(t);
+                await plugin.send(data, `snmp-${slug(t.name || t.ip)}`);
+            }
+            catch (e) {
+                await plugin.send({ name: t.name, ip: t.ip, kind: t.kind || "printer", error: String(e?.message || e).slice(0, 160) }, `snmp-${slug(t.name || t.ip)}`);
+            }
+        }));
+    };
+    const monitorFn = async (plugin) => {
+        await refreshFn(plugin);
+        refreshTimer = setInterval(() => refreshFn(plugin), plugin.config?.refreshInterval || 300000);
+    };
+    const teardownFn = async () => {
+        if (refreshTimer)
+            clearInterval(refreshTimer);
+        refreshTimer = null;
+    };
+    return createMonitoringPlugin("snmp", "snmp", "SNMP monitor (printers: model, pages, toner levels)", async () => { }, monitorFn, refreshFn, teardownFn);
+}
+export default createSnmpPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daemonitor/plugins",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "daemonitor plugins",
   "types": "types/index.d.ts",
   "main": "dist/index.js",