un-cli 0.0.59 → 0.0.62

package/adminlog.mjs

@@ -13,10 +13,10 @@ export class AdminLog {
         this.token = token;         
     }
 
-    query (codes, serviceName ="*", pageSize = 100000, startTime = null, endTime = null) 
+    query (codes, serviceName ="*", pageSize = 100000, startTime = null, endTime = null, logLevel = "DEBUG") 
     {   
         const url =  this.adminServerUrl  + "/logs/query?f=pjson"
-        const level = "DEBUG"
+        const level =  logLevel
         const filterType="json"
         const token = this.token
         const filter = {

package/cmd.txt

@@ -1 +1 @@
-arlogs --byrule
+tracelogs --m 300

package/index.mjs

@@ -7,13 +7,10 @@ import { AdminLog } from "./adminlog.mjs"
 import { logger } from "./logger.mjs"
 import  fetch  from "node-fetch"
 //update version
-let version = "0.0.59";
+let version = "0.0.62";
 const GENERATE_TOKEN_TIME_MIN = 30;
 
 let rl = null;
-
-
-//uncli --portal https://utilitynetwork.esri.com/portal --service AllStar_oracle --user unadmin --password unadmin.108
 let portal = null;
 let un  = null;
 let adminLog = null;
@@ -29,9 +26,11 @@ function parseInput(){
           "--command",
           "--gdbversion",
           "--file",
-          "--verify"
+          "--verify",
+          "--server"
            ]     
-
+        
+      //null marked parmaters are required
       const params = {
           "portal": null,
           "service": null,
@@ -40,7 +39,8 @@ function parseInput(){
           "command": "",
           "gdbversion": "SDE.DEFAULT",
           "file": "",
-          "verify": "true"
+          "verify": "true",
+          "server": undefined
       }
 
       for (let i = 0; i < process.argv.length ; i++){
@@ -53,9 +53,10 @@ function parseInput(){
 
       if (Object.values(params).includes(null))
       {
-        console.log ("HELP: uncli --portal https://unportal.domain.com/portal --service servicename --user username --password password [--gdbversion* user.version --file commandfile* --verify true|false]")    
+        console.log ("HELP: uncli --portal https://unportal.domain.com/portal --service servicename --user username --password password [--gdbversion* user.version --server  https://federatedserver.domain.com/server --file commandfile* --verify true|false]")    
         console.log("--file commandfile is optional and you can pass a path to a file with a list of command to execute. ")
         console.log("--gdbversion is optional and allows the UN to be opened in that version. When not specified sde.DEFAULT is used.")
+        console.log("--server is optional except when there are more than one federated server sites to the portal. If the portal only has one server it will be selected.")
         process.exit();
       }
      
@@ -64,7 +65,7 @@ function parseInput(){
 
 //
 async function getToken(parameters) {
-    portal = new Portal(parameters.portal, parameters.user, parameters.password)
+    portal = new Portal(parameters.portal, parameters.user, parameters.password,300, parameters.server)
     logger.info("About to connect..")
     const token = await portal.connect()
     logger.info(`Token generanted successfully.`)
@@ -177,8 +178,9 @@ const inputs = {
             "count": "Lists the number of rows in all feature layers.",
             "count --system": "Lists the number of rows in system layers.",
             "connect --service": "Connects to the another service",
+            "tracelogs --m <minutes>": "Lists utility network trace summary logs for the last x minutes (requires admin)",
             "arlogs": "Lists attribute rules execution logs (requires admin)",
-            "arlogs --byrule": "Lists attribute rules execution summary by rule (requires admin)",
+            "arlogs --byrule [--minguid --maxguid]": "Lists attribute rules execution summary by rule (requires admin), --maxguid and --minguid show the GUID of the feature",
             "whoami": "Lists the current login info",
             "clear": "Clears this screen",
             "quit": "Exit this program"
@@ -713,7 +715,48 @@ const inputs = {
     },
 
 
-    "^arlogs --byrule$": async () => {
+
+    
+    "^tracelogs --m": async input => {
+        const topLogCount = 1000;
+        const pageSize = 10000
+
+        const inputParam = input.match(/--m .*/gm)
+        let mins = 30;  //query logs for the last 30 minutes
+        if (inputParam != null && inputParam.length > 0)
+            mins = inputParam[0].replace("--m ", "")
+ 
+        console.log(`Querying trace logs for ${parameters.service} for the last ${mins} minutes ...`)
+        const startTime = Date.now() - mins*60*1000
+        const endTime = Date.now();
+        let result= await adminLog.query([102002], [parameters.service+ ".MapServer"], topLogCount, startTime ,endTime , "VERBOSE")
+        let jsonRes = await result.json()
+        let allMessages = [].concat(jsonRes.logMessages)
+        
+        while (jsonRes.hasMore && allMessages.filter(m => m.message.indexOf(" Environment -") > -1).length < topLogCount )
+        {  
+            //start paging
+            logger.info(`Aggregating messages... total so far ${allMessages.length} debug entries but more left, pulling logs before ${new Date(jsonRes.endTime)}`)
+            result= await adminLog.query([102002], [parameters.service + ".MapServer"], pageSize, jsonRes.endTime)
+            jsonRes = await result.json()
+            allMessages = allMessages.concat(jsonRes.logMessages)
+        }  
+
+        allMessages.forEach(m => console.log(m.message))
+         
+    },
+    "^arlogs --byrule": async input => {
+        //--minguid to show min guid
+        //--maxguid to show max guid
+        const inputParam = input.match(/--byrule .*/gm)
+        let showMaxGuid = false
+        let showMinGuid = false
+        if (inputParam != null && inputParam.length > 0 && inputParam[0].indexOf("--maxguid") > -1)
+            showMaxGuid = true
+
+        if (inputParam != null && inputParam.length > 0 && inputParam[0].indexOf("--minguid") > -1)
+            showMinGuid = true
+
         const pageSize = 10000 //maximum messages per page
         logger.info(`Querying attribute rules logs for ${parameters.service} ...`)
         let result= await adminLog.query([102003], [parameters.service + ".MapServer"], pageSize)
@@ -748,13 +791,31 @@ const inputs = {
                    { 
                        prev [cur["Rule name"]] =  {
                            "totalTime": 0,
-                           "occurrence": 0
+                           "occurrence": 0,
+                           "minTime":  Number.MAX_SAFE_INTEGER,
+                           "maxTime": -1,
+                           "avgTime": 0,
+                           "maxGuid": null,
+                           "minGuid": null
                        };
                      }
                 
                      prev [cur["Rule name"]].totalTime = prev [cur["Rule name"]].totalTime + cur["Elapsed Time (ms)"]
-                     prev [cur["Rule name"]].occurrence++
- 
+                      
+                     if (cur["Elapsed Time (ms)"] < prev [cur["Rule name"]].minTime ) {
+                        prev [cur["Rule name"]].minTime = cur["Elapsed Time (ms)"];
+                        prev [cur["Rule name"]].minGuid = cur["GlobalID"];
+                     }
+
+                    if (cur["Elapsed Time (ms)"] > prev [cur["Rule name"]].maxTime ){
+                        prev [cur["Rule name"]].maxTime = cur["Elapsed Time (ms)"];
+                        prev [cur["Rule name"]].maxGuid = cur["GlobalID"];
+                    }
+                     
+                    prev [cur["Rule name"]].occurrence++
+                     
+                    prev [cur["Rule name"]].avgTime = prev [cur["Rule name"]].totalTime / prev [cur["Rule name"]].occurrence
+
                 return prev
             }, {})
 
@@ -763,19 +824,26 @@ const inputs = {
                 const rule = {}
                 rule["Attribute Rule"] = a;
                 rule["Total Cost (ms)"] = parseFloat(arMessages[a].totalTime.toFixed(2))
-                rule["Occurrence"] = arMessages[a].occurrence;
+                if (!showMinGuid && !showMaxGuid) rule["Average Cost (ms)"] = parseFloat(arMessages[a].avgTime.toFixed(2))
+                rule["Max execution time (ms)"] = parseFloat(arMessages[a].maxTime.toFixed(2))
+                if (showMaxGuid) rule["Max GUID"] = arMessages[a].maxGuid
+                rule["Min execution time (ms)"] = parseFloat(arMessages[a].minTime.toFixed(2))
+                if (showMinGuid) rule["Min GUID"] = arMessages[a].minGuid
+                if (!showMinGuid && !showMaxGuid) rule["Occurrence"] = arMessages[a].occurrence;
                 return rule;
         })
         .sort( (m1, m2) => m2["Total Cost (ms)"] -m1["Total Cost (ms)"])
         console.table(rules)
-       
+
+        const totalARExecution = rules.reduce( (prev, cur) =>  prev + cur["Total Cost (ms)"], 0)
+        console.log(`Total time spend executing attribute rules (${Math.round(totalARExecution)} ms) (${Math.round(totalARExecution/1000)} s) (${Math.round(totalARExecution/(1000*60))} m)`)
          
     },
 
     "^version$": () => console.log(version),
     "^clear$|^cls$": () => console.clear(),
     "^quit$": () => {
-        rl.close();
+        if (rl) rl.close();
         process.exit();
     },
     "^exit$|^quit$|^bye$": () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "un-cli",
-  "version": "0.0.59",
+  "version": "0.0.62",
   "description": "Command line interface for working with ArcGIS Utility Network Extension",
   "main": "index.mjs",
   "bin": {

package/portal.mjs

@@ -3,13 +3,13 @@ import { logger } from "./logger.mjs"
 
 export class Portal{
         
-    constructor(url, username, password, expiration = 300)
+    constructor(url, username, password, expiration = 300, serverUrl = undefined)
     {
         this.url = url;
         this.username = username;
         this.password = password;
         this.expiration = expiration;
-        this.serverUrl = "bad";
+        this.serverUrl = serverUrl;
     }
 
 
@@ -20,7 +20,6 @@ export class Portal{
         
                 try { 
 
-                    //https://utilitynetwork.esri.com/portal/sharing/rest/portals/self/servers?f=json
                     const tokenUrl = self.url + "/sharing/rest/generateToken";
                    
                     const postJson = {
@@ -44,9 +43,9 @@ export class Portal{
                   
             }
             catch(ex){
-                logger.error(ex.status.message)
-                console.error(ex.status.errno)
-                reject(`Failed to connect to portal, check your username or password or add --verify false if you are using a self-signed certificate. Normally a production system should have a valid certificate signed by a CA and you should NOT disable verification in that case.)`)
+                logger.error(ex?.status?.message)
+                console.error(ex?.status?.errno)
+                reject(`Failed to connect to portal, check your username or password or add --verify false if you are using a self-signed certificate. Normally a production system should have a valid certificate signed by a CA and you should NOT disable verification in that case.) \n\n${ex}`)
             }
 
             }
@@ -55,32 +54,54 @@ export class Portal{
     }
  
     async updateServices () {
+        const self = this;
+        return new Promise( async (resolve, reject) => {
+            //if the user specified a serverUrl no need to do anything
+            if (self.serverUrl !== undefined) {
+                logger.info(`Using server ${self.serverUrl} supplied in the --server parameter`)
+                resolve(self.serverUrl);
+                return;
+            }
 
-        try {
+            //else we need to calculate it
+            try {
 
-            const postJsonServers= {
-                f: "json",
-                token: this.token
+                const postJsonServers= {
+                    f: "json",
+                    token: self.token
+                }
+        
+                const serversUrl =  self.url + "/sharing/rest/portals/self/servers"
+                logger.info( "About to query federated servers");
+                    
+                //query for federated servers.
+                const servers = await makeRequest({method: 'POST', url: serversUrl, params: postJsonServers });
+                
+                //if we don't have any federated servers quit.
+                if (servers.servers.length === 0) 
+                    {
+                        reject( "No federeated servers");
+                    return
+                }
+                
+                //if we have more than one then we let the user pick.
+                if (servers.servers.length > 1){
+                    let serverUrls = "";
+                    servers.servers.forEach(s => serverUrls += '\n  * ' + s.url + '\n' ) 
+                    reject("more than one federated server found, run the command with --server and specify one of the servers below\n" + serverUrls)
+                }
+                this.serverUrl = servers.servers[0].url;
+                resolve(self.serverUrl)
+                logger.info(`Found one federate server, using server url ${self.serverUrl} by default`)
             }
-    
-            const serversUrl =  this.url + "/sharing/rest/portals/self/servers"
-            logger.info( "About to query federated servers");
-                  
-            //query for federated servers.
-            const servers = await makeRequest({method: 'POST', url: serversUrl, params: postJsonServers });
-            
-            //get the first one
-            if (servers.servers.length === 0) 
-                reject( "No federeated servers");
-    
-            this.serverUrl = servers.servers[0].url;
-            logger.info(`Found server url ${this.serverUrl}`)
-        }
-       catch(ex){
-           logger.error(ex)
-       }
+        catch(ex){
+            logger.error(ex)
+            reject(ex)
+            }       
+         });
+
+    } 
 
-    }
     //get the feature service definition 
     async serviceDef(serviceName) {
         this.token = this.token;