Changeset 8123

Timestamp:

Mar 9, 2023, 10:39:30 AM (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 TRACE-level to log entries. They are never added to the log that is kept in memory, but can be written to standard output which can be enabled/disabled.

Location:

branches/3.19-stable

Files:

• src/clients/web/net/sf/basedb/clients/web/extensions/service/ServiceLog.java (modified) (7 diffs)
• src/clients/web/net/sf/basedb/clients/web/extensions/service/ServiceLogger.java (modified) (4 diffs)
• www/admin/services/index.jsp (modified) (1 diff)
• www/admin/services/services.js (modified) (2 diffs)
• www/admin/services/view_log.jsp (modified) (2 diffs)

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

@@ -35 +35 @@
 import org.slf4j.Logger;
 
+import net.sf.basedb.core.DateUtil;
+import net.sf.basedb.util.error.ThrowableUtil;
+
 /**
   Instances hold the log entries for a single extension.
@@ -87 +90 @@
   
   private boolean isDebugEnabled;
+  private boolean copyToStdout;
   
   private ServiceLog(String extensionId)
@@ -118 +122 @@
   {
     this.isDebugEnabled = debugEnabled;
+  }
+  
+  /**
+    Are log entries copied to standard output?
+  */
+  public boolean isCopyingToStdout()
+  {
+    return copyToStdout;
+  }
+  
+  /**
+    Enable or disable copies of log entries to standard output.
+    When enabled, TRACE-level log entries are also written if
+    debugging is enabled.
+  */
+  public void setCopyToStdout(boolean copyToStdout)
+  {
+    this.copyToStdout = copyToStdout;
   }
   
@@ -184 +206 @@
     Add a log entry.
     DEBUG level messages are skipped unless debug-level is enabled.
+    TRACE level messages are always skipped but can be written to
+    standard output if that option and debugging is enabled.
   */
   void add(LogEntry entry)
   {
+    if (copyToStdout && (entry.level != LogLevel.TRACE || isDebugEnabled))
+    {
+      System.out.println("["+extensionId+"] "+entry);
+    }
+    if (entry.level == LogLevel.TRACE || (entry.level == LogLevel.DEBUG && !isDebugEnabled)) 
+    {
+      return;
+    }
     // A read lock should be enough since we are using a ConcurrentLinkedDeque that supports multiple threads
     Lock l = lock.readLock();
@@ -192 +224 @@
     {
       l.lock();
-      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)
       {
@@ -258 +289 @@
         logger.debug(msg, t);
       }
+    },
+    TRACE("trace.png")
+    {
+      @Override
+      void logTo(Logger logger, String msg, Throwable t) 
+      {
+        logger.trace(msg, t);
+      }
     };
     
@@ -335 +374 @@
       return t;
     }
+
+    @Override
+    public String toString() 
+    {
+      String s = "["+level.name()+"] ["+DateUtil.formatTimestamp(getDate())+"] "+message;
+      if (t != null)
+      {
+        s+="\n"+ThrowableUtil.stackTraceToString(t);
+      }
+      return s;
+    }
     
   }

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

@@ -47 +47 @@
   
   /**
-    Check if debug logging has been enabled or not.
+    Check if DEBUG logging has been enabled or not. Debug logging
+    can be enabled either by the {@link ServiceLog#setDebugEnabled(boolean)}
+    method or by a wrapped {@link Logger}.
   */
   public boolean isDebugEnabled()
   {
-    return log.isDebugEnabled();
+    return log.isDebugEnabled() || otherLogger != null && otherLogger.isDebugEnabled();
+  }
+  
+  /**
+    Check if TRACE logging has been enabled or not. Trace logging is enabled
+    only if both DEBUG logging and {@link ServiceLog#isCopyingToStdout()}
+    are enabled or if a wrapped {@link Logger} has it enabled.
+  */
+  public boolean isTraceEnabled()
+  {
+    return (log.isCopyingToStdout() && isDebugEnabled()) || 
+      (otherLogger != null && otherLogger.isTraceEnabled());
   }
   
@@ -133 +146 @@
   
   /**
-    Check if TRACE-level logging has been enabled in the 
-    related SLF4J logger. If no SLF4J logger is related 
-    (see {@link #wrap(org.slf4j.Logger)}) all TRACE messages
-    will be ignored.
-  */
-  public boolean isTraceEnabled()
-  {
-    return otherLogger != null && otherLogger.isTraceEnabled();
-  }
-  /**
     Log a TRACE message with the related SLF4J logger. 
     If no SLF4J logger is related 
@@ -150 +153 @@
   public void trace(String msg)
   {
-    if (otherLogger != null) otherLogger.trace(msg);
+    log(LogLevel.TRACE, msg);
   }
   /**
@@ -160 +163 @@
   public void trace(String msg, Throwable t)
   {
-    if (otherLogger != null) otherLogger.trace(msg, t);
+    log(LogLevel.TRACE, msg, t);
   }
   

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

@@ -74 +74 @@
     redirect = "services.jsp?ID=" + ID;
   }
-  else if ("SetDebug".equals(cmd))
+  else if ("SetOptions".equals(cmd))
   {
     String extensionId = request.getParameter("extensionId");
-    boolean enable = Values.getBoolean(request.getParameter("enable"));
+    boolean enableDebug = Values.getBoolean(request.getParameter("enableDebug"));
+    boolean copyToStdout = Values.getBoolean(request.getParameter("copyToStdout"));
+    boolean autoUpdate = Values.getBoolean(request.getParameter("autoUpdate"));
     ServiceLog serviceLog = ServiceLog.getLog(extensionId, true);
-    if (enable != serviceLog.isDebugEnabled())
+    ServiceLogger logger = serviceLog.createLogger();
+    if (copyToStdout != serviceLog.isCopyingToStdout())
     {
-      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");
+      if (!copyToStdout) logger.info("Stop copy to stdout");
+      serviceLog.setCopyToStdout(copyToStdout);
+      if (copyToStdout) logger.info("Start copy to stdout");
     }
-    redirect = "view_log.jsp?ID="+ID+"&extensionId="+HTML.urlEncode(extensionId);
+    serviceLog.setCopyToStdout(copyToStdout);
+    if (enableDebug != serviceLog.isDebugEnabled())
+    {
+      if (!enableDebug) logger.debug("Debug logging was disabled");
+      serviceLog.setDebugEnabled(enableDebug);
+      if (enableDebug) logger.debug("Debug logging was enabled");
+    }
+    redirect = "view_log.jsp?ID="+ID+"&extensionId="+HTML.urlEncode(extensionId)+"&autoUpdate="+autoUpdate;
   }
   else if ("ClearLog".equals(cmd))

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

@@ -37 +37 @@
       
       Buttons.addClickHandler('btnClearLog', services.clearLog);
-      Events.addEventHandler('enableDebug', 'change', services.toggleDebugLog);
+      Events.addEventHandler('enableDebug', 'change', services.setOptions);
+      Events.addEventHandler('copyToStdout', 'change', services.setOptions);
       
       // Auto-update timer
@@ -106 +107 @@
   }
   
-  services.toggleDebugLog = function()
+  services.setOptions = function()
   {
     var extensionId = Data.get('page-data', 'extension-id');
     var url = 'index.jsp?ID='+App.getSessionId();
-    url += '&cmd=SetDebug';
+    url += '&cmd=SetOptions';
     url += '&extensionId='+extensionId;
-    url += '&enable='+(Doc.element('enableDebug').checked?1:0);
+    url += '&enableDebug='+(Doc.element('enableDebug').checked?1:0);
+    url += '&copyToStdout='+(Doc.element('copyToStdout').checked?1:0);
+    url += '&autoUpdate='+(Doc.element('autoUpdate').checked?1:0);;
     location.replace(url);
   }

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

@@ -93 +93 @@
           />
           <tbl:label style="padding-right: 1em;">
-          <label><input type="checkbox" name="enableDebug" 
-            id="enableDebug" <%=serviceLog.isDebugEnabled()?"checked":""%>
-            >Enable debug logging</label>
+            <label><input type="checkbox" name="enableDebug" 
+              id="enableDebug" <%=serviceLog.isDebugEnabled()?"checked":""%>
+              >Enable debug logging</label>
           </tbl:label>
           <tbl:label style="padding-right: 1em;">
-          <label><input type="checkbox" name="autoUpdate"
-            id="autoUpdate" <%=autoUpdate?"checked":"" %>
-            >Auto update</label>
+            <label title="All log entries are copied to the regular log file (including TRACE-level entries)"
+              ><input type="checkbox" name="copyToStdout" 
+              id="copyToStdout" <%=serviceLog.isCopyingToStdout()?"checked":""%>
+              >Copy to stdout</label>
+          </tbl:label>
+          <tbl:label style="padding-right: 1em;">
+            <label><input type="checkbox" name="autoUpdate"
+              id="autoUpdate" <%=autoUpdate?"checked":"" %>
+              >Auto update</label>
           </tbl:label>
         </tbl:toolbar>
@@ -139 +145 @@
                     style="display: none;"
                   ><%=ThrowableUtil.stackTraceToString(stacktrace)%></div>
-                
                 <%
               }