Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • DSpace log: [dspace]/log/dspace.log (usually)
    • [dspace] is the location where DSpace is installed.
  • Tomcat log directory: [tomcat]/logs (usually)
    • [tomcat] is the location where Tomcat is installed.
  • (v1.x-6.x XMLUI Only) Cocoon log:
    • DSpace 1.5.1 or previous: [tomcat]/webapps/<name-of-webapp>/WEB-INF/logs/
    • DSpace 1.5.2 or later: [dspace]/log/cocoon.log

Resources

General Instructions

DSpace 7.x

...

or

...

8.x

Info
titleFinding the detailed error message is important!

In DSpace 7.x or 8.x, there are two main places where detailed error messages may be found. It is important to locate these detailed error messages in order to debug any issues you are seeing. (The generic error messages that appear in the User Interface do not provide enough information to debug the problem.)

  1. In your web browser's DevTools when running the User Interface - because the v7 User Interface is built with JavaScript (Angular.io), some errors are only visible in your browser (and therefore will never appear in log files). See "Finding the Error Message in the User Interface" below.
  2. In the backend's log files - Some errors (especially 500 responses/errors) will result in the error message being logged to your dspace.log or Tomcat logs. See "Finding error messages in the REST API logs" below.

Once you locate the detailed error, see the section on "Report the Error and Describe How You Encountered It" below.

1. Finding the Error Message in the User Interface (Try this first!)

In DSpace 7, the The User Interface is built with JavaScript (Angular.io). This means that some errors are only visible in your browser (and therefore will never appear in log files).

...

  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. Cocoon logs can be found in these locations: 
      • DSpace 1.5.1 or previous: [tomcat]/webapps/<name-of-webapp>/WEB-INF/logs/
      • DSpace 1.5.2 or later: [dspace]/log/cocoon.log
  2. If you get an "Internal Server Error" message, you will have to check the log files for a full error listing. If your email address is set up in dspace.cfg (alert.recipient) as the DSpace Administrator, you should receive an email with this full error listing. If not, move into the DSpace log directory ([dspace]/log) and view the end of the log file:
    • (Linux or Mac OSX) Go to the DSpace log directory via the command line and enter: tail -100 dspace.log Alternatively, you can open up the dspace.log file in your favorite text editor and look near the bottom of the file for the error message.
    • (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 error is in the first five to ten lines of the error stack listing. The error stack starts with a line similar to one of the following:
    • yyyy-mm-dd time ERROR ... OR,
    • yyyy-mm-dd time WARN ...

Searching for Fixes to Common Errors

...

Use the DSpace Community Resource Search engine to simultaneously search the DSpace Wiki, Issue Tracker and mailing lists (via Google).Search StackOverflow (especially the "dspace" tag) to see if this issue has been reported and solved there (as we now encourage technical questions to be asked on StackOverflow).

...

See "Report the Error and Describe How You Encountered It" section immediately above for details.

Turning on Debugging (optional)

...