Item 7554: part 2 of log4jupgrade

api/build.gradle

@@ -61,11 +61,11 @@ List caching = [
         "net.sf.ehcache:ehcache-core:${ehcacheCoreVersion}"
 ]
 
-// TODO : log4j - change it to use log4j2version
+// TODO : log4j - change it to use log4j2version before final merge
 List logging = [
         "org.apache.logging.log4j:log4j-core:2.13.3",
         "org.apache.logging.log4j:log4j-api:2.13.3",
-        "org.apache.logging.log4j:log4j-1.2-api:2.13.3"
+//        "org.apache.logging.log4j:log4j-1.2-api:2.13.3"
 ]
 
 List r = [

api/src/org/labkey/api/data/ConnectionWrapper.java

@@ -22,6 +22,7 @@
 import org.apache.logging.log4j.core.config.LoggerConfig;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.labkey.api.util.LoggerWriter;
 import org.labkey.api.data.DbScope.ConnectionType;
 import org.labkey.api.data.dialect.SqlDialect;
 import org.labkey.api.data.dialect.StatementWrapper;
@@ -30,6 +31,7 @@
 import org.labkey.api.util.DateUtil;
 import org.labkey.api.util.MemTracker;
 import org.labkey.api.util.Pair;
+import org.labkey.api.util.SimpleLoggerWriter;
 import org.labkey.api.view.ViewServlet;
 
 import java.lang.reflect.Method;
@@ -152,27 +154,39 @@ public static boolean dumpOpenConnections()
         return dumpOpenConnections(_logDefault);
     }
 
-    public static boolean dumpOpenConnections(@NotNull Logger log)
+    public static boolean dumpOpenConnections(@NotNull LoggerWriter logWriter)
     {
         synchronized (_openConnections)
         {
             for (Pair<Thread, Throwable> p : _openConnections.values())
             {
                 String thread = p.first.getName();
                 Throwable t = p.second;
-                log.debug("Connection opened on thread: " + thread, t);
+                logWriter.debug("Connection opened on thread: " + thread, t);
             }
         }
 
         return true;
     }
 
+    public static boolean dumpOpenConnections(@NotNull Logger log)
+    {
+        dumpOpenConnections(new SimpleLoggerWriter(log));
+
+        return true;
+    }
+
     public static boolean dumpLeaksForThread(Thread t)
     {
         return dumpLeaksForThread(t, _logDefault);
     }
 
     public static boolean dumpLeaksForThread(Thread t, Logger log)
+    {
+        return dumpOpenConnections(new SimpleLoggerWriter(log));
+    }
+
+    public static boolean dumpLeaksForThread(Thread t, LoggerWriter log)
     {
         boolean leaks = false;
         synchronized(_openConnections)

api/src/org/labkey/api/data/DbScope.java

@@ -41,7 +41,9 @@
 import org.labkey.api.test.TestWhen;
 import org.labkey.api.util.ConfigurationException;
 import org.labkey.api.util.GUID;
+import org.labkey.api.util.LoggerWriter;
 import org.labkey.api.util.MemTracker;
+import org.labkey.api.util.SimpleLoggerWriter;
 import org.labkey.api.util.TestContext;
 import org.labkey.api.util.UnexpectedException;
 import org.labkey.data.xml.TablesDocument;
@@ -978,7 +980,7 @@ public void logCurrentConnectionState()
         logCurrentConnectionState(LOG);
     }
 
-    public void logCurrentConnectionState(@NotNull Logger log)
+    public void logCurrentConnectionState(LoggerWriter log)
     {
         synchronized (_transaction)
         {
@@ -1015,6 +1017,12 @@ public void logCurrentConnectionState(@NotNull Logger log)
         }
     }
 
+    public void logCurrentConnectionState(@NotNull Logger log)
+    {
+        logCurrentConnectionState(new SimpleLoggerWriter(log));
+    }
+
+
     private static final int spidUnknown = -1;
 
     protected ConnectionWrapper getPooledConnection(ConnectionType type, @Nullable Logger log) throws SQLException

api/src/org/labkey/api/pipeline/PipelineJob.java

@@ -25,7 +25,10 @@
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.apache.logging.log4j.core.Appender;
+import org.apache.logging.log4j.core.Layout;
 import org.apache.logging.log4j.core.LoggerContext;
+import org.apache.logging.log4j.core.config.AppenderRef;
 import org.apache.logging.log4j.core.config.Configuration;
 import org.apache.logging.log4j.core.config.LoggerConfig;
 import org.apache.logging.log4j.core.layout.PatternLayout;
@@ -796,6 +799,8 @@ public void runActiveTask() throws IOException, PipelineJobException
             {
                 getLogger().info((success ? "Successfully completed" : "Failed to complete") + " task '" + factory.getId() + "'");
                 logStartStopInfo((success ? "Successfully completed" : "Failed to complete") + " task '" + factory.getId() + "' for job '" + toString() + "' with log file " + getLogFile());
+                // remove temporary logger created for the job
+                removeLogger();
                 try
                 {
                     if (workDirectory != null)
@@ -1351,140 +1356,6 @@ else if (count == logLineInterval)
 
     }
 
-    /////////////////////////////////////////////////////////////////////////
-    //  Logging
-
-    /**
-     * Log4J Logger subclass to allow us to create loggers that are not cached
-     * in the Log4J repository for the life of the webapp.  This logger also
-     * logs to the weblog for the PipelineJob class, allowing administrators
-     * to collect whatever level of logging they want from PipelineJobs.
-     */
-    private static class OutputLogger extends org.apache.logging.log4j.core.Logger
-    {
-        private final PipelineJob _job;
-        private boolean _isSettingStatus;
-
-        // Required for xstream serialization on Java 7
-        @SuppressWarnings({"UnusedDeclaration"})
-        private OutputLogger()
-        {
-            //noinspection NullableProblems
-            this(null, "");
-        }
-
-        protected OutputLogger(PipelineJob job, String name)
-        {
-            super((LoggerContext) LogManager.getContext(), name, LogManager.getLogger(name).getMessageFactory());
-
-            _job = job;
-        }
-
-        @Override
-        public void debug(Object message)
-        {
-            debug(message, null);
-        }
-
-        @Override
-        public void debug(Object message, @Nullable Throwable t)
-        {
-            _job.getClassLogger().debug(getSystemLogMessage(message), t);
-            super.debug(message, t);
-        }
-
-        @Override
-        public void info(Object message)
-        {
-            info(message, null);
-        }
-
-        @Override
-        public void info(Object message, @Nullable Throwable t)
-        {
-            _job.getClassLogger().info(getSystemLogMessage(message), t);
-            super.info(message, t);
-        }
-
-        @Override
-        public void warn(Object message)
-        {
-            warn(message, null);
-        }
-
-        @Override
-        public void warn(Object message, @Nullable Throwable t)
-        {
-            _job.getClassLogger().warn(getSystemLogMessage(message), t);
-            super.warn(message, t);
-        }
-
-        @Override
-        public void error(Object message)
-        {
-            error(message, null);
-        }
-
-        @Override
-        public void error(Object message, @Nullable Throwable t)
-        {
-            _job.getClassLogger().error(getSystemLogMessage(message), t);
-            super.error(message, t);
-            setErrorStatus(message);
-        }
-
-        @Override
-        public void fatal(Object message)
-        {
-            fatal(message, null);
-        }
-
-        @Override
-        public void fatal(Object message, Throwable t)
-        {
-            _job.getClassLogger().fatal(getSystemLogMessage(message), t);
-            super.fatal(message, t);
-            setErrorStatus(message);
-        }
-
-        private String getSystemLogMessage(Object message)
-        {
-            StringBuilder sb = new StringBuilder();
-            sb.append("(from pipeline job log file ");
-            sb.append(_job.getLogFile().getPath());
-            if (message != null)
-            {
-                sb.append(": ");
-                String stringMessage = message.toString();
-                // Limit the maximum line length
-                final int maxLength = 10000;
-                if (stringMessage.length() > maxLength)
-                {
-                    stringMessage = stringMessage.substring(0, maxLength) + "...";
-                }
-                sb.append(stringMessage);
-            }
-            sb.append(")");
-            return sb.toString();
-        }
-
-        public void setErrorStatus(Object message)
-        {
-            if (_isSettingStatus)
-                return;
-
-            _isSettingStatus = true;
-            try
-            {
-                _job.setStatus(TaskStatus.error, message == null ? "ERROR" : message.toString());
-            }
-            finally
-            {
-                _isSettingStatus = false;
-            }
-        }
-    }
-
     public String getLogLevel()
     {
         return _loggerLevel;
@@ -1514,19 +1385,48 @@ public synchronized Logger getLogger()
 
             File logFile = null != _logFile ? _logFile : new File(_logFilePathName);
             // Create appending logger.
-            _logger = new OutputLogger(this, PipelineJob.class.getSimpleName() + ".Logger." + _logFilePathName);
-            LoggerContext loggerContext = (LoggerContext) LogManager.getContext(true);
-            Configuration configuration = loggerContext.getConfiguration();
-            LoggerConfig loggerConfig = configuration.getLoggerConfig(_logger.getName());
-            loggerConfig.getAppenders().forEach((key, value) -> loggerConfig.removeAppender(value.getName()));
-
-            SafeFileAppender appender = SafeFileAppender.createAppender("SafeFile", false, PatternLayout.newBuilder().withPattern("%d{DATE} %-5p: %m%n").build(), null, logFile);
-            loggerConfig.addAppender(appender, Level.toLevel(_loggerLevel), null);
+            final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
+            final Configuration config = ctx.getConfiguration();
+
+            // Programmatically adding appender and logger config to log4j2 config
+            String appenderName = "SafeFile";
+            Layout<? extends Serializable> layout = PatternLayout.newBuilder().withPattern("%d{DATE} %-5p: %m%n").build();
+            Appender appender = SafeFileAppender.createAppender(appenderName, false, layout, null, logFile, this);
+            appender.start();
+            config.addAppender(appender);
+
+            AppenderRef ref = AppenderRef.createAppenderRef(appenderName, null, null);
+            AppenderRef[] refs = new AppenderRef[] {ref};
+            String loggerName = PipelineJob.class.getSimpleName() + ".Logger." + _logFilePathName;
+            LoggerConfig loggerConfig = LoggerConfig.createLogger(false, Level.toLevel(_loggerLevel), loggerName, "true", refs, null, config, null );
+            loggerConfig.addAppender(appender, null, null);
+            config.addLogger(loggerName, loggerConfig);
+            ctx.updateLoggers();
+
+            // Now that the log4j2 config contains the logger, access the logger through LogManager
+            _logger = LogManager.getLogger(loggerName);
         }
 
         return _logger;
     }
 
+    /**
+     * This method removes the logger created for this pipeline job so that it does not live
+     * in the Log4J2 repository for the life of the webapp.
+     * */
+    public synchronized void removeLogger()
+    {
+        if (_logger != null)
+        {
+            final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
+            final Configuration config = ctx.getConfiguration();
+            String loggerName = PipelineJob.class.getSimpleName() + ".Logger." + _logFilePathName;
+            config.removeLogger(loggerName);
+            ctx.updateLoggers();
+            _logger = null;
+        }
+    }
+
     public void error(String message)
     {
         error(message, null);

api/src/org/labkey/api/security/ConfigurationSettings.java

@@ -1,7 +1,8 @@
 package org.labkey.api.security;
 
 import org.apache.commons.codec.binary.Base64;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.json.JSONObject;
 import org.labkey.api.data.AES;
 import org.labkey.api.settings.AppProps;
@@ -10,7 +11,7 @@
 
 public class ConfigurationSettings
 {
-    private static final Logger LOG = Logger.getLogger(ConfigurationSettings.class);
+    private static final Logger LOG = LogManager.getLogger(ConfigurationSettings.class);
 
     private final Map<String, Object> _standardSettings;
     private final Map<String, Object> _properties;

api/src/org/labkey/api/security/ValidEmail.java

@@ -17,7 +17,8 @@
 package org.labkey.api.security;
 
 import org.apache.commons.lang3.StringUtils;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.junit.Assert;
 import org.junit.Test;
 import org.labkey.api.data.ColumnInfo;
@@ -45,7 +46,7 @@
  */
 public class ValidEmail
 {
-    private static final Logger LOG = Logger.getLogger(ValidEmail.class);
+    private static final Logger LOG = LogManager.getLogger(ValidEmail.class);
 
     private final InternetAddress _internetAddress;