Skip to main content

 Folders and files

A explainer on files and folders

Log files

/WEB-INF/state/logs

The logs files are automatically generated by PageSeeder during its normal operation. You can search and browse the contents of the log files available from Logs pages in the System administration.

There is no folder for recent logs because entries listed on the Recent logs page are kept in memory. They only contain the most recent events that occurred in your system.

All logs files use utf-8 with a daily rollover and maximum file size of 10MB.

You can change the location of the logs files using the logsFolder global property. The internal file organization remains the same.

The XLOG format is a PageSeeder specific format which collates individual log events as XML. While the file itself is not a valid XML document, it can only be parsed as XML when wrapped in a document element (by inserting an <events> start element at the beginning and an </events> end element at the end).

Some events such as Tomcat start up and out of memory errors might be sent to system out/error which is usually logged on Linux under /opt/pageseeder/tomcat/logs/catalina.out. For out of memory errors, Linux usually creates a large .hprof file under /home/pageseeder which should be deleted after it is downloaded for analysis.

access folder

This folder contains record access to API services and pages by end-users. You can browse the access logs from the Logs > Access logs page in the system administration.

The following is a sample event reported by the access log:

<event logger="PAGESEEDER.Access" 
       timestamp="1652667241924" 
       datetime="2022-05-16T12:14:01+10:00" 
       level="WARN" 
       thread="http-nio-8282-exec-1" 
       ticket="anonymous-0E9E" 
       username="anonymous #0E9E" 
       title="anonymous #0E9E">
  <access type="ui" 
          component="account-home" 
          ip="192.168.0.1" 
          path="/ps/ui/home.html" 
          method="GET" 
          status="UNAUTHORIZED" 
          time="1069"/>
</event>

You can change how long the access log files are retained using the logsAccessHistory global property.

general folder

This folder contains log messages output by PageSeeder and not captured by other logs. They use the XLOG format. This includes bugs, stack traces, debug information and system initialization. They use a plain text format.

To see the logs, go to the Logs > General logs page in the system administration.

The following is an example. 

2022-05-12T12:26:17.948 [main] INFO  com.pageseeder.Update - Running Database Update
2022-05-12T12:26:18.740 [main] INFO  com.pageseeder.Update - Connected to database
2022-05-12T12:26:18.792 [main] INFO  com.pageseeder.Update - Found database version 5.99
2022-05-12T12:26:18.797 [main] INFO  com.pageseeder.Update - Database is up to date
2022-05-12T12:26:18.986 [ps-background-p2] INFO  c.p.publish.PublishSchedulerThread - Publish Scheduler Thread Started
2022-05-12T12:26:19.008 [ps-background-p2] INFO  com.pageseeder.NotificationThread - Notification Thread Started
2022-05-12T12:26:30.681 [main] INFO  com.pageseeder.Initialise - Publisher: Starting file cleaners
2022-05-12T12:26:31.360 [main] INFO  com.pageseeder.Initialise - Generating Help Index
2022-05-12T12:26:31.435 [main] INFO  com.pageseeder.Initialise - Help Index Content added 379 documents to indexing queue in 75ms
2022-05-12T12:26:31.993 [main] INFO  o.p.berlioz.servlet.BerliozConfig - Loading the etag seed w109b7jmzypf

index folder

These logs files are generated by the index process. Indexing events indicate whether indexing jobs are successful or not. They use the XLOG format.

To see the logs, go to the Logs > Index logs page in the system administration.

<event logger="PAGESEEDER.Index"
       timestamp="1652406941191"
       datetime="2022-05-13T11:55:41+10:00"
       level="INFO"
       thread="indexing-p3-t1"
       ticket="55408925636665"
       title="PageSeeder Initialise - index help content">
  <job type="COMPLETE" 
       process="-1218014680" 
       batch="55408925636665" 
       index="help" 
       contenttype="DOCUMENT"
       contentid="1_user_interface/concurrent_editing.psml" />
</event>

This folder also contains XML files for the daily summary of the logs files. 

process folder

These logs files are generated by the asynchronous processes such as when files are moved or archived. They use the XLOG format.

To see the logs, go to the Logs > Process logs page in the system administration.

This folder also contains XML files for the daily summary of the logs files. 

publish folder

These logs files are generated by the publisher. They use the XLOG format.

To see the logs, go to the Logs > Publish logs page in the system administration.

This folder also contains XML files for the daily summary of the logs files. 

Created on , last edited on