[arista-switch] improve logging

geoffhouse · geoffhouse · commit 4197f2fefa8d · 2026-04-23T14:54:27.000+01:00
diff --git a/src/modules/arista-switch/TODO.md b/src/modules/arista-switch/TODO.md
@@ -1,3 +1 @@
-- use bulkwrite in workers to improve db performance
-- remove filename from all log actions......
 - add heartbeat status check and worker task
diff --git a/src/modules/arista-switch/container/services/device-save.js b/src/modules/arista-switch/container/services/device-save.js
@@ -11,7 +11,7 @@ module.exports = async () => {
             throw new Error("failed to load config");
         }
 
-        logger.info("device-save: saving device config ...");
+        logger.info("saving device config ...");
 
         await aristaApi({
             host: config.address,
@@ -22,10 +22,10 @@ module.exports = async () => {
             commands: ["enable", "write memory"],
         });
 
-        logger.info("device-save: success");
+        logger.info("success");
 
     } catch (err) {
-        err.message = `device-save: ${err.stack || err.message}`;
+        err.message = `${err.stack || err.message}`;
         logger.error(err.message);
         throw err;
     }
diff --git a/src/modules/arista-switch/container/services/interface-disable.js b/src/modules/arista-switch/container/services/interface-disable.js
@@ -13,7 +13,7 @@ module.exports = async (interfaceId) => {
             throw new Error("failed to load config");
         }
 
-        logger.info(`interface-disable: disabling interface ${interfaceId} ...`);
+        logger.info(`disabling interface ${interfaceId} ...`);
 
         // disable the interface on the device
         await aristaApi({
@@ -25,7 +25,7 @@ module.exports = async (interfaceId) => {
             commands: ["enable", "configure", `interface ${interfaceId}`, "shutdown"],
         });
 
-        logger.info(`interface-disable: success - updating DB`);
+        logger.info(`success - updating DB`);
 
         // update the DB to reflect disabled interface
         const interfacesCollection = await mongoCollection("interfaces");
@@ -34,7 +34,7 @@ module.exports = async (interfaceId) => {
             { $set: { linkStatus: "disabled" } }
         );
 
-        logger.info(`interface-disable: ${JSON.stringify(dbResult.result)}`);
+        logger.info(`${JSON.stringify(dbResult.result)}`);
         await deviceSetPending(false);
         return true;
 
diff --git a/src/modules/arista-switch/container/services/interface-enable.js b/src/modules/arista-switch/container/services/interface-enable.js
@@ -13,7 +13,7 @@ module.exports = async (interfaceId) => {
             throw new Error("failed to load config");
         }
 
-        logger.info(`interface-enable: enabling interface ${interfaceId} ...`);
+        logger.info(`enabling interface ${interfaceId} ...`);
 
         // enable the interface on the device
         await aristaApi({
@@ -25,7 +25,7 @@ module.exports = async (interfaceId) => {
             commands: ["enable", "configure", `interface ${interfaceId}`, "no shutdown"],
         });
 
-        logger.info(`interface-enable: success - updating DB`);
+        logger.info(`success - updating DB`);
 
         // update the DB to reflect enabled interface
         const interfacesCollection = await mongoCollection("interfaces");
@@ -43,7 +43,7 @@ module.exports = async (interfaceId) => {
             { $set: { linkStatus } }
         );
 
-        logger.info(`interface-enable: ${JSON.stringify(dbResult.result)}`);
+        logger.info(`${JSON.stringify(dbResult.result)}`);
         await deviceSetPending(false);
         return true;
 
diff --git a/src/modules/arista-switch/container/services/interface-poe.js b/src/modules/arista-switch/container/services/interface-poe.js
@@ -22,7 +22,7 @@ module.exports = async (interfaceId, action) => {
         }
 
         const actionText = action === "enable" ? "enabling" : "disabling";
-        logger.info(`interface-poe: ${actionText} POE on interface ${interfaceId} ...`);
+        logger.info(`${actionText} POE on interface ${interfaceId} ...`);
 
         await aristaApi({
             host: config.address,
@@ -38,15 +38,15 @@ module.exports = async (interfaceId, action) => {
             ],
         });
 
-        logger.info(`interface-poe: success - updating DB`);
+        logger.info(`success - updating DB`);
 
         const interfacesCollection = await mongoCollection("interfaces");
         const dbResult = await interfacesCollection.updateOne(
             { interfaceId },
             { $set: { "poe.enabled": action === "enable" } }
         );
 
-        logger.info(`interface-poe: ${JSON.stringify(dbResult.result)}`);
+        logger.info(`${JSON.stringify(dbResult.result)}`);
 
         if (dbResult.matchedCount !== 1) {
             throw new Error(`expected to update 1 interface in DB, matched ${dbResult.matchedCount}`);
diff --git a/src/modules/arista-switch/container/services/interface-protect.js b/src/modules/arista-switch/container/services/interface-protect.js
@@ -17,7 +17,7 @@ module.exports = async (interfaceId) => {
             throw new Error(`interface ${interfaceId} already protected`);
         }
 
-        logger.info(`interface-protect: protecting interface ${interfaceId}`);
+        logger.info(`protecting interface ${interfaceId}`);
         config.protectedInterfaces.push(interfaceId);
 
         return await configPutViaCore(config);
diff --git a/src/modules/arista-switch/container/services/interface-rename.js b/src/modules/arista-switch/container/services/interface-rename.js
@@ -13,7 +13,7 @@ module.exports = async (interfaceId, newName) => {
             throw new Error("failed to load config");
         }
 
-        logger.info(`interface-rename: renaming interface ${interfaceId} to '${newName}' ...`);
+        logger.info(`renaming interface ${interfaceId} to '${newName}' ...`);
 
         const descriptionCommand = newName ? `description ${newName}` : "no description";
 
@@ -27,7 +27,7 @@ module.exports = async (interfaceId, newName) => {
             commands: ["enable", "configure", `interface ${interfaceId}`, descriptionCommand],
         });
 
-        logger.info(`interface-rename: success - updating DB`);
+        logger.info(`success - updating DB`);
 
         // update DB
         const interfacesCollection = await mongoCollection("interfaces");
@@ -36,12 +36,12 @@ module.exports = async (interfaceId, newName) => {
             { $set: { description: newName } }
         );
 
-        logger.info(`interface-rename: ${JSON.stringify(dbResult.result)}`);
+        logger.info(`${JSON.stringify(dbResult.result)}`);
         await deviceSetPending(false);
         return true;
 
     } catch (err) {
-        err.message = `interface-rename: ${err.stack || err.message}`;
+        err.message = `${err.stack || err.message}`;
         logger.error(err.message);
         throw err;
     }
diff --git a/src/modules/arista-switch/container/services/interface-setvlanaccess.js b/src/modules/arista-switch/container/services/interface-setvlanaccess.js
@@ -13,7 +13,7 @@ module.exports = async (interfaceId, untaggedVlan = "1") => {
             throw new Error("failed to load config");
         }
 
-        logger.info(`interface-setvlanaccess: setting vlan ${untaggedVlan} on interface ${interfaceId}`);
+        logger.info(`setting vlan ${untaggedVlan} on interface ${interfaceId}`);
 
         const interfaceCollection = await mongoCollection("interfaces");
         const iface = await interfaceCollection.findOne({ interfaceId: interfaceId });
@@ -25,7 +25,7 @@ module.exports = async (interfaceId, untaggedVlan = "1") => {
 
         // if the interface is currently in trunk mode, change it
         if (iface.mode === "trunk") {
-            logger.info(`interface-setvlanaccess: interface ${interfaceId} is in trunk mode, changing to access`);
+            logger.info(`interface ${interfaceId} is in trunk mode, changing to access`);
             commands.push("no switchport trunk native vlan");
             commands.push("switchport mode access");
         }
@@ -42,14 +42,14 @@ module.exports = async (interfaceId, untaggedVlan = "1") => {
             commands: commands,
         });
 
-        logger.info(`interface-setvlanaccess: success - updating DB`);
+        logger.info(`success - updating DB`);
 
         // update db
         const dbResult = await interfaceCollection.updateOne(
             { interfaceId: interfaceId },
             { $set: { mode: "access", accessVlanId: parseInt(untaggedVlan) } }
         );
-        logger.info(`interface-setvlanaccess: ${JSON.stringify(dbResult.result)}`);
+        logger.info(`${JSON.stringify(dbResult.result)}`);
         await deviceSetPending(false);
         return true;
     } catch (error) {
diff --git a/src/modules/arista-switch/container/services/interface-setvlantrunk.js b/src/modules/arista-switch/container/services/interface-setvlantrunk.js
@@ -19,7 +19,7 @@ module.exports = async (interfaceId, untaggedVlan = 1, taggedVlans = []) => {
         if (!iface) {
             throw new Error(`interface ${interfaceId} not found`);
         }
-        logger.info(`interface-setvlantrunk: interface ${interfaceId} found in db`);
+        logger.info(`interface ${interfaceId} found in db`);
 
         // so ... arista uses the word 'ALL' whereas the bug UI controls deliver '1-4094'
         // we need to convert
@@ -36,7 +36,7 @@ module.exports = async (interfaceId, untaggedVlan = 1, taggedVlans = []) => {
             `switchport trunk native vlan ${untaggedVlan}`,
         ];
 
-        logger.info(`interface-setvlantrunk: setting vlan ${untaggedVlan} on interface ${interfaceId}`);
+        logger.info(`setting vlan ${untaggedVlan} on interface ${interfaceId}`);
 
         if (taggedVlans !== "ALL") {
             commands.push(`switchport trunk allowed vlan ${taggedVlans.join(",")}`);
@@ -52,7 +52,7 @@ module.exports = async (interfaceId, untaggedVlan = 1, taggedVlans = []) => {
             commands: commands,
         });
 
-        logger.info(`interface-setvlantrunk: success - updating DB`);
+        logger.info(`success - updating DB`);
 
         // we're going to break out any ranges or 'ALL's into an array of desired vlans
         const dataToSet = {
@@ -63,7 +63,7 @@ module.exports = async (interfaceId, untaggedVlan = 1, taggedVlans = []) => {
         logger.info("dataToSet", dataToSet);
         // update db
         const dbResult = await interfaceCollection.updateOne({ interfaceId: interfaceId }, { $set: dataToSet });
-        logger.info(`interface-setvlantrunk: ${JSON.stringify(dbResult.result)}`);
+        logger.info(`${JSON.stringify(dbResult.result)}`);
         await deviceSetPending(false);
         return true;
     } catch (error) {
diff --git a/src/modules/arista-switch/container/services/interface-unprotect.js b/src/modules/arista-switch/container/services/interface-unprotect.js
@@ -17,7 +17,7 @@ module.exports = async (interfaceId) => {
             throw new Error(`cannot find interface ${interfaceId}`);
         }
 
-        logger.info(`interface-unprotect: unprotecting interface ${interfaceId}`);
+        logger.info(`unprotecting interface ${interfaceId}`);
         config.protectedInterfaces = config.protectedInterfaces.filter(item => item !== interfaceId);
 
         return await configPutViaCore(config);
diff --git a/src/modules/arista-switch/container/services/validate-address.js b/src/modules/arista-switch/container/services/validate-address.js
@@ -8,19 +8,19 @@ module.exports = async (formData) => {
     try {
         const res = await ping.promise.probe(formData?.address);
         if (res?.alive) {
-            logger.info(`validate-ping: device ${formData.address} is reachable`);
+            logger.info(`device ${formData.address} is reachable`);
             return new ValidationResult([
                 { state: true, field: "address", message: "Device is reachable" },
             ]);
         }
 
-        logger.warning(`validate-ping: device ${formData.address} is not reachable`);
+        logger.warning(`device ${formData.address} is not reachable`);
         return new ValidationResult([
             { state: false, field: "address", message: "Device is not reachable" },
         ]);
 
     } catch (err) {
-        logger.error(`validate-ping: error checking address ${formData?.address}: ${err.stack || err.message || err}`);
+        logger.error(`error checking address ${formData?.address}: ${err.stack || err.message || err}`);
         return new ValidationResult([
             { state: false, field: "address", message: "Address is not valid" },
         ]);
diff --git a/src/modules/arista-switch/container/services/validate-auth.js b/src/modules/arista-switch/container/services/validate-auth.js
@@ -15,7 +15,7 @@ module.exports = async (formData) => {
             commands: ["show version"],
         });
 
-        logger.info("validate-auth:", result);
+        logger.info(result);
 
         if (result?.modelName) {
             return new ValidationResult([
diff --git a/src/modules/arista-switch/container/utils/arista-api.js b/src/modules/arista-switch/container/utils/arista-api.js
@@ -1,6 +1,7 @@
 "use strict";
 const axios = require("axios");
 const https = require("https");
+const logger = require("@core/logger")(module);
 
 module.exports = async ({
     protocol = "https",
@@ -26,8 +27,8 @@ module.exports = async ({
     };
 
     if (debug) {
-        console.log("arista-api request body:", jsonBody);
-        console.log("arista-api url:", url);
+        logger.debug("arista-api request body:", jsonBody);
+        logger.debug("arista-api url:", url);
     }
 
     try {
@@ -58,9 +59,9 @@ module.exports = async ({
 
     } catch (err) {
         const msg = getAxiosErrorMessage(err);
-        console.error(`arista-api: ERROR: ${msg}`);
-        console.log("arista-api url:", url);
-        console.log("arista-api request body:", jsonBody);
+        logger.error(`ERROR: ${msg}`);
+        logger.info("arista-api url:", url);
+        logger.info("arista-api request body:", jsonBody);
         throw new Error("arista-api request failed", { cause: err });
     }
 };
diff --git a/src/modules/arista-switch/container/workers/tasks/interfacepoe.js b/src/modules/arista-switch/container/workers/tasks/interfacepoe.js
@@ -9,11 +9,11 @@ module.exports = async ({ mongoCollection, aristaApi, interfacesCollection, work
         // get list of interfaces
         const interfaces = await interfacesCollection.find().toArray();
         if (!interfaces || !interfaces.length) {
-            logger.info("no interfaces found in db - waiting ...");
+            logger.debug("no interfaces found in db - waiting ...");
             return;
         }
 
-        logger.info(`fetching poe details from ${workerData.address} ...`);
+        logger.debug(`fetching poe details from ${workerData.address} ...`);
 
         // get poe details from device
         const result = await aristaApi({
@@ -27,7 +27,7 @@ module.exports = async ({ mongoCollection, aristaApi, interfacesCollection, work
 
         const poePorts = result.find(r => r?.poePorts)?.poePorts;
         if (!poePorts) {
-            logger.info("no poe data returned from device");
+            logger.debug("no poe data returned from device");
             return;
         }
 
@@ -54,13 +54,13 @@ module.exports = async ({ mongoCollection, aristaApi, interfacesCollection, work
         }));
 
         if (!ops.length) {
-            logger.info("no poe updates to write");
+            logger.debug("no poe updates to write");
             return;
         }
 
         // update db
         const bulkResult = await interfacesCollection.bulkWrite(ops);
-        logger.info(`updated db with poe details for ${bulkResult.modifiedCount} interface(s)`);
+        logger.debug(`updated db with poe details for ${bulkResult.modifiedCount} interface(s)`);
 
     } catch (err) {
         logger.error(`failed: ${err.message}`);
diff --git a/src/modules/arista-switch/container/workers/tasks/interfaces.js b/src/modules/arista-switch/container/workers/tasks/interfaces.js
@@ -63,7 +63,7 @@ module.exports = async ({ aristaApi, interfacesCollection, workerData }) => {
             await interfacesCollection.bulkWrite(operations);
         }
 
-        logger.info(`updated db with details for ${operations.length} interface(s)`);
+        logger.debug(`updated db with details for ${operations.length} interface(s)`);
 
     } catch (error) {
         logger.error(error.message);
diff --git a/src/modules/arista-switch/container/workers/tasks/interfacestats.js b/src/modules/arista-switch/container/workers/tasks/interfacestats.js
@@ -96,7 +96,7 @@ module.exports = async ({ aristaApi, interfacesCollection, historyCollection, wo
             interfaceCount += 1;
         }
 
-        logger.info(
+        logger.debug(
             `updated stats for ${interfaceCount} interface(s), pushed ${historyArray.length} stat(s) to interface history`
         );
 
diff --git a/src/modules/arista-switch/container/workers/tasks/interfacestatus.js b/src/modules/arista-switch/container/workers/tasks/interfacestatus.js
@@ -17,7 +17,7 @@ module.exports = async ({ aristaApi, workerData, mongoSingle }) => {
         });
 
         if (!result?.interfaceStatuses) {
-            logger.info("no errdisabled interfaces returned from device");
+            logger.debug("no errdisabled interfaces returned from device");
             await mongoSingle.set("interfacestatuses", [], 60);
             return;
         }
@@ -36,7 +36,7 @@ module.exports = async ({ aristaApi, workerData, mongoSingle }) => {
             });
         }
 
-        logger.info(`found ${interfaceStatuses.length} interface(s) in errdisabled state`);
+        logger.debug(`found ${interfaceStatuses.length} interface(s) in errdisabled state`);
 
         // save to mongo with 60s expiry
         await mongoSingle.set("interfacestatuses", interfaceStatuses, 60);
diff --git a/src/modules/arista-switch/container/workers/tasks/neighbours.js b/src/modules/arista-switch/container/workers/tasks/neighbours.js
@@ -39,7 +39,7 @@ module.exports = async ({ aristaApi, mongoSingle, interfacesCollection, workerDa
             }
         }));
         if (arpOps.length) await interfacesCollection.bulkWrite(arpOps);
-        logger.info(`updated db with arp details for ${arpOps.length} interface(s)`);
+        logger.debug(`updated db with arp details for ${arpOps.length} interface(s)`);
 
         // fetch LLDP neighbors
         const lldpResult = await aristaApi({
@@ -81,7 +81,7 @@ module.exports = async ({ aristaApi, mongoSingle, interfacesCollection, workerDa
             }
         }));
         if (lldpOps.length) await interfacesCollection.bulkWrite(lldpOps);
-        logger.info(`updated db with lldp details for ${lldpOps.length} interface(s)`);
+        logger.debug(`updated db with lldp details for ${lldpOps.length} interface(s)`);
 
 
     } catch (err) {
diff --git a/src/modules/arista-switch/container/workers/tasks/pending.js b/src/modules/arista-switch/container/workers/tasks/pending.js
@@ -26,7 +26,7 @@ module.exports = async ({ aristaApi, mongoSingle, workerData }) => {
             }
         }
 
-        logger.info(`arista-fetchpending: set isPending to ${isPending ? "true" : "false"}`);
+        logger.debug(`arista-fetchpending: set isPending to ${isPending ? "true" : "false"}`);
 
         // save pending status to db
         await mongoSingle.set("pending", isPending, 120);
diff --git a/src/modules/arista-switch/container/workers/tasks/switchports.js b/src/modules/arista-switch/container/workers/tasks/switchports.js
diff --git a/src/modules/arista-switch/container/workers/tasks/system.js b/src/modules/arista-switch/container/workers/tasks/system.js
diff --git a/src/modules/arista-switch/container/workers/tasks/temperature.js b/src/modules/arista-switch/container/workers/tasks/temperature.js
diff --git a/src/modules/arista-switch/container/workers/tasks/vlans.js b/src/modules/arista-switch/container/workers/tasks/vlans.js
diff --git a/src/modules/arista-switch/container/workers/worker-dhcpserver.js b/src/modules/arista-switch/container/workers/worker-dhcpserver.js

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1 @@`
`1`		`-- use bulkwrite in workers to improve db performance`
`2`		`-- remove filename from all log actions......`
`3`	`1`	`- add heartbeat status check and worker task`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ module.exports = async (interfaceId) => {`
`17`	`17`	throw new Error(`interface ${interfaceId} already protected`);
`18`	`18`	`}`
`19`	`19`
`20`		- logger.info(`interface-protect: protecting interface ${interfaceId}`);
	`20`	+ logger.info(`protecting interface ${interfaceId}`);
`21`	`21`	`config.protectedInterfaces.push(interfaceId);`
`22`	`22`
`23`	`23`	`return await configPutViaCore(config);`