Log Service is a distributed system that records significant events that have occurred on the elements of the cluster. It stores messages associated with a particular service. This module defines nine types of log messages stored in text format. It runs on both dispatcher and server nodes of the cluster.
Log Service defines log messages using a number from 0 to 8:
|
|
Dispatcher |
|
|
Property Key |
Description |
Default Value |
|
|
|
|
|
NormalLogLevel |
Specifies the types of log messages that have normal priority. It is a number from 0 to 7 specifying that log messages within [0, NormalLogLevel] are written in the DefaultNormalFile. For example, if NormalLogLevel is set to 4, log messages that are in [0,4] are written to the DefaultNormalFile, and the rest to the DefaultCriticalFile. |
5 |
|
DefaultNormalFile |
This parameter specifies the filename to which the above messages are written. |
DEFAULT.log |
|
CriticalLogLevel |
Specifies the types of log messages that have critical priority. It is a number from 0 to 7 specifying that log messages within [CriticalLogLevel,7] are written in the DefaultCriticalFile. It has higher priority and overrides NormalLogLevel. For example, if NormalLogLevel is set to 4 and CriticalLogLevel is set to 3, the messages in [3,7] are written to the DefaultCriticalFile and those in [0,2] are written to the DefaultNormalFile. |
3 |
|
DefaultCriticalFile |
This parameter specifies the filename to which the above messages are written. |
DEFAULTCRITICAL.log
|
|
DefaultCriticalLogFileName |
Specifies the filename to which critical log messages are written. This file is used by the Log viewer of the system to display the messages. |
CRITICAL.log |
|
CriticalLogFileName |
Specifies the filename to which critical log messages are written. |
CRITICAL.log |
|
DefaultEmergencyFileName |
Specifies the filename to which emergency log messages are written. This file is used by the Log viewer of the system to display the messages. |
EMERGENCY.log |
|
EmergencyLogFileName |
Specifies the filename to which emergency log messages are written. |
EMERGENCY.log
|
|
DefaultAlertFileName |
Specifies the filename to which alert log messages are written. This file is used by the Log viewer of the system to display the messages. |
ALERT.log |
|
AlertLogFileName |
Specifies the filename to which alert log messages are written. |
ALERT.log |
|
DefaultErrorFileName |
Specifies the filename to which error log messages are written. This file is used by the Log viewer of the system to display the messages.
|
ERROR.log |
|
ErrorLogFileName |
Specifies the filename to which error log messages are written. |
ERROR.log |
|
DefaultWarningFileName |
Specifies the filename to which warning log messages are written. This file is used by the Log viewer of the system to display the messages. |
WARNING.log |
|
WarningLogFileName |
Specifies the filename to which warning log messages are written. |
WARNING.log |
|
DefaultNoticeFileName |
Specifies the filename to which notice log messages are written. This file is used by the Log viewer of the system to display the messages. |
NOTICE.log |
|
NoticeLogFileName |
Specifies the filename to which notice log messages are written. |
NOTICE.log |
|
DefaultInfoFileName |
Specifies the filename to which info log messages are written. This file is used by the Log viewer of the system to display the messages. |
INFO.log |
|
InfoLogFileName |
Specifies the filename to which info log messages are written. |
INFO.log |
|
DefaultDebugFileName |
Specifies the filename to which debug log messages are written. This file is used by the Log viewer of the system to display the messages. |
DEBUG.log |
|
DebugLogFileName |
Specifies the filename to which debug log messages are written. |
DEBUG.log |
|
LogArraySize |
Specifies the size of the array of destinations. |
10 |
|
LogArrayChangeStep |
Specifies the step at which the array size of log messages changes when all existing ones are used. |
10 |
|
MaxBufferedMessagesSize |
Specifies the length of the buffer of log messages in the memory. When the messages exceed the size of the buffer, they are saved in the corresponding file. |
15 |
|
MaxQueueSize |
Specifies the maximum length of the buffer. If it is exceeded, the messages are saved directly in the corresponding file without going first through the buffer. |
1000 |
|
BufferFlushRepeatTime |
Specifies the time at which the messages are saved from the buffer to the appropriate file. It is specified in milliseconds. |
15000 |
|
BufferFlushDelayTime |
Specifies the time after which the log messages from the buffer are saved to the appropriate file. It is specified in milliseconds. |
15000 |
|
ZipDirectory |
Specifies the directory in which the log files are archived. It is relative to the “work” directory of the Log service. |
logBackup |
|
MaxFileLength |
Specifies the maximum size of the log file (in bytes). If it is exceeded, the file is added to the archive.
|
1048576 bytes |
|
MaxDelayTime |
Specifies the maximum period between two consequent archiving of log files. It is specified in milliseconds. |
2592000000 |
|
UnicodeLog |
This is a boolean flag specifying whether to write log records in UNICODE. |
false |
|
UserEncoding |
This property determines the standard according to which all log messages are saved. |
US-ASCII |
|
Dlog |
This property determines whether log messages are displayed. |
false |
|
LogDumpLevel |
Specifies the level of the log type messages to be displayed. Only messages with higher priority from the level specified by this property are displayed. |
3 |
|
LogFilter |
Specifies the name of a service from all services registered with Log Service. This means that only log messages of the specified service are displayed. If no value is given to this property, log messages of all registered services are displayed. |
|
|
LogLevel |
Specifies the level of log messages types that are to be saved. Only message types with higher priority are written. |
6 |
|
UnregisterShutDownTime |
Specifies the time in milliseconds that the Log system waits for all services to unregister before shutting down. |
10000 |
|
|
Server |
|
|
Property Key |
Description |
Default Value |
|
|
|
|
|
NormalLogLevel |
Specifies the types of log messages that have normal priority. It is a number from 0 to 7 specifying that log messages within [0,NormalLogLevel] are written in the DefaultNormalFile. For example, if NormalLogLevel is set to 4, log messages that are in [0,4] are written to the DefaultNormalFile, and the rest to the DefaultCriticalFile. |
5 |
|
DefaultNormalFile |
Specifies the filename to which the above messages are written. |
DEFAULT.log |
|
CriticalLogLevel |
Specifies the types of log messages that have critical priority. It is a number from 0 to 7 specifying that log messages within [CriticalLogLevel,7] are written in the DefaultCriticalFile. It has higher priority and overrides NormalLogLevel. For example, if NormalLogLevel is set to 4 and CriticalLogLevel is set to 3, the messages in [3,7] are written to the DefaultCriticalFile and those in [0,2] are written to the DefaultNormalFile. |
3 |
|
DefaultCriticalFile |
Specifies the filename to which the above messages are written. |
DEFAULTCRITICAL.log
|
|
DefaultCriticalLogFileName |
Specifies the filename to which critical log messages are written. This file is used by the Log viewer of the system to display the messages. |
CRITICAL.log |
|
CriticalLogFileName |
Specifies the filename to which critical log messages are written. |
CRITICAL.log |
|
DefaultEmergencyFileName |
Specifies the filename to which emergency log messages are written. This file is used by the Log viewer of the system to display the messages. |
EMERGENCY.log |
|
EmergencyLogFileName |
Specifies the filename to which emergency log messages are written. |
EMERGENCY.log
|
|
DefaultAlertFileName |
Specifies the filename to which alert log messages are written. This file is used by the Log viewer of the system to display the messages. |
ALERT.log |
|
AlertLogFileName |
Specifies the filename to which alert log messages are written. |
ALERT.log |
|
DefaultErrorFileName |
Specifies the filename to which error log messages are written. This file is used by the Log viewer of the system to display the messages. |
ERROR.log |
|
ErrorLogFileName |
Specifies the filename to which error log messages are written. |
ERROR.log |
|
DefaultWarningFileName |
Specifies the filename to which warning log messages are written. This file is used by the Log viewer of the system to display the messages. |
WARNING.log |
|
WarningLogFileName |
Specifies the filename to which warning log messages are written. |
WARNING.log |
|
DefaultNoticeFileName |
Specifies the filename to which notice log messages are written. This file is used by the Log viewer of the system to display the messages. |
NOTICE.log |
|
NoticeLogFileName |
Specifies the filename to which notice log messages are written. |
NOTICE.log |
|
DefaultInfoFileName |
Specifies the filename to which info log messages are written. This file is used by the Log viewer of the system to display the messages. |
INFO.log |
|
InfoLogFileName |
Specifies the filename to which info log messages are written. |
INFO.log |
|
DefaultDebugFileName |
Specifies the filename to which debug log messages are written. This file is used by the Log viewer of the system to display the messages. |
DEBUG.log |
|
DebugLogFileName |
Specifies the filename to which debug log messages are written. |
DEBUG.log |
|
LogArraySize |
Specifies the size of the array of destinations. |
10 |
|
LogArrayChangeStep |
Specifies the step at which the array size of log messages changes, when all existing ones are used. |
10 |
|
MaxBufferedMessagesSize |
Specifies the length of the buffer of log messages in the memory. When the messages exceed the size of the buffer, they are saved in the corresponding file. |
15 |
|
MaxQueueSize |
Specifies the maximum length of the buffer. If it is exceeded, the messages are saved directly in the corresponding file without going first through the buffer. |
1000 |
|
BufferFlushRepeatTime |
Specifies the period at which the messages are saved from the buffer to the appropriate file. It is specified in milliseconds. |
15000 |
|
BufferFlushDelayTime |
Specifies the period after which the log messages from the buffer are saved to the appropriate file. It is specified in milliseconds. |
15000 |
|
ZipDirectory |
Specifies the directory in which the log files are archived. It is relative to the “work” directory of the Log service. |
logBackup |
|
MaxFileLength |
Specifies the maximum size of the log file (in bytes). If it is exceeded, the file is added to the archive.
|
1048576 bytes |
|
MaxDelayTime |
Specifies the maximum period between two consequent archiving of log files. It is specified in milliseconds. |
2592000000 |
|
UnicodeLog |
This is a boolean flag specifying whether to write log records in UNICODE. |
false |
|
UserEncoding |
This property determines the standard according to which all log messages are saved, unless a specific standard is set for the log messages of a particular service (see HttpEncoding property). |
US-ASCII |
|
(Http)Encoding |
This property determines the standard according to which HTTP Service log messages are saved.
Note:
A similar property (of type ServiceName +Encoding) might exist for any service that uses Log Service and specifies the encoding for its log messages explicitly. |
US-ASCII |
|
Dlog |
This property determines whether log messages are displayed. |
false |
|
LogDumpLevel |
Specifies the level of the log type messages to be displayed. Only messages with higher priority from the level specified by this property are displayed. |
2 |
|
LogFilter |
Specifies the name of a service from all services registered with Log Service. This means that only log messages of the specified service are displayed. If no value is given to this property, log messages of all registered services are displayed. |
|
|
LogLevel |
Specifies the level of log messages types that are to be saved. Only message types with higher priority are saved. |
6 |
|
UnregisterShutDownTime |
Specifies the time in milliseconds that the Log system waits for all services to unregister before shutting down. |
10000 |
|
|
|
|
Log Service can be administered using the Shell commands from the
LOG
command group as well.
Note: For information on Log shell commands, refer to the Shell Commands Reference section.
../cluster/dispatcher/services/log/properties
Log Service properties specified in the
Visual Administrator
section can be set from this property file as well.
../cluster/server/services/log/properties
Log Service properties specified in the
Visual Administrator
section can be set from this property file as well.