Troubleshoot an error

Error Log Files:

• DSpace log file: dspace

  /log/dspace.log

  (usually)
• Tomcat log directory: Tomcat

  /logs

  (usually)
• (XMLUI Only) Cocoon log file:
  • 1.5.1 or previous: tomcat

    /webapps/

    webapp

    /WEB-INF/logs/

  • 1.5.2 or later: dspace

    /log/cocoon.log

Resources:

• DSpace technical FAQ:

  http://wiki.dspace.org/TechnicalFaq 

• Search dspace-tech mailing list:

  http://sourceforge.net/mailarchive/forum.php?forum=dspace-tech

General Instructions:

1. If the expected information simply never appears, leaving a blank browser screen, the problem is likely with either a servlet (for JSPUI) or an XSLT Theme (for XMLUI). The error message should be in either

   ''[dspace]''/log/dspace.log

   or

   ''[Tomcat]''/logs/

   . For the XMLUI, you may also want to check the Cocoon logs (see above for path) to see if any extra information can be found there.
2. If you get an "Internal Server Error", you will have to check the log files for a full error listing. If your email address is set up in dspace.cfg as the DSpace Administrator, you should receive an email with this full error listing. If not, move into the DSpace log directory and

   tail -100 dspace.log

   .
   • (Windows) Go to the DSpace log directory, and open dspace.log in your favorite text editor. Look near the bottom for the error message.
3. Usually, the culprit file is in the first five to ten lines of the error stack listing. The error stack starts with a line similar to:

   yyyy-mm-dd time WARN ... 

   (OR)

   yyyy-mm-dd time ERROR ... 

4. Search the DSpace technical FAQ and the dspace-tech mailing list for information on the error. Key words in the error often are useful search terms.
5. If you'd like to try and do some debugging yourself, you can change the DSpace logger settings to

   DEBUG

   which will sometimes provide you with more information about the error. To turn on debugging, visit the dspace

   /config/log4j.properties

   file and do the following:
   • To enable DEBUG logging in the

     dspace.log

     file, change the

     log4j.rootCategory

     and

     log4j.logger.org.dspace

     settings to

     DEBUG

     rather than

     INFO

     .
   • (XMLUI Only) To enable DEBUG logging in the

     cocoon.log

     file, change the

     log4j.logger.org.apache.cocoon

     setting to

     DEBUG

     rather than

     INFO

     .
6. *WARNING: Make sure to turn off debugging once you are finished. Leaving debugging turned on will cause the log files to grow very large very quickly!
7. If all else fails, email a description of the error along with the error stack listing to dspace-tech@lists.sourceforge.net. Try to include the following in your email:
   • Your environment: Operating system, version of DSpace, version of Tomcat, Java, etc.
   • The exact steps you took to encounter the error
   • The error stack that you found in your log file