cisco-perfmon 1.4.2 → 1.4.4

package/main.js

@@ -85,17 +85,6 @@ var XML_REMOVE_COUNTER_ENVELOPE = `<soapenv:Envelope xmlns:soapenv="http://schem
 </soapenv:Body>
 </soapenv:Envelope>`;
 
-// Set up our promise results
-var promiseResults = {
-  cookie: "",
-  results: "",
-};
-
-// Set up our error results
-var errorResults = {
-  message: "",
-};
-
 /**
  * Cisco Perfmon Service
  * This is a service class that uses fetch and promises to pull Perfmon data from Cisco CUCM
@@ -111,9 +100,20 @@ var errorResults = {
 class perfMonService {
   constructor(host, username, password, options) {
     this._OPTIONS = {
-      retries: process.env.PERFMON_RETRIES ? parseInt(process.env.PERFMON_RETRIES) : 3,
-      retryDelay: process.env.PERFMON_RETRY_DELAY ? parseInt(process.env.PERFMON_RETRY_DELAY) : 1000,
-      retryOn: [503],
+      retryOn: function (attempt, error, response) {
+        // Only allow retries on JSESSIONIDSSO authenticaion attempts
+        if (!options) {
+          return false;
+        } else if (attempt > (process.env.PERFMON_RETRIES ? parseInt(process.env.PERFMON_RETRIES) : 3)) {
+          return false;
+        }
+        // retry on any network error, or 4xx or 5xx status codes
+        if (error !== null || response.status >= 400) {
+          const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+          delay(process.env.PERFMON_RETRY_DELAY ? parseInt(process.env.PERFMON_RETRY_DELAY) : 1000);
+          return true;
+        }
+      },
       method: "POST",
       headers: {
         Authorization: "Basic " + Buffer.from(username + ":" + password).toString("base64"),
@@ -159,6 +159,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
@@ -273,6 +283,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
@@ -370,7 +390,7 @@ class perfMonService {
    * @param {string} host - The host to collect data from.
    * @returns {object} returns JSON via a Promise. JSON contains Session Cookie (If availible) and Results.
    */
-  listCounter(host,filtered = []) {
+  listCounter(host, filtered = []) {
     var XML;
     var options = this._OPTIONS;
     options.SOAPAction = `perfmonListCounter`;
@@ -386,6 +406,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
@@ -404,7 +434,7 @@ class perfMonService {
                 var returnResults = output.Body.perfmonListCounterResponse.perfmonListCounterReturn;
                 promiseResults.results = clean(returnResults);
                 if (filtered.length > 0) {
-                  var res = promiseResults.results.filter(item => filtered.includes(item.Name));
+                  var res = promiseResults.results.filter((item) => filtered.includes(item.Name));
                   promiseResults.results = res;
                 }
                 resolve(promiseResults);
@@ -470,6 +500,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
@@ -554,6 +594,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
@@ -632,6 +682,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream
@@ -702,11 +762,11 @@ class perfMonService {
     var options = this._OPTIONS;
     options.SOAPAction = `perfmonAddCounter`;
     var server = this._HOST;
-
+    // var counterStr = "<soap:Counter>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Counter>";
     if (Array.isArray(counter)) {
-      counter.forEach((item) => (counterStr += "<soap:Counter>" + "<soap:Name>" + "\\\\" + item.host + "\\" + item.object + "\\" + item.counter + "</soap:Name>" + "</soap:Counter>"));
+      counter.forEach((counter) => (counterStr += "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>"));
     } else {
-      counterStr = "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + counter.object + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>";
+      counterStr = "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>";
     }
 
     XML = util.format(XML_ADD_COUNTER_ENVELOPE, sessionHandle, counterStr);
@@ -719,6 +779,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             // response.body is a ReadableStream
             const reader = response.body.getReader();
@@ -790,9 +860,9 @@ class perfMonService {
     var server = this._HOST;
 
     if (Array.isArray(counter)) {
-      counter.forEach((item) => (counterStr += "<soap:Counter>" + "<soap:Name>" + "\\\\" + item.host + "\\" + item.object + "\\" + item.counter + "</soap:Name>" + "</soap:Counter>"));
+      counter.forEach((counter) => (counterStr += "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>"));
     } else {
-      counterStr = "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + counter.object + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>";
+      counterStr = "<soap:Counter>" + "<soap:Name>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Name>" + "</soap:Counter>";
     }
 
     XML = util.format(XML_REMOVE_COUNTER_ENVELOPE, sessionHandle, counterStr);
@@ -805,6 +875,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             // response.body is a ReadableStream
             const reader = response.body.getReader();
@@ -873,7 +953,7 @@ class perfMonService {
     options.SOAPAction = `perfmonQueryCounterDescription`;
     var server = this._HOST;
 
-    var counterStr = "<soap:Counter>" + "\\\\" + counter.host + "\\" + counter.object + "\\" + counter.counter + "</soap:Counter>";
+    var counterStr = "<soap:Counter>" + "\\\\" + counter.host + "\\" + (counter.instance ? `${counter.object}(${counter.instance})` : counter.object) + "\\" + counter.counter + "</soap:Counter>";
 
     XML = util.format(XML_QUERY_COUNTER_ENVELOPE, counterStr);
 
@@ -885,6 +965,16 @@ class perfMonService {
       fetch(`https://${server}:8443/perfmonservice2/services/PerfmonService/`, options)
         .then(async (response) => {
           try {
+            // Set up our promise results
+            var promiseResults = {
+              cookie: "",
+              results: "",
+            };
+
+            // Set up our error results
+            var errorResults = {
+              message: "",
+            };
             var data = []; // create an array to save chunked data from server
             promiseResults.cookie = response.headers.get("set-cookie") ? response.headers.get("set-cookie") : "";
             // response.body is a ReadableStream

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cisco-perfmon",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "description": "A library to pull Perfmon data from Cisco VOS applications via SOAP",
   "main": "main.js",
   "scripts": {

package/test/tests.js

@@ -28,17 +28,18 @@ var cucmServerName = env.CUCM_SERVER_NAME;
 
 // Variables to hold our SessionID and our Session Counter
 var SessionID;
-var counterObj = {
+var counterObject = "Cisco CallManager";
+var sessionObj = {
   host: cucmServerName,
-  object: "Memory",
-  counter: "% Mem Used",
+  object: 'Partition',
+  instance: 'SharedMemory',
+  counter: 'Write Bytes Per Sec',
 };
 
-
 (async () => {
   console.log("Let's get a description of our counter. We will also retrieve a cookie to use for the rest of the session.");
   await service
-    .queryCounterDescription(counterObj)
+    .queryCounterDescription(sessionObj)
     .then((response) => {
       console.log("queryCounterDescription: ", response.results);
       if (response.cookie) {
@@ -51,9 +52,9 @@ var counterObj = {
 
   console.log("Let's collect some non session counter data.");
   await service
-    .collectCounterData(cucmServerName, "Cisco CallManager")
+    .collectCounterData(cucmServerName, counterObject)
     .then((response) => {
-      console.log("collectCounterData", response.results);
+      console.log("collectCounterData", response);
     })
     .catch((error) => {
       console.log(error.message);
@@ -66,7 +67,7 @@ var counterObj = {
       console.log("SessionID", response.results);
       SessionID = response.results;
       await service
-        .addCounter(SessionID, counterObj)
+        .addCounter(SessionID, sessionObj)
         .then(async (response) => {
           console.log("addCounter", response.results);
           const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));