Common Log Options

This page describes common options used to create, view, and otherwise use the Centralized Log facility in Genesys software.

[log] Section

This section must be called log.

Warning

For applications configured via a configuration file, changes to log options take effect after the application is restarted.

buffering
Default Value: true
Valid Values:

true	Enables buffering
false	Disables buffering

Changes Take Effect: Immediately

Turns on/off operating system file buffering. The option is applicable only to the stderr and stdout output (see page 21). Setting this option to true increases the output performance.

Note: When buffering is enabled, there might be a delay before log messages appear at the console.

check-point
Default Value: 1
Valid Values: 0–24
Changes Take Effect: Immediately

Specifies, in hours, how often the application generates a check point log event, to divide the log into sections of equal time. By default, the application generates this log event every hour. Setting the option to 0 prevents the generation of check-point events.

enable-thread
Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately

Specifies whether to enable or disable the logging thread. If set to true (the logging thread is enabled), the logs are stored in an internal queue to be written to the specified output by a dedicated logging thread. This setting also enables the log throttling feature, which allows the verbose level to be dynamically reduced when a logging performance issue is detected. Refer to the Framework Management Layer User's Guide for more information about the log throttling feature.

If this option is set to false (the logging thread is disabled), each log is written directly to the outputs by the thread that initiated the log request. This setting also disables the log throttling feature.

expire
Default Value: 10
Valid Values:

false	No expiration; all generated segments are stored.
<number> file or <number>	Sets the maximum number of log files to store. Specify a number from 1–1000.
<number> day	Sets the maximum number of days before log files are deleted. Specify a number from 1–100.

Changes Take Effect: Immediately

Determines whether log files expire. If they do, sets the measurement for determining when they expire, along with the maximum number of files (segments) or days before the files are removed. This option is ignored if log output is not configured to be sent to a log file.

If the option’s value is set incorrectly—out of range of the valid values— it will be automatically reset to 10.