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.

keep-startup-file

Default Value: false
Valid Values:

false	No startup segment of the log is kept.
true	A startup segment of the log is kept. The size of the segment equals the value of the segment option.
<number> KB	Sets the maximum size, in kilobytes, for a startup segment of the log.
<number> MB	Sets the maximum size, in megabytes, for a startup segment of the log.

Changes Take Effect: After restart

Specifies whether a startup segment of the log, containing the initial configuration options, is to be kept. If it is, this option can be set to true or to a specific size. If set to true, the size of the initial segment will be equal to the size of the regular log segment defined by the segment option. The value of this option will be ignored if segmentation is turned off (that is, if the segment option is set to false).

memory

Default Value: No default value
Valid Values: <string> (memory file name)
Changes Take Effect: Immediately

Specifies the name of the file to which the application regularly prints a snapshot of the memory output, if it is configured to do this (see “Log Output Options” on page 21). The new snapshot overwrites the previously written data. If the application terminates abnormally, this file will contain the latest log messages. Memory output is not recommended for processors with a CPU frequency lower than 600 MHz.

Important

If the file specified as the memory file is located on a network drive, the application does not create a snapshot file (with the extension *.memory.log). Logging output to a file at a network location is not recommended and could cause performance degradation.

memory-storage-size

Default Value: 2 MB
Valid Values:

<number> KB or <number>	The size of the memory output, in kilobytes. The minimum value is 128 KB.
<number> MB	The size of the memory output, in megabytes. The maximum value is 64 MB.

Changes Take Effect: When memory output is created

Specifies the buffer size for log output to the memory, if configured. See also “Log Output Options” on page 21.

message-format

Default Value: short Valid Values:

short	An application uses compressed headers when writing log records in its log file.
full	The size of the memory output, in megabytes. The maximum value is 64 MB.