LogLevel (openMDX/Core API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.openmdx.kernel.log
Interface LogLevel

public interface LogLevel

System Event Categories

The logging system provides six system event categories.

CRITICAL_ERROR_LEVEL (Level 1)
The system encountered a critical error at this logging level, which affects the accuracy, integrity, reliability, or capability of the system. Someone should be paged to address the error as soon as possible.
Critical errors must explicitely be logged by the application.
ERROR_LEVEL (Level 2)
The system encountered an unexpected error at this logging level, which probably means the code intercepted an error it cannot handle. This error is not of a critical nature and can be recovered from automatically.
Someone should probably be emailed to resolve the error in the near future to increase the reliability of the product.
Errors must not explicitely be logged by the application. Only the SvcError class implicitely logs at this level, when its log flag is set to true.
WARNING_LEVEL (Level 3)
The system encountered an expected error situation. The system recovered from it but the fact that it happened should be recorded to see how frequent it happens.
Warnings must not explicitely be logged by the application. Only the SvcException class implicitely logs at this level, when its log flag is set to true.
INFO_LEVEL (Level 4)
Normal logging level. All interesting periodic events should be logged at this level so someone looking through the log can see the amount and kind of processing happening in the system.
The application may log at this level. E.g. the application framework logs server start, stop and command line options at this level.
DETAIL_LEVEL (Level 5)
Moderately detailed logging level to be used to help debug typical problems in the system. Not so detailed that the big picture gets lost.
TRACE_LEVEL (Level 6)
Most detailed logging level. Everything sent to the log will be logged. Use this level to trace system execution for really nasty problems.
The application may log at this level. E.g. SQL traces.
DO NOT "method-level" trace (that is, logging the entrance and exit to each method). Actually the SvcException provides enough stack trace information in case of errors.
LOG_PERFORMANCE (independet Level)
Performance logging level to be used to help finding performance problems in the system. This level is handled independently from all other logging levels, meaning that it can be turned on and off without affecting the other levels.
The application may log at this level.
LOG_STATISTICS (independet Level)
Statistics logging level is used to gather statistics information. This level is handled independently from all other logging levels, meaning that it can be turned on and off without affecting the other levels.
The application may log at this level.
LOG_NOTIFICATION (independet Level)
Notification logging level to be used to protocol log framework internal state changes. E.g. Openening and closing of logging mechanisms, changeing logging level, ...
The application MUST NOT log at this level.

Logging configuration

To set up your own logging configuration that differs from the default behaviour, create in the application's start directory a log property file named "XXX.log.properties".

This "XXX.log.properties" sample activates all logging levels up to level 6 (TRACE), enables performance traces and logs to a file:

        LogFileExtension = log
        LogFilePath =
        LogLevel = trace
        java.LoggingMechanism = SharedFileLoggingMechanism
        LogFieldSeparator = |
        LogPerformance = true
        LogStatistics = true
        LogNotification = false

Field Summary
`static int`	`LOG_LEVEL_CRITICAL_ERROR` The system encountered a critical error at this logging level, which affects the accuracy, integrity, reliability, or capability of the system.
`static int`	`LOG_LEVEL_DEACTIVATE` Turns the log completely off, no messages are logged
`static int`	`LOG_LEVEL_DETAIL` Moderately detailed logging level to be used to help debug typical problems in the system.
`static int`	`LOG_LEVEL_ERROR` The system encountered an unexpected error at this logging level, which probably means the code intercepted an error it cannot handle.
`static int`	`LOG_LEVEL_INFO` Normal logging level.
`static int`	`LOG_LEVEL_MAX` Maximal standard log level
`static int`	`LOG_LEVEL_MIN` Minimal standard log level
`static int`	`LOG_LEVEL_TRACE` Most detailed logging level.
`static int`	`LOG_LEVEL_WARNING` The system encountered an expected error situation.
`static int`	`LOG_NOTIFICATION` Notification logging level to be used to protocol log framework internal state changes.
`static int`	`LOG_PERFORMANCE` Performance logging level to be used to help finding performance problems in the system.
`static int`	`LOG_STATISTICS` Statistics logging level to be used to protocol application statistics This level is handled independently from all other logging levels, meaning that it can be turned on and off without affecting the other levels.

Field Detail

LOG_LEVEL_DEACTIVATE

static final int LOG_LEVEL_DEACTIVATE

Turns the log completely off, no messages are logged

See Also:: Constant Field Values

LOG_LEVEL_CRITICAL_ERROR

static final int LOG_LEVEL_CRITICAL_ERROR

The system encountered a critical error at this logging level, which affects the accuracy, integrity, reliability, or capability of the system. Someone should be paged to address the error as soon as possible.

Critical errors must explicitely be logged by the application.

See Also:: Constant Field Values

LOG_LEVEL_ERROR

static final int LOG_LEVEL_ERROR

The system encountered an unexpected error at this logging level, which probably means the code intercepted an error it cannot handle. This error is not of a critical nature and can be recovered from automatically.

Someone should probably be emailed to resolve the error in the near future to increase the reliability of the product.

Errors must explicitely be logged by the application.

See Also:: Constant Field Values

LOG_LEVEL_WARNING

static final int LOG_LEVEL_WARNING

The system encountered an expected error situation. The system recovered from it but the fact that it happened should be recorded to see how frequent it happens.

Warnings must explicitely be logged by the application.

See Also:: Constant Field Values

LOG_LEVEL_INFO

static final int LOG_LEVEL_INFO

Normal logging level. All interesting periodic events should be logged at this level so someone looking through the log can see the amount and kind of processing happening in the system.

The application may log at this level. E.g. the application framework logs start, stop and command line options at this level.

See Also:: Constant Field Values

LOG_LEVEL_DETAIL

static final int LOG_LEVEL_DETAIL

Moderately detailed logging level to be used to help debug typical problems in the system. Not so detailed that the big picture gets lost.

See Also:: Constant Field Values

LOG_LEVEL_TRACE

static final int LOG_LEVEL_TRACE

Most detailed logging level. Everything sent to the log will be logged. Use this level to trace system execution for really nasty problems.

The application may log at this level. E.g. SQL traces.

Avoid method-level tracing (that is, logging the entrance and exit to each method). Actually the BasicException provides enough stack trace information in case of errors.

See Also:: Constant Field Values

LOG_PERFORMANCE

static final int LOG_PERFORMANCE

Performance logging level to be used to help finding performance problems in the system. This level is handled independently from all other logging levels, meaning that it can be turned on and off without affecting the other levels.

The application may log at this level.

See Also:: Constant Field Values

LOG_STATISTICS

static final int LOG_STATISTICS

Statistics logging level to be used to protocol application statistics This level is handled independently from all other logging levels, meaning that it can be turned on and off without affecting the other levels.