Logging Enterprise Server 10 activity – Help Center

The low-level debug logging feature is used for storing all SQL queries and Web service details for debugging purposes.

IMPORTANT: With low-level logging turned on, the file size of the log files will keep growing, thereby consuming disk space and reducing performance.

About the structure

Files are written to the logging directory (as defined in configserver.php) in the following structure:

OUTPUTDIRECTORY > day > client IP

‘day’ directory: this represents the day (in YYYYMMDD format) on which a log operation took place. This bundles all logging operations on a daily basis, thereby making it easy to clean up. For example, you can throw away directories older than one week manually or by your home-brewed batch job.

‘client IP’ directory: this is created within the ‘day’ folder whenever logging was done in context of a certain client application. The client works from a certain IP address which is used as the folder name. Logging written for all applications working from that IP are bundled in this directory which makes it easy to for example identify problematic work stations. This directory contains HTML files (or text files) named after the PHP module used as entry point by the client application, or the name of the Web service requested.

Note: Make sure that read and write access is set to the log folder for the following users:

MacOS: “www”
Windows: “IUSR_<servername>”
Linux: “nobody”

Type of files that are logged

The following files can be found in the logging directory tree:

File name: ent_log_errors.htm
Location: This file might appear in a ‘client IP’ directory.
Description: Indicates that an ERROR has occurred for this client. The full context can be found in any of logged files in the same folder.

File name: phpinfo.htm:
Location: This file always appears in the ‘day’ folder and in the ‘client IP’ folder. For performance reasons it is only generated once per day, just before the first server operation gets executed.
Description: Contains valuable information for analysis. When contacting WoodWing Support, please make sure to include this file.
File names: sce_profile_mysql.htm, sce_profile_mssql.htm, or sce_profile_oracle.htm.
Description: Server profile logs containing information about how long operations take and how much memory is used.

Note: Only available with DEBUGLEVELS is defined as INFO or DEBUG, and PROFILELEVEL is set in a range of 1 to 5.

Enabling low-level logging

The low-level logging feature is enabled through the following settings:

DEBUGLEVELS

File: configserver.php file
Possible values:
NONE
ERROR
WARN
INFO
DEBUG

Notes:

The amount of information that is stored increases with each option: NONE saves no information while DEBUG stores the highest amount of information.

For the following versions of Enterprise Server, INFO also logs additional information related to licensing auto renewal. This makes it possible to log the renewal activities without having to switch to the high-level DEBUG mode.
Enterprise Server 10.5.3 or any higher version of Enterprise Server 10.5.x.
Enterprise Server 10.6.1 or any higher version of Enterprise Server 10.6.x.
Any version of Enterprise Server higher than 10.6.

Fatal errors are logged in the php.log file. Normally, this file is not present in the server log folder, indicating that there are no fatal errors.

When DEBUG mode is used, 'DEPRECATED' can appear in the logging¹. This indicates that a deprecated function is used in a custom Server plug-in. It should be seen as a notice that this function is likely to be removed by WoodWing some time in the future and that the affected function should therefore be adjusted.

¹ This applies to the following versions:

Enterprise Server 10.1.5, or any other higher version of Enterprise Server 10.1
Enterprise Server 10.2.1, or any other higher version of Enterprise Server 10.2.
Enterprise Server 10.3.x, 10.4.x or any higher version.

Default value: NONE
Example:

define ('DEBUGLEVELS', serialize( array(
	// CLIENT IP => DEBUGLEVEL
	'default' => 'INFO', // 'default' entry is mandatory
	'127.0.0.1' => 'DEBUG',
)));

Note: There must be one item named 'default' which is used for all clients that are not explicitly configured.

By default, some high-level information is logged for all clients. This is indicated by the 'default' key, which is mandatory:

define ('DEBUGLEVELS', serialize( array(
	'default' => 'INFO', 
)));

When you want to monitor a client application in great detail (while not being too interested in other clients), add the IP address that the client is using:

define ('DEBUGLEVELS', serialize( array(
	'default' => 'INFO', 
	'123.123.123.123' => 'DEBUG',
)));

In this example, some high-level INFO logging is written for all clients, while for the client(s) running on IP 123.123.123.123 the most detailed DEBUG logging is written.