How can I implement log4j logging to an existing J2EE Struts web application?

Question

I have recently inherited a J2EE Struts web app that was written back in 2002. There is no logging in the application other than the odd System.out.println().
I have added log4j logging so that I can write out some info to the console, but I'm concerned on how best to approach this. Any suggestions, tips, best practices would be welcome as I don't want to spend too much time adding logging to every method or class (or trying to find what places where logging would be best - ie. bad code blocks/defects).
My current approach is to just add some logging to the few classes that I have been looking at to understand the code, but are there a few key places where I can add logging to maximize my use of adding log4j?

Edit:
Progress update:
I extended the Struts (v.1) ExceptionHandler and configured the struts-config.xml to use my CustomExceptionHandler instead of the Struts version. Then by overriding the execute() method, I added some logic to log the exception using log4j. See below:

public class CustomExceptionHandler extends ExceptionHandler {

 static Logger logger = Logger.getLogger(CustomExceptionHandler.class);

 public ActionForward execute(Exception ex, ExceptionConfig ae, ActionMapping mapping, ActionForm formInstance, HttpServletRequest request, HttpServletResponse response) throws ServletException {
  logException(ex);
  return super.execute(ex, ae, mapping, formInstance, request, response);
 }

 private void logException(Throwable thr) {
   // Add code here to log the exception appropiately
   // i.e. logger.error("Exception is: " + ex.getMessage());
}

The struts-config.xml file had to be updated as well:

<global-exceptions>
<exception key="" type="java.lang.Throwable" handler="com.mycompany.CustomExceptionHandler" />
</global-exceptions>

Now I can be sure that I will always appropiately log any exceptions.
For the exceptions that were getting eaten, I wrap them in unchecked exceptions so that they make it to the top:

} catch (Exception e) {
//nothing here
}

Changed to:

} catch (Exception e) {
 throw new RuntimeException(e);
}

Answer 1

The most important thing is, I would set up a Struts exception handler in the struts-config.xml to catch everything that was thrown from the actions and log it. Then I'd check all the exception handling to see what exceptions are getting eaten, written to stdout, or otherwise not making it into the log, and make changes so that every exception that can't be usefully handled gets propagated (wrapped in unchecked exceptions if necessary) so that it makes it to the exception handler.

Besides that, I'd do like you describe, adding logging to the parts where it is directly helpful. As long as exceptions are getting thrown and making their way to the exception handler there shouldn't be much more to do.

Answer 2

If the only thing that is going to System.out (System.err) is the old logging and you are looking for a simple solution, you could always redirect System.out to a wrapper class around a logger in the startup of your app's lifecycle:

public class LoggerStream extends PrintStream {
  Logger legacyLogger = Logger.getLogger("app.legacyLogger");

  ...

  public void println(String s){
    legacyLogger.log(s);
  }
}

overriding any other methods like print, etc. It might not generate the prettiest output, but you could use it as a "quick-fix" start and then replace the legacy logging with more appropriate logging as you find items of greater interest.

Answer 3

Are you familiar with aspect oriented programming? This can be a good way to add generalized logging to your application. Here is a good post about simplying your logging with AspectJ .

In struts 2 you can also handle some of your logging with interceptors, but since this project was started in 2002, I am assuming you are using Struts 1?