uCosminexus Application Server, Web Service Development Guide

[Contents][Glossary][Index][Back][Next]

39.3.4 Importance level and output conditions of logs

This subsection describes the importance level and output conditions of log.

Organization of this subsection
(1) Importance level of log
(2) Operation log/ Exception log/ Maintenance log output conditions
(3) Communication log output conditions

(1) Importance level of log

The following table lists and describes the importance level of the log and the output contents of the message.

Table 39-9 Meaning of importance level and the output contents

No. Importance level Meaning of the message Output contents of the message
1 ERROR This message level indicates an important failure.
This message is output when a problem occurs and the processing cannot continue.
To continue processing, action needs to be taken.
From the message ID indicators, a message with -E is output. The failure information such as the occurred exception and the action is output in the message.
2 WARN This message level indicates a potential problem.
This message is output when a problem occurs, but the processing can continue.
This potential problem does not need immediate action, but it is desirable that action be taken.
From the message ID indicators, a message with -W is output. The failure information such as the occurred exception and the action contents are output in the message.

(Example)
The definition is wrong, so the default value is used.
3 INFO This message level provides information.
Though action is not required, the information that must be notified is output.
A message with message ID indicator -I is output. The contents to be notified are output in the message.

(Example)
The command processing has started.
4 DEBUG This is a DEBUG level message.
This information is used for investigating the cause of failure.
A message with the message ID KDJW99999-I (for Web Services) or KDJJ99999-I (for Web resources) is output.

(Example)
Such as the runtime environment, method trace.

For details about the importance levels of the logs output when the log levels are defined in the configuration file, see 39.3.6 Setting logs.

(2) Operation log/ Exception log/ Maintenance log output conditions

The contents output in the operation log, exception log, and maintenance log change depending on the log definition specified in the action definition file.

The following table lists and describes the output conditions for the operation log, exception log, and maintenance log.

Table 39-10 Output conditions for the operation log/ exception log/ maintenance log (Importance level of the event)

Log types Log definition Importance level of the occurred event
ERROR WARN INFO DEBUG
Operation log
Exception log #
NONE -- -- -- --
ERROR Y -- -- --
WARN Y Y -- --
INFO Y Y Y --
DEBUG Y Y Y Y
Maintenance log NONE -- -- -- --
ALL Y Y Y Y

Legend:
Y: Log is output.
--: Log is not output.

#
The exception log is not output if there is no exception information. Note that the exception information specifies the stack trace of the exception that causes the event to occur.

The default log definition is INFO for the output level of the operation log and exception log and ALL for the output level of the maintenance log. Alternatively, if an event with importance level 'ERROR' occurs in the default settings, log is output in the operation log, maintenance log, and the exception log.

The number of operation and exception logs might increase whenever you change the log definition to NONE, ERROR, WARN, INFO, or DEBUG. Changing the log definition in such a way so that more logs are output is called raising the output level. If the number of logs increases, the overall processing speed might decrease, so when you raise the output level, consider the estimation of the processing speed and the number of files.

(3) Communication log output conditions

The contents output for the communication log change depending on the log definition specified in the action definition file. However, the properties to be specified differ depending on Web Service clients, Web Services, or Web resources. The properties to be set are as follows:

The following table lists and describes the definition of the communication log and the output contents:

Table 39-11 Communication log output conditions (in the Web Service client)

Log definition Output contents
ALL The sent and received messages are always output.
HEADER The HTTP header of the received message is always output.
ERROR_HEADER Output only when the HTTP header of the received message returns an error.
NONE The sent and received messages are not output.

Table 39-12 Communication log output conditions (On a Web Service or Web resource machine)

Log definition Output contents
ALL The sent and received messages of Web Services or Web resources are always output. For a received message, the HTTP request information is also output.
HEADER The HTTP header of the received message and the HTTP request information is always output.
ERROR_HEADER The HTTP header of the received message and the HTTP request information are output only when an error occurs (you can specify for Web Services).
NONE The sent and received messages of Web Services or Web resources are not output.

The number of communication logs increases in the sequence of the log definitions NONE, ERROR_HEADER, HEADER, and ALL. If the number of log increases, the overall processing speed might decrease, so when you change the default log definition, consider the estimation of the processing speed and the number of files.