<< Click to Display Table of Contents >>
log.properties
Set the log execution and log layout options. Write logs of Server error, OZ Server execution status, and transaction information. Also, write logs of errors occurred while binding the HTTP store data set and XML store. Logs can be written to the console or to the files. Also, the logs can be sent to Windows NT event, Unix system log, and to an email address.
Note To record logs according to the settings of another log library file without using the options below on the Java server, add LogPropertyType=LibraryFile to the log.properties file. |
General Option
Priority
Set the log level priority.
Value |
Description |
|---|---|
DEBUG |
Error, warning, transaction information, and scheduler information. |
ERROR |
Error only. |
INFO |
Error, warning, and transaction information. |
WARN |
Error and warning. |
CONSOLE Option
This option only supports Java server.
CONSOLE.Type
Set the console log type.
Value |
Description |
|---|---|
Stdout |
Logging to the standard output. |
RollingFile |
Logging to a rolling file. |
CONSOLE.Layout
Set the pattern of console log contents. The reserved words that can be set in the pattern are as follows:
Value |
Description |
|---|---|
c |
Log the OZ Server category name. The category name has a hierarchical structure, and the output level can be set. For example, %c{2}. |
d |
Record the date and time. You can use a custom date format or Log4j date formatting options(ABSOLUTE, DATE, ISO8601). |
m |
Log the OZ Server event name. |
n |
Log the newline character. |
p |
Log the log level. |
r |
Log the time(in milliseconds) the OZ Server is running. |
t |
Log the name of the thread that has generated the logging event. |
% |
Log the percent sign. |
CONSOLE.Async
Set whether to use the buffering function.
CONSOLE.File
Set the file path and name of the console log.
ROLLING_FILE Option
ROLLING_FILE.Type
Set the rolling file log type.
Value |
Description |
|---|---|
DailyRollingFile |
Create a log file as defined by the ROLLING_FILE.DatePattern option. |
RollingFile |
Create a log file as defined by the ROLLING_FILE.File option. |
ROLLING_FILE.DatePattern
Set the pattern of the log file name. The patterns that can be set are as follows:
Value |
Description |
|---|---|
yyyy-MM |
The first day of each month |
yyyy-ww |
The first day of each week |
yyyy-MM-dd |
Midnight of every day |
yyyy-MM-dd-HH |
On time every day |
yyyy-MM-ddt |
12 and 24 o'clock every day |
yyyy-MM-dd-HH-mm |
Every minute |
ROLLING_FILE.Layout
Set the rolling file log format. Please refer to the reserved words section of "CONSOLE.Layout".
ROLLING_FILE.File
Set the file path and name of rolling file log.
ROLLING_FILE.Append
Set whether to append the rolling file log to the log file.
ROLLING_FILE.MaxBackupIndex
Set the maximum serial number of backup log files. If the backup log files exceed the maximum serial number, the oldest backup log file is deleted.
ROLLING_FILE.MaxFilesize
Set the maximum file size of the rolling file log. When the size of log file exceeds the maximum size, the current log file is renamed with the serial number and a new log file is started. For example, if the log file name is server.log, it is changed to server.log.1 and new server.log is started.
ROLLING_FILE.MaxHistory
Set the maximum number of days to store log files. If the value is set to greater than 0, the log files created earlier than the maximum number of days to store are automatically deleted. The maximum number of days to store can be set up to 1,000. If the value is set to 0 or a negative number, then log files are not deleted.
ROLLING_FILE.ImmediateFlush
Set whether to immediately append the buffered logs to the log file.
NT_EVENT Option
This option only supports Java server.
NT_EVENT.Type
Set the NT event log type. The value can only be set to "NTEvent".
NT_EVENT.Layout
Set the NT event log format. Please refer to the reserved words section of "CONSOLE.Layout".
NT_EVENT.Threshold
Set the level of log to be sent to NT event. It log level should be higher than the level set by the Priority option.
SYSLOG Option
This option only supports Java server.
SYSLOG.Type
Set the Unix system log type. The value can only be set to "Syslog".
SYSLOG.Layout
set the unix system log format. please refer to the reserved words section of "console.layout".
SYSLOG.Threshold
Set the level of log to be sent to Unix. It log level should be higher than the level set by the Priority option.
SYSLOG.SyslogHost
Set the IP address of Unix host.
SYSLOG.Facility
Set the Unix system log facility for the log message.
SYSLOG.FacilityPrinting
Set whether to enable adding facility.
HTTPSTORE_LOG_FILE Option
HTTPSTORE_LOG_FILE
Set the HTTP store logging file options.
Value |
Description |
|---|---|
AUTO |
Logs all HTTP store data sets. If the server log file name is not set in Query Designer, a log file is created in the form of "OZ_HTTPSTATMENT.LOG.#".(# is serial number starting from 1) |
MANUAL |
Logs only data sets with a server log file name in Query Designer. |
NONE |
Do not log all HTTP store data sets. |
HTTPSTORE_LOG_FILE.LOCATION
Set the path of the log file.
XMLSTORE_LOG_FILE Option
XMLSTORE_LOG_FILE
Set the XML store logging file options.
Value |
Description |
|---|---|
AUTO |
Logs all XML store data sets. If the server log file name is not set in Query Designer, a log file is created in the form of "OZHTTP_XPATH.LOG.#".(# is serial number starting from 1) |
MANUAL |
Logs only data sets with a server log file name in Query Designer. |
NONE |
Do not log all XML store data sets. |
XMLSTORE_LOG_FILE.MAXCOUNT
Set the maximum number of backup files.
XMLSTORE_LOG_FILE.LOCATION
Set the path of the log file.
VIEWER_DEBUG_FILE Option
VIEWER_DEBUG_FILE
Value |
Description |
|---|---|
VIEWER_DEBUG_FILE.LOCATION |
Path to save the viewer debug log file. The viewer debug log file name is applied as the global.processorid parameter value. |
VIEWER_DEBUG_FILE.MAXCOUNT |
Maximum number of viewer debug log files backed up. The maximum storage number can be set up to 4000. |
VIEWER_DEBUG_FILE.VALIDDAYS |
Number of days to keep viewer debug log files. The number of storage days can be set up to 30. |
BUILTIN_LOGGING OPTION
This option only supports Java server.
USE_BUILTIN_LOGGING_ENGINE
Set whether to use BUILTIN_LOGGING.
BUILTIN_LOGGING_CONSOLE
Set whether to output log to the console.
BUILTIN_LOGGING_CONSOLE.CharSet
Set the character set for console log. If you set no, the character set configured in the system is applied.
BUILTIN_LOGGING_FILE
Set whether to output the log to a file.
BUILTIN_LOGGING_FILE.TYPE
Set the log file type.
Value |
Description |
|---|---|
DailyRollingFile |
Create a log file as defined by the BUILTIN_LOGGING_FILE.DatePattern option. |
RollingFile |
Create a log file as defined by the BUILTIN_LOGGING_FILE.LOCATION option. |
BUILTIN_LOGGING_FILE.DatePattern
Set the pattern of the log file name. Please refer to the reserved words section of "ROLLING_FILE.DatePattern".
BUILTIN_LOGGING_FILE.CharSet
Set the character set for the log file. If you set no, the character set configured in the system is applied.
BUILTIN_LOGGING_FILE.Append
Set whether to append the log to a log file.
BUILTIN_LOGGING_FILE.MaxBackupIndex
Set the maximum serial number of the backup log file. If the backup log files exceed the maximum serial number, the oldest backup log file is deleted.
BUILTIN_LOGGING_FILE.MaxFileSize
Set the maximum size of log file. When the size of log file exceeds the maximum size, the current log file is renamed with the serial number and new log file is started. For example, if the log file name is server_oz.log, it is changed to server_oz.log.1 and new server_oz.log is started.
BUILTIN_LOGGING_FILE.MaxHistory
Set the maximum number of days to store log files. If the value is set to greater than 0, the log files created earlier than the maximum number of days to store are automatically deleted. The maximum number of days to store can be set up to 1,000. If the value is set to 0 or a negative number, then log files are not deleted.
BUILTIN_LOGGING_FILE.ImmediateFlush
Set whether to immediately append the buffered logs to the log file.
BUILTIN_LOGGING_FILE.LOCATION
Set the path to the log file.
Mail Option
Mail.alias
Set the alias, which is defined in email.properties. Use to set email information using email.properties other than log.properties.
Mail.active
Set whether to send the log via email.
Mail.fromSend
Set the email address of a person who sent the email.
Mail.toSend
Set the email address of a person to receive the email.
Mail.SMTPServer
Set the SMTP server address of the outbox.
Mail.SMTPServerPort
Set the SMTP server port of the outbox.
Mail.SMTPUserID
Set the user ID to connect to the SMTP server.
Mail.SMTPUserPassword
Set the password of the user ID to connect to the SMTP server.
Mail.SMTPUserID_encrypted
Set whether to encrypt the user ID to connect to the SMTP server.
Mail.SMTPUserPassword_encrypted
Set whether to encrypt the user password to connect to the SMTP server.
Mail.SendRetryCount
Set the number of retries to send an email.
Mail.SendRetryPeriodTime
Set the retry interval in seconds for sending emails.
Mail.PrefixSubjectMessage
Set the prefix of the email subject.
REQUEST-URI Option
REQUEST_URI.LOCATION
Set the path of the file that stores the REQUEST-URI information. And that the file name is created as the request_uri.log file.