Skip to content
OpenCms documentation
OpenCms documentation

Log files app


The Log files app is a convenience tool to access server log files via the workplace.

The app can be opened via the Launchpad. It is accessible for workplace users with the role Workplace manager.

The user interface of the log files app

The user interface of the log files app consists of two widgets:

  • at the top, there is a select box to select a log file
  • at the bottom, there is a file viewer where the last lines of the currently selected log file are displayed

In addition, there is a number of toolbar options available explained in more detail below.


Opens the publish dialog.


Opens the download of log-files dialog where all or selected log files can be downloaded.


Opens the settings dialog where the number of visible lines as well as the file encoding can be configured for the file viewer widget.


Opens the log channels view. See below for more information on configuring log channels.


Adds a marker to the currently selected log file.


Reloads the currently selected log file from the server.

The log channels view of the log files app

When clicking on the log channels icon in the toolbar, the log channels view opens showing a table with all log channel settings information. The table has the following columns:

Log level. One of Debug, Error, Fatal, Info, Off, Warn.

Channel name. The name is either the Java class or the Java package writing the log output.

Parent channel. The name of the parent channel.

Log file. The name of the log file the output is written to.

In order to change the log level  for an individual Java class or Java package, use the context menu options. The context menu opens when clicking on the log channels icon of a table row.

The log output of a Java class or Java package can be written to a separate log file. Use the add log file context menu option to get a separate log file.

The log channel settings configured here are not persisted. All settings get lost when the server is restarted. To get persistent log channel settings, see the hints for server administrators below.

Persistent log channels can be configured in the {webapp home}/WEB-INF/classes/log4j2.xml configuration file.

For example, add a rolling file configuration and a logger configuration for an individual scheduled job class in the following way:

    <RollingFilename="MyScheduledJob" fileName="${sys:opencms.logfolder}my-scheduled-job.log"
        <PatternLayoutpattern="%d{DATE} %5p [%30.30C:%4L] %m%n" />
                <SizeBasedTriggeringPolicysize="5 MB"/>
    <Logger level="info" name="" additivity="false">
You have to restart your servlet container after changing the configuration file.