Package | Description |
---|---|
com.genesyslab.platform.apptemplate.configuration.log |
Dedicated package for CME Application Logging Options configuration support.
|
Modifier and Type | Field | Description |
---|---|---|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.ALARM_OPT |
Specifies the outputs to which an application sends the log events of the
Alarm
level. |
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.ALL_OPT |
Specifies the outputs to which an application sends all log events.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.BUFFERING_OPT |
Turns on/off operating system file buffering.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.CUSTOM_MESSAGE_FORMAT_OPT |
Platform SDK AppTemplate AB specific option.
Value of this option is used as a log message pattern if LogOptionsDescriptions.MESSAGE_FORMAT_OPT
option value is equal to "custom ".In comparison with LogOptionsDescriptions.OUTPUT_PATTERN_OPT , this option provides predefined messages
prefix containing timestamp (by LogOptionsDescriptions.TIME_FORMAT_OPT /LogOptionsDescriptions.TIME_CONVERT_OPT ),
and the LMS-style log level. |
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.DEFAULT_LOGDIR_OPT |
Default root directory for the log files.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.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
LogOptionsDescriptions.ENABLE_THREAD_OPT . |
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.ENABLE_THREAD_OPT |
Specifies whether to enable or disable the logging thread.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.EXPIRE_OPT |
Determines whether log files expire.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.FILE_HEADER_PROVIDER_OPT |
Platform SDK AppTemplate AB specific property for customization of the
log files header content.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.LOG4j2_CONFIG_PROFILE_OPT |
Platform SDK AppTemplate AB specific option.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.LOGFILE_ENCODING_OPT |
Platform SDK AppTemplate AB specific property for configuration of the
log files encoding.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.MEMORY_STORAGE_SIZE_OPT |
Specifies the buffer size for log output to the memory, if configured.
|
static LogOptionsDescriptions.OptionDescriptor<MessageFormat> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.MESSAGE_HEADER_DELIMITER_OPT |
Platform SDK AppTemplate AB specific property as a parameter for
"
shortdsv " message format (LogOptionsDescriptions.MESSAGE_FORMAT_OPT ). |
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.MESSAGEFILE_OPT |
Specifies the file name for application-specific log events.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.OUTPUT_PATTERN_OPT |
Platform SDK AppTemplate AB specific option.
Value of this option is used as a log message pattern if LogOptionsDescriptions.MESSAGE_FORMAT_OPT
option value is equal to "custom ".In comparison with LogOptionsDescriptions.CUSTOM_MESSAGE_FORMAT_OPT , this option does not provide predefined
messages prefix like a timestamp with log level. |
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.SEGMENT_OPT |
Specifies whether there is a segmentation limit for a log file.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.STANDARD_OPT |
Specifies the outputs to which an application sends the log events of the
Standard level. |
static LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> |
LogOptionsDescriptions.THROTTLE_PERIOD_OPT |
Specifies, in seconds, how long to keep the throttled verbose level.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Integer> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.TIME_CONVERT_OPT |
Specifies the system in which an application calculates the log record time
when generating a log file.
|
static LogOptionsDescriptions.OptionDescriptor<TimeFormat> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.VERBOSE_OPT |
Specifies if log output is created, and if so, the minimum level of log events
generated.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.X_CONN_DEBUG_API_OPT |
Generates Debug log records about connection library function calls.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.X_CONN_DEBUG_DNS_OPT |
Generates Debug log records about DNS operations.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.X_CONN_DEBUG_OPEN_OPT |
Generates Debug log records about "open connection" operations of the application.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.X_CONN_DEBUG_SELECT_OPT |
Generates Debug log records about "socket select" operations of the application.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> |
LogOptionsDescriptions.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> |
LogOptionsDescriptions.X_CONN_DEBUG_WRITE_OPT |
Generates Debug log records about "write" operations of the application.
|
static LogOptionsDescriptions.OptionDescriptor<java.lang.String> |
LogOptionsDescriptions.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. |
Modifier and Type | Field | Description |
---|---|---|
static java.util.Map<java.lang.String,LogOptionsDescriptions.OptionDescriptor<?>> |
LogOptionsDescriptions.OptionDescriptor.OPTIONS_MAP |
Modifier and Type | Method | Description |
---|---|---|
protected java.lang.Boolean |
GAppLoggingOptions.getBooleanOptionValue(LogOptionsDescriptions.OptionDescriptor<java.lang.Boolean> optDescr) |
|
protected <T extends java.lang.Enum<T>> |
GAppLoggingOptions.getEnumOptionValue(LogOptionsDescriptions.OptionDescriptor<T> optDescr) |
|
protected java.lang.String |
GAppLoggingOptions.getFirstOptionValue(LogOptionsDescriptions.OptionDescriptor<?> descriptor) |
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.