Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration.log
Class LogOptionsDescriptions

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.configuration.log.LogOptionsDescriptions

public final class LogOptionsDescriptions
extends java.lang.Object

Consolidated container for the Genesys Common Log Options descriptions.

Framework 8.5. Configuration Options. Reference Manual.


Nested Class Summary
static class LogOptionsDescriptions.OptionDescriptor<OptionValueType>
          A property descriptor class to represent information about particular property in "log" section of CME Application "Options".
 
Field Summary
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> ALARM_OPT
          Specifies the outputs to which an application sends the log events of the Alarm level.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> ALL_OPT
          Specifies the outputs to which an application sends all log events.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> BUFFERING_OPT
          Turns on/off operating system file buffering.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> CHECK_POINT_OPT
          Specifies, in hours, how often the application generates a check point log event, to divide the log into sections of equal time.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> DEBUG_OPT
          Specifies the outputs to which an application sends the log events of the Debug level and higher (that is, log events of the Standard, Interaction, Trace, and Debug levels).
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> ENABLE_LOCATION_FOR_THREAD_OPT
          Platform SDK AppTemplate AB specific option to enable the call location information passing to the Log4j2 logging thread, which was enabled with option ENABLE_THREAD_OPT.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> ENABLE_THREAD_OPT
          Specifies whether to enable or disable the logging thread.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> EVENTLOG_HOST_OPT
          Platform SDK AppTemplate AB specific property to let user applications be able to override the applications' host name in log files and message server events.
It is used by the AppTemplate Log4j2 logging configuration functions in PsdkLog4j2Configuration and Log4j2Configurator.
static LogOptionsDescriptions.OptionDescriptor<ExpirationConfig> EXPIRE_OPT
          Determines whether log files expire.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> FILE_HEADER_PROVIDER_OPT
          Platform SDK AppTemplate AB specific property for customization of the log files header content.
Its default value is GFileHeaderProvider.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> INTERACTION_OPT
          Specifies the outputs to which an application sends the log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels).
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> KEEP_STARTUP_FILE_OPT
          Specifies whether a startup segment of the log, containing the initial configuration options, is to be kept.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> LOG4j2_CONFIG_PROFILE_OPT
          Platform SDK AppTemplate AB specific option.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> LOGFILE_ENCODING_OPT
          Platform SDK AppTemplate AB specific property for configuration of the log files encoding.
Its default value is "UTF-8".
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> MEMORY_OPT
          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).
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> MEMORY_STORAGE_SIZE_OPT
          Specifies the buffer size for log output to the memory, if configured.
static LogOptionsDescriptions.OptionDescriptor<MessageFormat> MESSAGE_FORMAT_OPT
          Specifies the format of log record headers that an application uses when writing logs in the log file.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> MESSAGE_HEADER_DELIMITER_OPT
          Platform SDK AppTemplate AB specific property as a parameter for "shortdsv" message format (MESSAGE_FORMAT_OPT).
Its default value is "|".
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> MESSAGEFILE_OPT
          Specifies the file name for application-specific log events.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> NO_MEMORY_MAPPING_OPT
          Specifies if memory-mapped files, including memory log output (with file extension ".memory.log") and snapshot files (with file extension ".snapshot.log") are disabled for file outputs.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> PRINT_ATTRIBUTES_OPT
          Specifies whether the application attaches extended attributes, if any exist, to a log event that it sends to log output.
static LogOptionsDescriptions.OptionDescriptor<SegmentationConfig> SEGMENT_OPT
          Specifies whether there is a segmentation limit for a log file.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> SNAPSHOT_OPT
          A snapshot file is created for each log output file to temporarily store logs that have not been flushed to the log file.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> SPOOL_OPT
          Specifies the folder, including full path to it, in which an application creates temporary files related to network log output.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> STANDARD_OPT
          Specifies the outputs to which an application sends the log events of the Standard level.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> THROTTLE_PERIOD_OPT
          Specifies, in seconds, how long to keep the throttled verbose level.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> THROTTLE_THRESHOLD_OPT
          Specifies the size of the internal log queue at which the verbose level is to be reduced so as to lessen the load generated by logging.
static LogOptionsDescriptions.OptionDescriptor<TimeUsage> TIME_CONVERT_OPT
          Specifies the system in which an application calculates the log record time when generating a log file.
static LogOptionsDescriptions.OptionDescriptor<TimeFormat> TIME_FORMAT_OPT
          Specifies how to represent, in a log file, the time when an application generates log records.
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> TRACE_OPT
          Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels).
static LogOptionsDescriptions.OptionDescriptor<VerboseLevel> VERBOSE_OPT
          Specifies if log output is created, and if so, the minimum level of log events generated.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_ALL_OPT
          Generates Debug log records about open connection, socket select, timer creation and deletion, write, security-related, and DNS operations, and connection library function calls.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_API_OPT
          Generates Debug log records about connection library function calls.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_DNS_OPT
          Generates Debug log records about DNS operations.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_OPEN_OPT
          Generates Debug log records about "open connection" operations of the application.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_SECURITY_OPT
          Generates Debug log records about security-related operations, such as Transport Layer Security and security certificates.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_SELECT_OPT
          Generates Debug log records about "socket select" operations of the application.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_TIMERS_OPT
          Generates Debug log records about the timer creation and deletion operations of the application.
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_WRITE_OPT
          Generates Debug log records about "write" operations of the application.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EVENTLOG_HOST_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> EVENTLOG_HOST_OPT
Platform SDK AppTemplate AB specific property to let user applications be able to override the applications' host name in log files and message server events.
It is used by the AppTemplate Log4j2 logging configuration functions in PsdkLog4j2Configuration and Log4j2Configurator.


MESSAGEFILE_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> MESSAGEFILE_OPT
Specifies the file name for application-specific log events. The name must be valid for the operating system on which the application is running. The option value can also contain the absolute path to the application-specific *.lms file. Otherwise, an application looks for the file in its working directory.

Default Value:As specified by a particular application
Valid Values:Any valid message file ("<filename>.lms")
Changes Take Effect:Immediately, if an application cannot find its "*.lms" file at startup.

Warning! An application that does not find its *.lms file at startup cannot generate application-specific log events and send them to Message Server.


VERBOSE_OPT

public static final LogOptionsDescriptions.OptionDescriptor<VerboseLevel> VERBOSE_OPT
Specifies if log output is created, and if so, the minimum level of log events generated. Log event levels, starting with the highest priority level, are Standard, Interaction, Trace, and Debug.

Default Value:"all"
Valid Values: "all"- All log events (that is, log events of the Standard, Trace, Interaction, and Debug levels) are generated.
"debug"- The same as all.
"trace"- Log events of Trace level and higher (that is, log events of Standard, Interaction, and Trace levels) are generated, but log events of the Debug level are not generated.
"interaction"- Log events of Interaction level and higher (that is, log events of Standard and Interaction levels) are generated, but log events of Trace and Debug levels are not generated.
"standard"- Log events of Standard level are generated, but log events of Interaction, Trace, and Debug levels are not generated.
"none"- No log output is produced.
Changes Take Effect:Immediately

Note: For definitions of the Standard, Interaction, Trace, and Debug log levels, refer to the Framework Management Layer User’s Guide or Framework Genesys Administrator Help.

To configure log outputs, set log level options ("all", "alarm", "standard", "interaction", "trace", and/or "debug") to the desired types of log output ("stdout", "stderr", "network", "memory", and/or [filename], for log file output).
You can use:

You must separate the log output types by a comma when you are configuring more than one output for the same log level.


ALL_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> ALL_OPT
Specifies the outputs to which an application sends all log events. The log output types must be separated by a comma when more than one output is configured.

Default Value:No default value.
Valid Values (log output types):
stdoutLog events are sent to the Standard output (stdout).
stderrLog events are sent to the Standard error output (stderr).
networkLog events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
[filename]Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application’s working directory.
Changes Take Effect:Immediately

For example:

 all = stdout, logfile

Note1: The log output options are activated according to the setting of the Verbose configuration option.

Note2: To ease the troubleshooting process, consider using unique names for log files that different applications generate.

Warning! Directing log output to the console (by using "stdout", "stderr" settings) can affect application performance. Avoid using these log output settings in a production environment.

See Also:
VERBOSE_OPT

ALARM_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> ALARM_OPT
Specifies the outputs to which an application sends the log events of the Alarm level. The log output types must be separated by a comma when more than one output is configured.

Default Value:No default value.
Valid Values (log output types):
stdoutLog events are sent to the Standard output (stdout).
stderrLog events are sent to the Standard error output (stderr).
networkLog events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
[filename]Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application’s working directory.
Changes Take Effect:Immediately

For example:

 alarm = stderr, network

Note1: The log output options are activated according to the setting of the Verbose configuration option.

Note2: To ease the troubleshooting process, consider using unique names for log files that different applications generate.

Warning! Directing log output to the console (by using "stdout", "stderr" settings) can affect application performance. Avoid using these log output settings in a production environment.

See Also:
VERBOSE_OPT

STANDARD_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> STANDARD_OPT
Specifies the outputs to which an application sends the log events of the Standard level. The log output types must be separated by a comma when more than one output is configured.

Default Value:No default value.
Valid Values (log output types):
stdoutLog events are sent to the Standard output (stdout).
stderrLog events are sent to the Standard error output (stderr).
networkLog events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
[filename]Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application’s working directory.
Changes Take Effect:Immediately

For example:

 standard = stdout, logfile

Note1: The log output options are activated according to the setting of the Verbose configuration option.

Note2: To ease the troubleshooting process, consider using unique names for log files that different applications generate.

Warning! Directing log output to the console (by using "stdout", "stderr" settings) can affect application performance. Avoid using these log output settings in a production environment.

See Also:
VERBOSE_OPT

INTERACTION_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> INTERACTION_OPT
Specifies the outputs to which an application sends the log events of the Interaction level and higher (that is, log events of the Standard and Interaction levels). The log outputs must be separated by a comma when more than one output is configured.

Default Value:No default value.
Valid Values (log output types):
stdoutLog events are sent to the Standard output (stdout).
stderrLog events are sent to the Standard error output (stderr).
networkLog events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
[filename]Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application’s working directory.
Changes Take Effect:Immediately

For example:

 interaction = stdout, logfile

Note1: The log output options are activated according to the setting of the Verbose configuration option.

Note2: To ease the troubleshooting process, consider using unique names for log files that different applications generate.

Warning! Directing log output to the console (by using "stdout", "stderr" settings) can affect application performance. Avoid using these log output settings in a production environment.

See Also:
VERBOSE_OPT

TRACE_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> TRACE_OPT
Specifies the outputs to which an application sends the log events of the Trace level and higher (that is, log events of the Standard, Interaction, and Trace levels). The log outputs must be separated by a comma when more than one output is configured.

Default Value:No default value.
Valid Values (log output types):
stdoutLog events are sent to the Standard output (stdout).
stderrLog events are sent to the Standard error output (stderr).
networkLog events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
Setting the all log level option to the network output enables an application to send log events of the Standard, Interaction, and Trace levels to Message Server. Debug-level log events are neither sent to Message Server nor stored in the Log Database.
[filename]Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application’s working directory.
Changes Take Effect:Immediately

For example:

 trace = stdout, logfile

Note1: The log output options are activated according to the setting of the Verbose configuration option.

Note2: To ease the troubleshooting process, consider using unique names for log files that different applications generate.

Warning! Directing log output to the console (by using "stdout", "stderr" settings) can affect application performance. Avoid using these log output settings in a production environment.

See Also:
VERBOSE_OPT

DEBUG_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> DEBUG_OPT
Specifies the outputs to which an application sends the log events of the Debug level and higher (that is, log events of the Standard, Interaction, Trace, and Debug levels). The log output types must be separated by a comma when more than one output is configured.

Default Value:No default value.
Valid Values (log output types):
stdoutLog events are sent to the Standard output (stdout).
stderrLog events are sent to the Standard error output (stderr).
networkLog events are sent to Message Server, which can reside anywhere on the network. Message Server stores the log events in the Log Database.
[filename]Log events are stored in a file with the specified name. If a path is not specified, the file is created in the application’s working directory.
Changes Take Effect:Immediately

For example:

 debug = stdout, logfile

Note1: The log output options are activated according to the setting of the Verbose configuration option.

Note2: To ease the troubleshooting process, consider using unique names for log files that different applications generate.

Note3: Debug-level log events are never sent to Message Server or stored in the Log Database.

Warning! Directing log output to the console (by using "stdout", "stderr" settings) can affect application performance. Avoid using these log output settings in a production environment.

See Also:
VERBOSE_OPT

SEGMENT_OPT

public static final LogOptionsDescriptions.OptionDescriptor<SegmentationConfig> SEGMENT_OPT
Specifies whether there is a segmentation limit for a log file. If there is, sets the mode of measurement, along with the maximum size. If the current log segment exceeds the size set by this option, the file is closed and a new one is created. This option is ignored if log output is not configured to be sent to a log file.

Default Value:"100 MB"
Valid Values: "false"- No segmentation is allowed.
"<number>[ KB]" - Sets the maximum segment size, in kilobytes. The minimum segment size is 100 KB.
"<number> MB" - Sets the maximum segment size, in megabytes.
"<number> hr" - Sets the number of hours for the segment to stay open. The minimum number is 1 hour.
Changes Take Effect:Immediately


EXPIRE_OPT

public static final LogOptionsDescriptions.OptionDescriptor<ExpirationConfig> EXPIRE_OPT
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.

Default Value:10
Valid Values: false- No expiration; all generated segments are stored.
"<number>[ file]" - 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

Note: If an option’s value is set incorrectly (out of the range of valid values), it will be automatically reset to 10.


TIME_CONVERT_OPT

public static final LogOptionsDescriptions.OptionDescriptor<TimeUsage> TIME_CONVERT_OPT
Specifies the system in which an application calculates the log record time when generating a log file. The time is converted from the time in seconds since "00:00:00 UTC, January 1, 1970".

Default Value:"local"
Valid Values: "local"- The time of log record generation is expressed as a local time, based on the time zone and any seasonal adjustments. Time zone information of the application’s host computer is used.
"utc"- The time of log record generation is expressed as Coordinated Universal Time (UTC).
Changes Take Effect:Immediately


TIME_FORMAT_OPT

public static final LogOptionsDescriptions.OptionDescriptor<TimeFormat> TIME_FORMAT_OPT
Specifies how to represent, in a log file, the time when an application generates log records. A log record’s time field in the ISO 8601 format looks like this: "2001-07-24T04:58:10.123".

Default Value:"time"
Valid Values: "time"- The time string is formatted according to "HH:MM:SS.sss" (hours, minutes, seconds, and milliseconds) format.
"locale"- The time string is formatted according to the system’s locale.
"iso8601"- The date in the time string is formatted according to the ISO 8601 format. Fractional seconds are given in milliseconds.
Changes Take Effect:Immediately


MESSAGE_FORMAT_OPT

public static final LogOptionsDescriptions.OptionDescriptor<MessageFormat> MESSAGE_FORMAT_OPT
Specifies the format of log record headers that an application uses when writing logs in the log file. Using compressed log record headers improves application performance and reduces the log file's size. With the value set to short:
  • A header of the log file or the log file segment contains information about the application (such as the application name, application type, host type, and time zone), whereas single log records within the file or segment omit this information.
  • A log message priority is abbreviated to Std, Int, Trc, or Dbg, for Standard, Interaction, Trace, or Debug messages, respectively.
  • The message ID does not contain the prefix GCTI or the application type ID.
A log record in the full format looks like this:
2002-05-07T18:11:38.196 Standard localhost cfg_dbserver GCTI-00-05060 Application started
A log record in the short format looks like this:
2002-05-07T18:15:33.952 Std 05060 Application started

Default Value:"medium"
Valid Values: "short"- An application uses compressed headers when writing log records in its log file.
"medium"- An application uses medium size headers when writing log records in its log file.
"full"- An application uses complete headers when writing log records in its log file.
"shortcsv*- An application uses compressed headers with comma delimiter when writing log records in its log file.
"shorttsv*- An application uses compressed headers with tab char delimiter when writing log records in its log file.
"shortdsv*- An application uses compressed headers with MESSAGE_HEADER_DELIMITER_OPT delimiter when writing log records in its log file.
Changes Take Effect:Immediately

* - values marked with the asterisk are valid for Platform SDK AppTemplate based applications only.

Note: Whether the full, short, or any other format is used, time is printed in the format specified by the TIME_FORMAT_OPT option.


MESSAGE_HEADER_DELIMITER_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> MESSAGE_HEADER_DELIMITER_OPT
Platform SDK AppTemplate AB specific property as a parameter for "shortdsv" message format (MESSAGE_FORMAT_OPT).
Its default value is "|".


LOGFILE_ENCODING_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> LOGFILE_ENCODING_OPT
Platform SDK AppTemplate AB specific property for configuration of the log files encoding.
Its default value is "UTF-8".


FILE_HEADER_PROVIDER_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> FILE_HEADER_PROVIDER_OPT
Platform SDK AppTemplate AB specific property for customization of the log files header content.
Its default value is GFileHeaderProvider.


BUFFERING_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> BUFFERING_OPT
Turns on/off operating system file buffering. The option is applicable only to the stderr and stdout output. Setting this option to true increases the output performance.

Default Value:true
Valid Values: true- enables buffering.
false- disables buffering.
Changes Take Effect:Immediately

Note: Platform SDK AppTemplate AB logging configuration logic does not use this option. It relays on jvm buffering of System.out


CHECK_POINT_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> CHECK_POINT_OPT
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.

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

Note: Platform SDK AppTemplate AB does not use this option.


ENABLE_THREAD_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> ENABLE_THREAD_OPT
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 8.5 Management Framework 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.

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

Note*: Platform SDK AppTemplate AB does not support the log throttling feature.


ENABLE_LOCATION_FOR_THREAD_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> ENABLE_LOCATION_FOR_THREAD_OPT
Platform SDK AppTemplate AB specific option to enable the call location information passing to the Log4j2 logging thread, which was enabled with option ENABLE_THREAD_OPT.

If one of the layouts is configured with a location-related attribute like HTML locationInfo, or one of the patterns %C or $class, %F or %file, %l or %location, %L or %line, %M or %method, Log4j will take a snapshot of the stack, and walk the stack trace to find the location information.
This is an expensive operation: 1.3 - 5 times slower for synchronous loggers. Synchronous loggers wait as long as possible before they take this stack snapshot. If no location is required, the snapshot will never be taken.
However, asynchronous loggers need to make this decision before passing the log message to another thread; the location information will be lost after that point. The performance impact of taking a stack trace snapshot is even higher for asynchronous loggers: logging with location is 4 - 20 times slower than without location. For this reason, asynchronous loggers do not include location information by default.

See Also:
ENABLE_THREAD_OPT

KEEP_STARTUP_FILE_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> KEEP_STARTUP_FILE_OPT
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).

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

Note*: Platform SDK AppTemplate AB does not use this option.


MEMORY_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> MEMORY_OPT
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.

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

Note: 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.

Note*: Platform SDK AppTemplate AB does not use this option.


MEMORY_STORAGE_SIZE_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> MEMORY_STORAGE_SIZE_OPT
Specifies the buffer size for log output to the memory, if configured.

Default Value:2 MB
Valid Values: "<number>[ KB]" - 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

Note*: Platform SDK AppTemplate AB does not use this option.


NO_MEMORY_MAPPING_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> NO_MEMORY_MAPPING_OPT
Specifies if memory-mapped files, including memory log output (with file extension ".memory.log") and snapshot files (with file extension ".snapshot.log") are disabled for file outputs.

Default Value:false
Valid Values:true, false
Changes Take Effect:At restart

Note*: Platform SDK AppTemplate AB does not use this option.


PRINT_ATTRIBUTES_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> PRINT_ATTRIBUTES_OPT
Specifies whether the application attaches extended attributes, if any exist, to a log event that it sends to log output. Typically, log events of the Interaction log level and Audit-related log events contain extended attributes. Setting this option to true enables audit capabilities, but negatively affects performance.
Genesys recommends enabling this option for Solution Control Server and Configuration Server when using audit tracking. For other applications, refer to Genesys Combined Log Events Help to find out whether an application generates Interaction-level and Audit-related log events; if it does, enable the option only when testing new interaction scenarios.

Default Value:false
Valid Values: true- Attaches extended attributes, if any exist, to a log event sent to log output.
false- Does not attach extended attributes to a log event sent to log output.
Changes Take Effect:Immediately


SNAPSHOT_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> SNAPSHOT_OPT
A snapshot file is created for each log output file to temporarily store logs that have not been flushed to the log file. This option specifies the folder, either a full path or a path relative to the application’s working directory, in which the application creates the memory-mapped snapshot file associated with the log file. If this option is not configured, or a value is not specified (the default), the file is created in the log output folder.

Default Value:No value
Valid Values: No value or not specified (default) - Snapshot is created in log output folder.
"<path>/<folder>" - Full or relative path and folder in which snapshot is created.
Changes Take Effect:Immediately

Note: Do not write the snapshot file to a network drive, because disconnection of the network drive might cause application failure. If the application detects that the output folder is a network drive, the snapshot file will be disabled. However, this detection may not be possible for Storage Area Network (SAN) devices because of operating system limitations.

Note*: Platform SDK AppTemplate AB does not use this option.


SPOOL_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> SPOOL_OPT
Specifies the folder, including full path to it, in which an application creates temporary files related to network log output. If you change the option value while the application is running, the change does not affect the currently open network output.

Default Value:The application’s working directory
Valid Values:Any valid folder, with the full path to it
Changes Take Effect:Immediately

Note*: Platform SDK AppTemplate AB does not use this option.


THROTTLE_PERIOD_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> THROTTLE_PERIOD_OPT
Specifies, in seconds, how long to keep the throttled verbose level. When this period of time has expired, the original log verbose level will be restored when the log queue size has decreased to less than 50% of the threshold.

Default Value:30
Valid Values:0–3600
Changes Take Effect:Immediately

Note: This option applies only if enable-thread is set to true.

Note*: Platform SDK AppTemplate AB does not use this option.


THROTTLE_THRESHOLD_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> THROTTLE_THRESHOLD_OPT
Specifies the size of the internal log queue at which the verbose level is to be reduced so as to lessen the load generated by logging. If this option is set to 0 (zero), throttling does not occur. For more information about log throttling, refer to the Framework 8.5 Management Layer User’s Guide.

Default Value:5000
Valid Values:0–10000
Changes Take Effect:Immediately

Note: This option applies only if enable-thread is set to true.

Note*: Platform SDK AppTemplate AB does not use this option.


LOG4j2_CONFIG_PROFILE_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> LOG4j2_CONFIG_PROFILE_OPT
Platform SDK AppTemplate AB specific option.

Note: This option is experimental and its value procession may get changed.


X_CONN_DEBUG_ALL_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_ALL_OPT
Generates Debug log records about open connection, socket select, timer creation and deletion, write, security-related, and DNS operations, and connection library function calls. This option is the same as enabling or disabling all of the previous x-conn-debug- options.

Default Value:0
Valid Values: 0- Log records are not generated
1- Log records are generated
Changes Take Effect:After restart

Warning! Use this option only when requested by Genesys Customer Care

Note*: Platform SDK AppTemplate AB does not use this option.


X_CONN_DEBUG_API_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_API_OPT
Generates Debug log records about connection library function calls.

Default Value:0
Valid Values: 0- Log records are not generated
1- Log records are generated
Changes Take Effect:After restart

Warning! Use this option only when requested by Genesys Customer Care

Note*: Platform SDK AppTemplate AB does not use this option.


X_CONN_DEBUG_DNS_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_DNS_OPT
Generates Debug log records about DNS operations.

Default Value:0
Valid Values: 0- Log records are not generated
1- Log records are generated
Changes Take Effect:After restart

Warning! Use this option only when requested by Genesys Customer Care

Note*: Platform SDK AppTemplate AB does not use this option.


X_CONN_DEBUG_OPEN_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_OPEN_OPT
Generates Debug log records about "open connection" operations of the application.

Default Value:0
Valid Values: 0- Log records are not generated
1- Log records are generated
Changes Take Effect:After restart

Warning! Use this option only when requested by Genesys Customer Care

Note*: Platform SDK AppTemplate AB does not use this option.


X_CONN_DEBUG_SECURITY_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_SECURITY_OPT
Generates Debug log records about security-related operations, such as Transport Layer Security and security certificates.

Default Value:0
Valid Values: 0- Log records are not generated
1- Log records are generated
Changes Take Effect:After restart

Warning! Use this option only when requested by Genesys Customer Care

Note*: Platform SDK AppTemplate AB does not use this option.


X_CONN_DEBUG_SELECT_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_SELECT_OPT
Generates Debug log records about "socket select" operations of the application.

Default Value:0
Valid Values: 0- Log records are not generated
1- Log records are generated
Changes Take Effect:After restart

Warning! Use this option only when requested by Genesys Customer Care

Note*: Platform SDK AppTemplate AB does not use this option.


X_CONN_DEBUG_TIMERS_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_TIMERS_OPT
Generates Debug log records about the timer creation and deletion operations of the application.

Default Value:0
Valid Values: 0- Log records are not generated
1- Log records are generated
Changes Take Effect:After restart

Warning! Use this option only when requested by Genesys Customer Care

Note*: Platform SDK AppTemplate AB does not use this option.


X_CONN_DEBUG_WRITE_OPT

public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_WRITE_OPT
Generates Debug log records about "write" operations of the application.

Default Value:0
Valid Values: 0- Log records are not generated
1- Log records are generated
Changes Take Effect:After restart

Warning! Use this option only when requested by Genesys Customer Care

Note*: Platform SDK AppTemplate AB does not use this option.


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.