Date: Fri, 29 Mar 2024 02:27:14 -0400 (EDT) Message-ID: <140800046.29878.1711693634791@lyrasis1-roc-mp1> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_29877_774181282.1711693634791" ------=_Part_29877_774181282.1711693634791 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
A complete DSpace installation consists of three separate directory tree= s:
Below is the basic layout of a DSpace installation using the default con= figuration. These paths can be configured if necessary.
DSpace's Ant build file creates a dspace-jspui-webapp/ director= y with the following structure:
DSpace's Ant build file creates a dspace-xmlui-webapp/ director= y with the following structure:
The first source of potential confusion is the log files. Since DSpace u= ses a number of third-party tools, problems can occur in a variety of place= s. Below is a table listing the main log files used in a typical DSpace set= up. The locations given are defaults, and might be different for your syste= m depending on where you installed DSpace and the third-party tools. The or= dering of the list is roughly the recommended order for searching them for = the details about a particular problem or error.
Log File |
What's In It |
[dspace]/log/dspace.log.yyyy-mm-dd= p> |
Main DSpace log file. This is where the DSpac= e code writes a simple log of events and errors that occur within the DSpac= e code. You can control the verbosity of this by editing the [dspace-so= urce]/config/templates/log4j.properties file and then running "ant= init_configs". |
[dspace]/log/cocoon.log.yyyy-mm-dd= p> |
Apache Cocoon log file for the XMLUI. This is= where the DSpace XMLUI logs all of its events and errors. |
[tomcat]/logs/catalina.out |
This is where Tomcat's standard output is wri= tten. Many errors that occur within the Tomcat code are logged here. For ex= ample, if Tomcat can't find the DSpace code (dspace.jar), it would= be logged in catalina.out. |
[tomcat]/logs/hostname_log.yyyy-mm-dd.txt= |
If you're running Tomcat stand-alone (without= Apache), it logs some information and errors for specific Web applications= to this log file. hostname will be your host name (e.g. dspac= e.myu.edu) and yyyy-mm-dd will be the date. |
[tomcat]/logs/apache_log.yyyy-mm-dd.txt= em> |
If you're using Apache, Tomcat logs informati= on about Web applications running through Apache (mod_webapp) in t= his log file (yyyy-mm-dd being the date.) |
[apache]/error_log |
Apache logs to this file. If there is a probl= em with getting mod_webapp working, this is a good place to look f= or clues. Apache also writes to several other log files, though error_l= og tends to contain the most useful information for tracking down prob= lems. |
[dspace]/log/handle-plug.log |
The Handle server runs as a separate process = from the DSpace Web UI (which runs under Tomcat's JVM). Due to a limitation= of log4j's 'rolling file appenders', the DSpace code running in the Handle= server's JVM must use a separate log file. The DSpace code that is run as = part of a Handle resolution request writes log information to this file. Yo= u can control the verbosity of this by editing [dspace-source]/config/t= emplates/log4j-handle-plugin.properties. |
[dspace]/log/handle-server.log = td> | This is the log file for CNRI's Handle server= code. If a problem occurs within the Handle server code, before DSpace's p= lug-in is invoked, this is where it may be logged. |
[dspace]/handle-server/error.log = |
On the other hand, a problem with CNRI's Hand= le server code might be logged here. |
PostgreSQL log |
PostgreSQL also writes a log file. This one d= oesn't seem to have a default location, you probably had to specify it your= self at some point during installation. In general, this log file rarely co= ntains pertinent information--PostgreSQL is pretty stable, you're more like= ly to encounter problems with connecting via JDBC, and these problems will = be logged in dspace.log. |
the file [dspace]/config/log4j.properties controls how and wher= e log files are created. There are three sets of configurations in that fil= e, called A1, A2, and A3. These are used to control the logs for DSpace, th= e checksum checker, and the XMLUI respectively. The important settings in t= his file are:
log4j.r= ootCategory=3DINFO,A log4j.logger.org.dspace=3DINFO,A1 |
These lines control what level of logging tak= es place. Normally they should be set to INFO, but if you need to see more = information in the logs, set them to DEBUG and restart your web server <= /td> |
log4j.appender.A1=3Dorg.dspace.app.util.D= ailyFileAppender |
This is the name of the log file creation met= hod used. The DailyFileAppender creates a new date-stamped file every day o= r month. |
log4j.appender.A1.File=3D${log.dir}/dspac= e.log |
This sets the filename and location of where = the log file will be stored. It iwll have a date stamp appended to the file= name. |
log4j.appender.A1.DatePattern=3Dyyy-MM-DD= |
This defines the format for the date stamp th= at is appended to the log file names. If you wish to have log files created= monthly instead of daily, change this to yyyy-MM |
log4j.appender.A1.MaxLogs=3D0 | This defines how many log files will be creat= ed. You may wish to define a retention period for log files. If you set thi= s to 365, logs older than a year will be deleted. By default this is set to= 0 so that no logs are ever deleted. Ensure that you monitor the disk space= used by the logs to make sure that you have enough space for them. It is o= ften important to keep the log files for a long time in case you want to re= build your statistics. |