IDK Logging Levels
This page summarizes logging levels and their implementation
in IDK logging.
The IDK ILogger
interface provides access to all eight standard logging levels.
Severity-Based Logging Levels
| Logging Level |
Description |
IDK Implementation |
| Debug |
The most common
and numerous log call, used for detailed call tracing and parameter
logging. The message should contain a detailed descriptive message
reporting a minor step taken in the code or providing variable values
(or both). |
Remote call tracing. Function parameters.
ToString() of portlet settings or service request. |
| Info |
Used for normal
but significant events. Reports a common operation that is of possible
interest, for example, serving a new user request or making a remote
procedure call. |
New portlet or service request.
PRC session initialization (login). The IDK logging service sends
an Info message to the "EDK main" logging component when it is initialized. |
| Warn |
Used for minor
problems. Indicates a possible problem which the person responsible
for the application should be aware of. |
Expected
(application) exceptions. Portlet: non-gatewayed request, missing
settings. The IDK logging service sends a Warn message to the 'EDK
main' logging component when it is initialized if verbose logging
is enabled, since the network or application administrator should
be aware of possible security implications of sending remote call
parameters to a cleartext logging channel. |
| Error |
Used for major
problems affecting application function. Indicates a definite problem
that should to be corrected. The message should state and explain
the problem and suggest how to fix it. |
Unexpected
platform exceptions. Portlet: error parsing CSP headers. |
| Fatal |
Used for problems
so severe that the application cannot continue to function. The message
should state the problem, explain why it is a problem, and suggest
how to fix it. Examples include inability to obtain necessary system
or network resources. |
A Fatal message is logged
when an instance of the class configured for the Web Service object
cannot be instantiated. Otherwise reserved for application developer
use. |
Supplemental
Logging Levels
| Logging Level |
Description |
IDK Implementation |
| Action |
Used for significant
actions (between Info and Warn in severity). Examples include the
beginning or ending of a startup routine or the start or completion
of a new user request. |
Initialize an application
component or a new remote session. |
| Function |
Used to bracket
the beginning and ending of a function. Use at the very beginning
and end of methods to illustrate code paths and provide context for
messages occurring between the beginning and ending function messages. |
Dispatching and receiving a remote call, and parsing request
parameters. |
| Performance |
Provides
a millisecond timestamp (for example, operation X took # milliseconds).
Use to measure operations that may be costly in time. Typically a
pair of begin and end performance calls will bracket a blocking call
to an operation of interest such as a disk read or write, remote call,
external process invocation, database query, or large sort operation. |
PRC remote calls. Web request lifecycle for services. |
