Plumtree EDK (Enterprise Web Development Kit) 5.4.0 |
|
ILogger Interface
Defines the interface for logger instances, including logging methods and methods to test if various log levels are enabled. To create a logger object call LogFactory.GetLogger()
.
Logging Levels
Severity-Based Logging Levels
-
Debug - A detailed descriptive message reporting a minor step taken in the code and/or providing variable values.
-
Info - Reports a common operation that is of possible interest, for example, serving a new user request or making a remote procedure call. The EDK logging service sends an Info message to the "EDK" component when it is initialized.
-
Warn - Indicates a possible problem which the person responsible for the application should be aware of. The EDK logging service sends a Warn message to the "EDK" component when it is initialized if verbose logging is enabled for logging instrumentation, since the network or application administrator should be aware of possible security implications of sending remote call parameters to a cleartext logging channel.
-
Error - Indicates a definite problem which should to be corrected. The message should state and explain the problem and suggest how to fix it.
-
Fatal - A problem 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 might include inability to obtain necessary system or network resources.
Supplemental Logging Levels
-
Action - Describes that some significant action has been taken. Examples of action traces include the beginning or ending of a startup routine or the start or completion of a new user request. Action traces are usually considered between Info and Warn severities.
-
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.
-
Performance - 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.
Logging Performance Considerations
To minimize the performance cost of logging and avoid unnecessary work when constructing log messages use an overload of one of the logging methods which inserts values into a format string. The overloads help reduce string concatenation. Also wrap any complex message construction in a conditional block to avoid doing the work if there are no listeners at that log level, following the example in the namespace summary.
For a list of all members of this type, see ILogger Members.
Requirements
Namespace: Plumtree.Remote.Logging
Assembly: edk (in edk.dll)
See Also
ILogger Members | Plumtree.Remote.Logging Namespace