Versions Compared

Old Version 37

changes.mady.by.user Tim Donohue

Saved on

compared with

New Version 38

changes.mady.by.user Tim Donohue

Saved on

Key

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

...

  • 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.

    • NOTE: You'll need to restart Tomcat after enabling DEBUG mode in the log4j.properties file.

    • 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!

  • Depending on where you got your Java runtime environment, you may have the jps command.  jps -v can show you the options actually used to run your Servlet container, which can be useful in debugging startup issues.  A plain jps command will list process IDs of running JREs, which you can use with your favorite process monitoring tools.  jps can only show processes which your user account is allowed to inspect, so you should run it as the user which runs the container, or as a superuser.

DSpace 7.x (or above)


Info
titleFinding the detailed error message is important!

In DSpace 7, 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, as the error which displays in a User Interface error popup is usually a generic message.

  1. In your web browser's DevTools when running the User Interface - Because the v7 User Interface is built on 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 "Found an error message! Now what?" below.

Finding the Error Message in the User Interface

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

...