Enabling detailed errors logging

You may find it useful to enable detailed errors logging in the AppServerX.xml file in the following cases:

  • providing more details for WebSpellChecker support requests;

  • getting more details on issues and health diagnostics.

When enabling detailed logging, you need to ensure that the size of the log directory does not take too much disk space. Besides, we don’t recommend you to have logging enabled on a permanent basis. We also advise you to clear the logs directory content in a timely manner. For more details on disk space usage, refer to Hardware requirements.

1

Open AppServerX.xml

Navigate to the AppServer folder. Open AppServerX.xml in a text editor.

2

Switch the log level to debug

Locate the Log tag. Inside it, find the PrioritizationLevel tag. Change the value from information to debug.

<Log>
	<PrioritizationLevel>debug</PrioritizationLevel>
</Log>

Save the file.

3

Restart AppServer

Restart AppServer to apply changes in AppServerX.xml.

To restart: stop the application, then start it again.

Use Main AppServer commands.

4

Collect logs (if needed)

Review logs in the AppServer/Log files directory. Archive the whole directory as .zip and share it with support.

Enabling advanced logging options

You can also enable additional logging options to get more information from your logs. Refer to a code sample description of the AppServerX.xml file below for details.

<Log>
	<!-- Size parameter defines the maximum size of the AppServerX.log file in kilobytes. If the maximum size is reached, a new log file will be created and the previous one will be saved with appropriate time stamp (log rotation). -->
 	<Size>10000</Size>
	<!-- Log prioritization level. Possible values (from the highest priority to the lowest): none, fatal, critical, error, warning, notice, information, debug, trace. The default is "information" -->
	<PrioritizationLevel>information</PrioritizationLevel>
	<!-- Possible values: all or general, threadpool, licensing, failsafe, selector, responder or values delimited by comma(,). 
The default is "all" -->
	<Subsystems>all</Subsystems>
</Log>

In the code sample above:

  • Size tag is used to define the maximum file of AppServerX.log file in kilobytes.

  • Subsystems tag is used to specify the logs filter. Each log entry is generated by a particular system. You can use one of the available options to enable recording the logs for the selected subsystem only. By default, all value is selected meaning all subsystems record their messages into the log files directory.

Last updated

Was this helpful?