Changeset 8119

Timestamp:

Mar 6, 2023, 2:17:35 PM (7 months ago)

Author:

Nicklas Nordborg

Message:

References #2295: Add API for services to send log messages that can be displayed by the web client

Added a web interface for viewing the log.

Location:

branches/3.19-stable

Files:

• src/clients/web/net/sf/basedb/clients/web/extensions/service/ServiceLog.java (modified) (8 diffs)
• www/admin/services/index.jsp (modified) (2 diffs)
• www/admin/services/services.js (modified) (3 diffs)
• www/admin/services/services.jsp (modified) (4 diffs)
• www/admin/services/view_log.jsp (added)
• www/images/service_log.png (added)
• www/images/service_log_error.png (added)
• www/images/service_log_warning.png (added)

branches/3.19-stable/src/clients/web/net/sf/basedb/clients/web/extensions/service/ServiceLog.java

@@ -22 +22 @@
 package net.sf.basedb.clients.web.extensions.service;
 
+import java.util.Date;
+import java.util.Deque;
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.Map;
+import java.util.concurrent.ConcurrentLinkedDeque;
+
+import org.apache.commons.collections4.iterators.UnmodifiableIterator;
 
 /**
@@ -68 +74 @@
   
   private final String extensionId;
+  private final Deque<LogEntry> logEntries;
+  
+  private int maxEntries;
+  private volatile int numEntries;
+  private volatile int numWarnings;
+  private volatile int numErrors;
+  
   private boolean isDebugEnabled;
   
@@ -73 +86 @@
   {
     this.extensionId = extensionId;
+    this.logEntries = new ConcurrentLinkedDeque<>();
+    this.maxEntries = 200;
   }
   
@@ -83 +98 @@
   }
   
+  /**
+    Is the debug-level enabled?
+  */
   public boolean isDebugEnabled()
   {
@@ -89 +107 @@
   
   /**
+    Enable or disable debug-level logging.
+  */
+  public void setDebugEnabled(boolean debugEnabled)
+  {
+    this.isDebugEnabled = debugEnabled;
+  }
+  
+  /**
+    Get the max number of entries to keep in the log.
+  */
+  public int getMaxEntries()
+  {
+    return maxEntries;
+  }
+  
+  /**
+    Get the current number of entries in the log.
+  */
+  public int getNumEntries()
+  {
+    return numEntries;
+  }
+  
+  /**
+    Get the current number of warning entries in the log.
+  */
+  public int getNumWarnings()
+  {
+    return numWarnings;
+  }
+  
+  /**
+    Get the current number of error entries in the log.
+  */
+  public int getNumErrors()
+  {
+    return numErrors;
+  }
+  
+  /**
     Create a logger that adds messages to this log.
   */
@@ -96 +154 @@
   }
 
+  /**
+    Add a log entry.
+    DEBUG level messages are skipped unless debug-level is enabled.
+  */
   void add(LogEntry entry)
   {
-    // TODO 
-    System.out.println(extensionId+" [" + entry.level.name()+"]: "+entry.msg);
-    if (entry.t != null)
-    {
-      entry.t.printStackTrace(System.out);
-    }
+    if (entry.level == LogLevel.DEBUG && !isDebugEnabled) return; // 
+    logEntries.addFirst(entry);
+    if (entry.level == LogLevel.WARNING) numWarnings++;
+    if (entry.level == LogLevel.ERROR) numErrors++;
+
+    if (numEntries++ > maxEntries)
+    {
+      // Remove one entry
+      numEntries--;
+      LogEntry last = logEntries.removeLast();
+      if (last.level == LogLevel.WARNING) numWarnings--;
+      if (last.level == LogLevel.ERROR) numErrors--;
+    }
+  }
+  
+  /**
+    Get an iterator that is returning all entries in the log.
+    The returned iterator is read-only and the {@link Iterator#remove()} 
+    method will throw an exception.
+  */
+  public Iterator<LogEntry> getLogEntries()
+  {
+    return UnmodifiableIterator.unmodifiableIterator(logEntries.iterator());
   }
   
@@ -111 +190 @@
   public enum LogLevel
   {
-    INFO,
-    WARNING,
-    ERROR,
-    DEBUG
+    INFO("info.png"),
+    WARNING("warning.png"),
+    ERROR("error.png"),
+    DEBUG("bug.png");
+    
+    private final String icon;
+    
+    private LogLevel(String icon)
+    {
+      this.icon = icon;
+    }
+    
+    /**
+      Get the icon that represents this log level.
+    */
+    public String getIcon()
+    {
+      return icon;
+    }
   }
   
@@ -124 +218 @@
     private final long timestamp;
     private final LogLevel level;
-    private final String msg;
+    private final String message;
     private final Throwable t;
     
-    LogEntry(LogLevel level, String msg, Throwable t)
+    LogEntry(LogLevel level, String message, Throwable t)
     {
       this.timestamp = System.currentTimeMillis();
       this.level = level;
-      this.msg = msg;
+      this.message = message;
       this.t = t;
     }
+    
+    /**
+      The level of the log entry.
+    */
+    public LogLevel getLevel()
+    {
+      return level;
+    }
+    
+    /**
+      The timestamp of the log entry.
+    */
+    public long getTimestamp()
+    {
+      return timestamp;
+    }
+    
+    /**
+      The timestamp of the log entry as a date.
+    */
+    public Date getDate()
+    {
+      return new Date(timestamp);
+    }
+    
+    /**
+      Get the log message.
+    */
+    public String getMessage()
+    {
+      return message;
+    }
+    
+    /**
+      Get the stacktrace of the log entry.
+    */
+    public Throwable getStacktrace()
+    {
+      return t;
+    }
+    
   }
 

branches/3.19-stable/www/admin/services/index.jsp

@@ -34 +34 @@
   import="net.sf.basedb.util.extensions.Extension"
   import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
+  import="net.sf.basedb.clients.web.extensions.service.ServiceLogger"
+  import="net.sf.basedb.clients.web.extensions.service.ServiceLog.LogLevel"
+  import="net.sf.basedb.clients.web.extensions.service.ServiceLog"
   import="java.util.List"
 %>
@@ -71 +74 @@
     redirect = "services.jsp?ID=" + ID;
   }
+  else if ("SetDebug".equals(cmd))
+  {
+    String extensionId = request.getParameter("extensionId");
+    boolean enable = Values.getBoolean(request.getParameter("enable"));
+    ServiceLog serviceLog = ServiceLog.getLog(extensionId, true);
+    if (enable != serviceLog.isDebugEnabled())
+    {
+      ServiceLogger logger = serviceLog.createLogger();
+      if (!enable) logger.log(LogLevel.DEBUG, "Debug logging was disabled");
+      serviceLog.setDebugEnabled(enable);
+      if (enable) logger.log(LogLevel.DEBUG, "Debug logging was enabled");
+    }
+    redirect = "view_log.jsp?ID="+ID+"&extensionId="+HTML.urlEncode(extensionId);
+  }
   else
   {

branches/3.19-stable/www/admin/services/services.js

@@ -28 +28 @@
   var services = {};
   
+  services.initPage = function()
+  {
+    var pageId = Doc.getPageId();   
+    if (pageId == 'view-page')
+    {
+      // Close button
+      Buttons.addClickHandler('close', App.closeWindow);
+      
+      Events.addEventHandler('enableDebug', 'change', services.toggleDebugLog);
+      
+      // Auto-update timer
+      setInterval(services.autoUpdate, 2000);
+    }
+    else if (pageId == 'list-page')
+    {
+      // Nothing here yet
+    }
+  }
+  
   services.initElements = function(element, autoInit)
   {
@@ -37 +56 @@
     {
       Buttons.addClickHandler(element, services.toggleStacktrace);
+    }
+    else if (autoInit == 'view-log')
+    {
+      Buttons.addClickHandler(element, services.viewLog);
     }
   }
@@ -55 +78 @@
   }
   
+  services.viewLog = function(event)
+  {
+    var extensionId = Data.get(event.currentTarget, 'extension-id');
+    var url = 'view_log.jsp?ID='+App.getSessionId();
+    url += '&extensionId='+extensionId;
+    Dialogs.openPopup(url, 'ViewLog', 1000, 600);
+  }
+  
+  services.toggleDebugLog = function()
+  {
+    var extensionId = Data.get('page-data', 'extension-id');
+    var url = 'index.jsp?ID='+App.getSessionId();
+    url += '&cmd=SetDebug';
+    url += '&extensionId='+extensionId;
+    url += '&enable='+(Doc.element('enableDebug').checked?1:0);
+    location.replace(url);
+  }
+  
+  services.autoUpdate = function()
+  {
+    if (Doc.element('autoUpdate').checked)
+    {
+      var extensionId = Data.get('page-data', 'extension-id');
+      var url = 'view_log.jsp?ID='+App.getSessionId();
+      url += '&extensionId='+extensionId;
+      url += '&autoUpdate=1';
+      location.replace(url);
+    }
+  }
+  
   return services;
 }();
 
 Doc.addElementInitializer(Services.initElements);
+Doc.onLoad(Services.initPage);

branches/3.19-stable/www/admin/services/services.jsp

@@ -15 +15 @@
   import="net.sf.basedb.clients.web.extensions.service.ServiceControllerAction"
   import="net.sf.basedb.clients.web.extensions.service.Services"
+  import="net.sf.basedb.clients.web.extensions.service.ServiceLog"
   import="java.util.Iterator"
 %>
@@ -40 +41 @@
 {
   %>
-  <base:page title="Manage Services">
+  <base:page title="Manage Services" id="list-page">
   <base:head scripts="table.js,~services.js" styles="table.css">
     <ext:scripts context="<%=jspContext %>" />
@@ -86 +87 @@
           boolean isNewExtension = ext != last;
           last = ext;
+          ServiceLog serviceLog = ServiceLog.getLog(ext.getId(), false);
+          String serviceLogSummary = "";
+          String serviceLogIcon = "service_log.png";
+          if (serviceLog != null)
+          {
+            serviceLogSummary = "View the log for this service; "+
+              serviceLog.getNumEntries() +" entries; " + 
+              serviceLog.getNumErrors()+" errors; "+
+              serviceLog.getNumWarnings()+" warnings";
+            if (serviceLog.getNumErrors() > 0)
+            {
+              serviceLogIcon = "service_log_error.png";
+            }
+            else if (serviceLog.getNumWarnings() > 0)
+            {
+              serviceLogIcon = "service_log_warning.png";
+            }
+          }
           boolean isRunning = false;
           Throwable error = null;
@@ -177 +196 @@
                 }
                 %>
+                <base:icon
+                  id="<%="log."+ext.getId()%>"
+                  subclass="auto-init"
+                  data-auto-init="view-log"
+                  data-extension-id="<%=ext.getId()%>"
+                  image="<%=serviceLogIcon%>" 
+                  tooltip="<%=serviceLogSummary%>"
+                  visible="<%=serviceLog != null%>"
+                />
                 <ext:render extensions="<%=actionsInvoker%>" context="<%=jspContext%>" item="<%=action%>" />
                 <%