Logging parameters

The following table lists the PPM Server configuration parameters located in the logging.conf (logging properties) file, and provides a description of each. The logging.conf file is located in the <PPM_Home>/conf directory.

Note: Changes to the logging.conf file are picked up dynamically by the application (it takes about one minute), so there is no need to restart the application.

The logging parameter names listed below are shortened versions of the actual names, all of which start with the string com.kintana.core.logging. For example, the full name of the LOG_LAYOUT parameter is com.kintana.core.logging.LOG_LAYOUT.

Table A-3. Logging parameters
Parameter Name (*Required)	Description, Usage	Default, Valid Values, Example
CATCH_SYSTEM_ ERR	Used to determine whether to redirect `System.err` to the server log.	Default: `true` Valid values: `true, false`
CATCH_SYSTEM_ OUT	Used to determine whether to redirect `System.out` to the server log.	Default: `true` Valid values: `true, false`
class.filters	Specifies the class names to include in the stack trace (substring of stack trace classname, including packages). This parameters is used to filter out the classes in stack traces that are of no interest to reduce the log size. If you specify multiple classes or packages, use commas to separate them. If the full class name in a stack trace contains one of the specified classes or package names, then that line is preserved. For example, if the value is set to `com.kintana,com.mercury,` then any class names that contain "`com.kintana`" or "`com.mercury`" are kept. The number of traces filtered out is added to server logs after the stack trace.The system default is EMPTY, do not filter out any classes in stack trace.	Default: `None`
CLASS_LOGGING_ LEVEL	Overrides the logging level for a specific Java class to enable logging of a specific piece of code while leaving the rest of the application at a lower logging level. The format of this parameter is the fully-qualified class name followed by a "," then the level. Caution: Use of class filtering degrades performance.	Default: `DEBUG`
CONF_FILE_RECHECK_ INTERVAL	Determines the regular interval (in seconds) at which the `logging.conf` file is checked for changes while the server is running.	Default: `30` (seconds)
context.option	Number that specifies the levels to include context in exception logging, as follows: 3 includes all 0 include bitwise combination value in binary (default) 001 Include context information, if provided 010 Include stack trace for log messages without exception	Default: `0` Valid values: `3, 0, 001`, and `010`
DEFAULT_SERVER_ LOGGING_LEVEL	Determines the default debug logging level of the PPM Server. It controls the verbosity of logs generated by the PPM Server. The values, which you can set dynamically at runtime in the Workbench Server Settings window, map as follows: `ERROR` maps to None in the Server Settings window `INFO` maps to Normal `DEBUG` maps to Max For more information about the Server Settings window, see .	Default: `ERROR` Valid values: `NONE` - No information, (including errors) is logged `ERROR` - Only errors are logged `INFO` - Errors and additional information is logged `DEBUG` - Includes verbose debugging messages `ALL` - Displays all log messages generated
DEFAULT_USER_DEBUG_ LEVEL	Specifies the default debug level of a user's client session. Controls the verbosity of users' logs on the client, application server, and database. Can be different for different client sessions, and can be changed in the standard interface as a user preference. The values, which can also be set in the Workbench Server Settings window dynamically at runtime, map as follows: ERROR maps to None in the Server Settings window INFO maps to Normal DEBUG maps to Max For more information about the Server Settings window, see .	Default: `ERROR` Valid values: `NONE` - No information, (including errors) is logged `ERROR` - Only errors are logged `INFO` - Errors and additional information is logged `DEBUG` - Includes verbose debugging messages `ALL` - Displays all log messages generated
DEFAULT_USER_ LOGGING_LEVEL	Specifies the default logging level for users client sessions. It controls the verbosity of a users logs on a client, application server, and database.	Default: `ERROR` Valid values: `OFF:` No information is logged (even errors are excluded) `ERROR:` Only errors are logged. `INFO:` Errors and additional information are logged. `DEBUG:` Verbose logging of debugging messages. `ALL:` Display all log messages being produced
ENABLE_CONSOLE_ LOGGING	If set to true, all logs that are written to the `serverLog.txt` file are also printed to the console that started the PPM Server.	Default: `true` Valid values: `true, false`
ENABLE_EXECUTION_ CONSOLE_LOGGING	If set to `true,` during an execution, all logs written to the `serverLog.txt` file are also printed to the console that started the server.	Default: `false` Valid values: `true, false`
ENABLE_SMTP_ LOGGING	If set to `true`, mail notification for specified server logs is enabled.	Default: `false` Valid values: `true, false`
ENABLE_WEB_ ACCESS_LOGGING	Determines whether or not information sent to the internal OpenText PPM Web server (Tomcat) is logged.	Default: `false` Valid values: `true, false`
ENCODING	Specifies the default character set for logged messages. This overrides the default operating system character set.	Default: `UTF-8`
FILE_RECHECK_ INTERVAL	Time interval (in seconds) at which the `logging.conf` file is checked for changes. The file keeps being checked as long as the PPM Server is running.	Default: `30`
LOG_LAYOUT	Determines the layout format of the log files.	Default: `XML` Valid values: `TEXT, XML`
LOG_PATTERN	Controls the formatting of the generated logs. You can use the following variables in the log output: %c - Product function hierarchy of the logged item %d - Date of logging %m - Logging message %n - Line separator %p - Priority level for the log message %r - Number of milliseconds elapsed since the application started %t - Thread name in which the log message created %x - Username for the user who triggered the log message Because the following log pattern variables can significantly slow performance, we recommend that you use them only during debugging. %C - Fully-qualified class name of the class creating the log message %F - Name of the file in which the log message was created %l - Class and line number of the log message source %L - Line number where the log message was created %M - Method name producing the log message	Default: `%x:%t:%c:%d {yyyy /MM/dd- HH: mm :ss.SSS z}: %m%n` Valid values: See Description, Usage
MAX_BACKUP_ INDEX	Limits the number of backup logs kept in the system.	Default: `20`
PRODUCT_FUNCTION_ LOGGING_LEVEL	Specifies the logging level for a specific product function while leaving the rest of the application at a different logging level. The function areas are hierarchical. Parameter value format: `<Functional_Hierarchy_Name>, <Logging_Level>` Caution: This parameter is designed for advanced troubleshooting. Do not modify its value unless Software Support engineers advise you to do so. Starting from PPM 10.0.1, you can also specify the logging level from the Logger Manager page. For details, see Specify product function logging level.	Default: `com.kintana. crt.request, DEBUG` Valid values: `TRACE, DEBUG, INFO, WARN, ERROR`
ROTATE_LOG_ SIZE	As the PPM Server logs information into the `serverLog.txt` file, the file can grow quite large. This parameter determines how large (in KB or MB) it can grow before the server creates a new log file. When the `serverLog.txt` file reaches the size specified by this parameter, the PPM Server renames it (to `serverLog_<Timestamp>.txt`), and starts a new serverLog.txt file.	Default: `250KB` You can specify the size in either kilobytes or megabytes by appending `KB` or `MB` to the number
SERVER_ DEBUG_LEVEL	Debug level of the PPM Server. Controls the verbosity of logs generated by independent server processes (for example, EmailNotificationAgent). Corresponds to the Debug Level list in the Server section of the Server Settings page.	Valid values: `NONE, LOW, HIGH`
**SMTP.To Required if ENABLE_SMTP_LOGGING is set to `true`.	The recipient of the notification.	Default: N/A Valid values: Email address
SMTP.From	The sender of the notification. If not specified, the email address of the sender is derived from EMAIL_NOTIFICATION_SENDER in the `server.conf` file.	Default: N/A Valid values: Email address
SMTP.Subject	The subject of the notification mail.	Default: N/A
**SMTP.Filter.Reg exToMatch Required if ENABLE_SMTP_LOGGING is set to `true`.	The keyword or regular expression to be monitored.	Default: N/A Valid values: Regular expression For example, `OutOfMemoryError \|\w+\d{2}\|Exception`
SMTP.Filter.Level Min	The lowest log level to be monitored.	Default: N/A Valid values: `trace debug info warn error fatal`
SMTP.Filter.Level Max	The highest log level to be monitored.	Default: N/A Valid values: `trace debug info warn error fatal`
SMTP. delayBetween ChecksInSeconds	The time interval (in seconds) to check message queues.	Default: `10` Valid values: `> 0`
SMTP.SMTPDe bug	If set to `true`, enables displaying debug information when mail notification is sent out.	Default: `false` Valid values: `true, false`
SMTP.BufferSize	The buffer queue length.	Default: `512` Valid values: `> 0`
SYSTEM_ THRESHOLD	Determines the system-wide logging threshold. IF statements wrapping the log requests check this setting. Caution: This parameter is designed for advanced troubleshooting. Do not modify its value unless Software Support engineers advise you to do so.	Default: `ERROR` Valid values: `INFO, ERROR, DEBUG`
USER_ THRESHOLD:	Used to set logging threshold for individual users, as follows: `<Username>, <Log_Level>` To enable the debug console for multiple users, add `USER_THRESHOLD` on a separate line of the `logging.conf` file for each user.	Default: N/A