public final class LogOptionsDescriptions
extends java.lang.Object
Modifier and Type | Class | Description |
---|---|---|
static class |
LogOptionsDescriptions.OptionDescriptor<OptionValueType> |
A property descriptor class to represent information about
particular property in "log" section of CME Application "Options".
|
Modifier and Type | Field | Description |
---|---|---|
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> |
COMPRESS_METHOD_OPT |
Platform SDK AppTemplate AB specific property to specify method that will be used for archiving log files.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
CUSTOM_MESSAGE_FORMAT_OPT |
Platform SDK AppTemplate AB specific option.
Value of this option is used as a log message pattern if MESSAGE_FORMAT_OPT
option value is equal to "custom ".In comparison with OUTPUT_PATTERN_OPT , this option provides predefined messages
prefix containing timestamp (by TIME_FORMAT_OPT /TIME_CONVERT_OPT ),
and the LMS-style log level. |
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.String> |
DEFAULT_LOGDIR_OPT |
Default root directory for the log files.
|
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.
|
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.
|
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 ). |
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.String> |
OUTPUT_PATTERN_OPT |
Platform SDK AppTemplate AB specific option.
Value of this option is used as a log message pattern if MESSAGE_FORMAT_OPT
option value is equal to "custom ".In comparison with CUSTOM_MESSAGE_FORMAT_OPT , this option does not provide predefined
messages prefix like a timestamp with log level. |
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<java.lang.Boolean> |
USE_NATIVE_LEVELS_OPT |
Platform SDK AppTemplate AB specific option.
It enables support of native log levels (like "Error", "Warn", etc) to be used for non-LMS messages in common LMS events formats instead of LMS levels like "Standard", "Interaction", etc. |
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.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
X_MSGSRV_INTMSGS_LEVEL |
Platform SDK AppTemplate AB specific property to set log messages filter on Message Server Appender
for Platform SDK internal events.
This value should not be lower than INFO level to do not cause unlimited recursion/avalanche. |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> EVENTLOG_HOST_OPT
PsdkLog4j2Configuration
and Log4j2Configurator
.
The log option name (case insensitive): "EventLogHost
", "event-log-host
",
or "event_log_host
".
For example:event-log-host = node-1-virtual-host
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> MESSAGEFILE_OPT
MessageFile
", "message-file
",
or "message_file
".
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. |
message-file = my-app.lmsWarning! An application that does not find its *.lms file at startup cannot generate application-specific log events and send them to Message Server.
public static final LogOptionsDescriptions.OptionDescriptor<VerboseLevel> VERBOSE_OPT
Verbose
".
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 |
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).public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> ALL_OPT
All
".
Default Value: | No default value. |
Valid Values (log output types): | |
stdout | Log events are sent to the Standard output (stdout). |
stderr | Log events are sent to the Standard error output (stderr). |
network | Log 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 |
all = stdout, logfileNote1: 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.VERBOSE_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> ALARM_OPT
Alarm
level. The log output types must be separated by a comma when more than one output is configured.
The log option name (case insensitive): "Alarm
".
Default Value: | No default value. |
Valid Values (log output types): | |
stdout | Log events are sent to the Standard output (stdout). |
stderr | Log events are sent to the Standard error output (stderr). |
network | Log 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 |
alarm = stderr, networkNote1: 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.VERBOSE_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> STANDARD_OPT
Standard
level. The log output types must be separated by a comma when more
than one output is configured.
The log option name (case insensitive): "Standard
".
Default Value: | No default value. |
Valid Values (log output types): | |
stdout | Log events are sent to the Standard output (stdout). |
stderr | Log events are sent to the Standard error output (stderr). |
network | Log 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 |
standard = stdout, logfileNote1: 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.VERBOSE_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> INTERACTION_OPT
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.
The log option name (case insensitive): "Interaction
".
Default Value: | No default value. |
Valid Values (log output types): | |
stdout | Log events are sent to the Standard output (stdout). |
stderr | Log events are sent to the Standard error output (stderr). |
network | Log 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 |
interaction = stdout, logfileNote1: 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.VERBOSE_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> TRACE_OPT
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.
The log option name (case insensitive): "Trace
".
Default Value: | No default value. |
Valid Values (log output types): | |
stdout | Log events are sent to the Standard output (stdout). |
stderr | Log events are sent to the Standard error output (stderr). |
network | Log 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 |
trace = stdout, logfileNote1: 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.VERBOSE_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> DEBUG_OPT
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.
The log option name (case insensitive): "Debug
".
Default Value: | No default value. |
Valid Values (log output types): | |
stdout | Log events are sent to the Standard output (stdout). |
stderr | Log events are sent to the Standard error output (stderr). |
network | Log 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 |
debug = stdout, logfileNote1: 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.VERBOSE_OPT
public static final LogOptionsDescriptions.OptionDescriptor<SegmentationConfig> SEGMENT_OPT
Segment
".
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 |
public static final LogOptionsDescriptions.OptionDescriptor<ExpirationConfig> EXPIRE_OPT
Expire
".
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 |
10
.public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> COMPRESS_METHOD_OPT
CompressMethod
", "compress-method
",
or "compress_method
".
Default Value: | none | |
Valid Values: | none | - No archiving; all generated log files are stored "as-is". |
"gzip " |
- GZip archiving is to be used for "historical" log files. | |
"zip " |
- Zip archiving is to be used for "historical" log files. | |
"zip<digit> " |
- Zip archiving with given compression level is to be used for "historical" log files. | |
Changes Take Effect: | Immediately |
public static final LogOptionsDescriptions.OptionDescriptor<TimeUsage> TIME_CONVERT_OPT
TimeConvert
", "time-convert
",
or "time_convert
".
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 |
public static final LogOptionsDescriptions.OptionDescriptor<TimeFormat> TIME_FORMAT_OPT
2001-07-24T04:58:10.123
".
The log option name (case insensitive): "TimeFormat
", "time-format
",
or "time_format
".
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 |
public static final LogOptionsDescriptions.OptionDescriptor<MessageFormat> MESSAGE_FORMAT_OPT
short
:MessageFormat
", "message-format
",
or "message_format
".
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 |
full
format looks like this:
2002-05-07T18:11:38.196 Standard localhost cfg_dbserver GCTI-00-05060 Application startedA log record in the
short
format looks like this:
2002-05-07T18:15:33.952 Std 05060 Application startedNote: Whether the
full
, short
, or any other format is used,
time is printed in the format specified by the TIME_FORMAT_OPT
option.public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> USE_NATIVE_LEVELS_OPT
UseNativeLevels
",
"use-native-levels
", or "use_native_levels
".
Note: This option is experimental and its value procession may get changed.MESSAGE_FORMAT_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> MESSAGE_HEADER_DELIMITER_OPT
shortdsv
" message format (MESSAGE_FORMAT_OPT
).
The log option name (case insensitive): "MessageHeaderDelimiter
", "message-header-delimiter
",
or "message_header_delimiter
".|
".public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> CUSTOM_MESSAGE_FORMAT_OPT
MESSAGE_FORMAT_OPT
option value is equal to "custom
".OUTPUT_PATTERN_OPT
, this option provides predefined messages
prefix containing timestamp (by TIME_FORMAT_OPT
/TIME_CONVERT_OPT
),
and the LMS-style log level.
The log option name (case insensitive): "CustomMessageFormat
",
"custom-message-format
", or "custom_message_format
".
Note: This option is experimental and its value procession may get changed.MESSAGE_FORMAT_OPT
,
MessageFormat.Custom
,
OUTPUT_PATTERN_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> OUTPUT_PATTERN_OPT
MESSAGE_FORMAT_OPT
option value is equal to "custom
".CUSTOM_MESSAGE_FORMAT_OPT
, this option does not provide predefined
messages prefix like a timestamp with log level.
The log option name (case insensitive): "OutputPattern
",
"output-pattern
", or "output_pattern
".
Note: This option is experimental and its value procession may get changed.MESSAGE_FORMAT_OPT
,
MessageFormat.Custom
,
CUSTOM_MESSAGE_FORMAT_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> LOGFILE_ENCODING_OPT
FileEncoding
", "file-encoding
",
or "file_encoding
".UTF-8
".public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> FILE_HEADER_PROVIDER_OPT
FileHeaderProvider
", "file-header-provider
",
or "file_header_provider
".FileHeaderProvider
.public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> BUFFERING_OPT
stderr
and stdout
output.
Setting this option to true increases the output performance.
The log option name (case insensitive): "Buffering
".
Default Value: | true | |
Valid Values: | true | - enables buffering. |
false | - disables buffering. | |
Changes Take Effect: | Immediately |
System.out
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> CHECK_POINT_OPT
CheckPoint
", "check-point
",
or "check_point
".
Default Value: | 1 |
Valid Values: | 0–24 |
Changes Take Effect: | Immediately |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> ENABLE_THREAD_OPT
EnableThread
", "enable-thread
",
or "enable_thread
".
Default Value: | false |
Valid Values: | true , false |
Changes Take Effect: | Immediately |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> ENABLE_LOCATION_FOR_THREAD_OPT
ENABLE_THREAD_OPT
.
The log option name (case insensitive): "EnableLocationForThread
",
"enable-location-for-thread
", or "enable_location_for_thread
".
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.ENABLE_THREAD_OPT
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> KEEP_STARTUP_FILE_OPT
KeepStartupFile
",
"keep-startup-file
", or "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 |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> MEMORY_OPT
Memory
".
Default Value: | No default value |
Valid Values: | <string> (memory file name) |
Changes Take Effect: | Immediately |
*.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 support this option.public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> MEMORY_STORAGE_SIZE_OPT
MemoryStorageSize
",
"memory-storage-size
", or "memory_storage_size
".
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 |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> NO_MEMORY_MAPPING_OPT
NoMemoryMapping
",
"no-memory-mapping
", or "no_memory_mapping
".
Default Value: | false |
Valid Values: | true , false |
Changes Take Effect: | At restart |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> PRINT_ATTRIBUTES_OPT
true
enables audit capabilities, but negatively affects performance.PrintAttributes
",
"print-attributes
", or "print_attributes
".
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 |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> SNAPSHOT_OPT
Snapshot
".
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 |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> SPOOL_OPT
Spool
".
Default Value: | The application’s working directory |
Valid Values: | Any valid folder, with the full path to it |
Changes Take Effect: | Immediately |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> THROTTLE_PERIOD_OPT
ThrottlePeriod
",
"throttle-period
", or "throttle_period
".
Default Value: | 30 |
Valid Values: | 0–3600 |
Changes Take Effect: | Immediately |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> THROTTLE_THRESHOLD_OPT
ThrottleThreshold
",
"throttle-threshold
", or "throttle_threshold
".
Default Value: | 5000 |
Valid Values: | 0–10000 |
Changes Take Effect: | Immediately |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> LOG4j2_CONFIG_PROFILE_OPT
Log4j2ConfigProfile
",
"log4j2-config-profile
", or "log4j2_config_profile
".
Note: This option is experimental and its value procession may get changed.public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> DEFAULT_LOGDIR_OPT
STANDARD_OPT
,
INTERACTION_OPT
, DEBUG_OPT
, etc../
", or "../
".default-logdir
".
Platform SDK AppTemplate AB specific option.
The log option name (case insensitive): "DefaultLogdir
",
"default-logdir
", or "default_logdir
".public static final LogOptionsDescriptions.OptionDescriptor<java.lang.String> X_MSGSRV_INTMSGS_LEVEL
msgsrv_intMsgsLevel
".Default Value: | "info " |
Valid Values: | "info ", "warn ", "error ", "fatal ",
"off " |
Changes Take Effect: | Immediately |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_ALL_OPT
x-conn-debug-all
",
or "x_conn_debug_all
".
Default Value: | 0 | |
Valid Values: | 0 | - Log records are not generated |
1 | - Log records are generated | |
Changes Take Effect: | After restart |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_API_OPT
x-conn-debug-api
",
or "x_conn_debug_api
".
Default Value: | 0 | |
Valid Values: | 0 | - Log records are not generated |
1 | - Log records are generated | |
Changes Take Effect: | After restart |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_DNS_OPT
x-conn-debug-dns
",
or "x_conn_debug_dns
".
Default Value: | 0 | |
Valid Values: | 0 | - Log records are not generated |
1 | - Log records are generated | |
Changes Take Effect: | After restart |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_OPEN_OPT
x-conn-debug-open
",
or "x_conn_debug_open
".
Default Value: | 0 | |
Valid Values: | 0 | - Log records are not generated |
1 | - Log records are generated | |
Changes Take Effect: | After restart |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_SECURITY_OPT
x-conn-debug-security
",
or "x_conn_debug_security
".
Default Value: | 0 | |
Valid Values: | 0 | - Log records are not generated |
1 | - Log records are generated | |
Changes Take Effect: | After restart |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_SELECT_OPT
x-conn-debug-select
",
or "x_conn_debug_select
".
Default Value: | 0 | |
Valid Values: | 0 | - Log records are not generated |
1 | - Log records are generated | |
Changes Take Effect: | After restart |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_TIMERS_OPT
x-conn-debug-timers
",
or "x_conn_debug_timers
".
Default Value: | 0 | |
Valid Values: | 0 | - Log records are not generated |
1 | - Log records are generated | |
Changes Take Effect: | After restart |
public static final LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> X_CONN_DEBUG_WRITE_OPT
x-conn-debug-write
",
or "x_conn_debug_write
".
Default Value: | 0 | |
Valid Values: | 0 | - Log records are not generated |
1 | - Log records are generated | |
Changes Take Effect: | After restart |
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.