Debug mode

In normal operation the webPDF server logs reduced information in the INFO level to the console and to the log files (folder /logs). Usually this information is enough to evaluate the operation of the server.

However, if problems occur, this information is not always sufficient. In this case, the level can be adjusted (e.g. to DEBUG) so that more details are available in the log (1).

This information helps to analyze problems and helps us to localize the problem. This is usually useful if our support team requests the additional Support Information.

You can set the log level in the Admin Portal of the server under Server logs to one of the available modes in the Debug Mode drop-down menu.

Important

It is always recommended to set the debug mode via the Admin Portal whenever possible.

In the following video you can see how to adjust the level in the Admin Portal.

See how to enable debug mode in the admin area here.

Enable debug mode in the configuration file

Alternatively, you can also set the log level directly in the configuration file log4j2.xml. However, this is not recommended as this is a permanent setting.

caution

As soon as you save the modified file, the new settings are loaded from the server and activated. A message appears on the server console.

Change <Root level=“info”> to <Root level=“debug”>> to switch to debug mode.

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    
    <!-- further content omitted -->

    <Loggers>
        
        <!-- further content omitted -->
        
        <Root level="debug">
            <AppenderRef ref="ASYNC"/>
        </Root>
    </Loggers>
</Configuration>

caution

Please do not forget to set the logging back to info when the analysis is finished. Unnecessary logging can slow down the server and makes the log files grow quickly.