Logging Levels

There are six different logging levels that can be individually enabled. There is a seventh log level configuration option, the "All" option, which enables all logging levels.

The logging level configuration is inheritative. There is a master log level setting for the grid, accessed from the Logging > Log Levels page in the Grid Management Pages. If nothing else is configured, this log level will be the same for each application and each grid node. The grid log levels which are enabled by default are: Error, Warn, Note and Info.

It is possible for each application to define its own log level, which will override the log level of the grid. In a multiple-hosts grid, it is possible to set the log level per host per application.

When enabling the Debug or Trace log levels, it is recommended to do so only for the application to debug and not for the entire grid, due to the amount of log entries generated.

The available logging levels are described in the following sections, in order of decreasing criticality.

Error

Error is reserved for special exceptions/conditions where it is imperative that you can quickly pick out these events. It is intended to be used for error messages which indicate a major problem which must be investigated and resolved and either has stopped or will stop operation of the application.

  • An error has occurred in the program (usually an exception).

  • Severe errors have caused premature termination.

  • Other runtime errors or unexpected conditions have occurred.

It is not possible to turn off the Error log on a global basis.

Warn

An anomalous condition has been detected and the program will attempt to deal with it. This logging level indicates a problem which should be investigated and resolved, but does not seriously impact operation of the application. The Warn level is typically used under the following conditions:

  • When a threshold level is reached.

  • A loss of connectivity occurs that can be repaired by reconnecting.

  • Use of deprecated APIs is detected.

  • Poor use of APIs is detected.

  • Undesirable or unexpected runtime situations occur, but they are not seriously wrong.

Note

The Note log level contains less critical information, which indicates a problem that does not necessarily need to be investigated but should be logged.

Info

The Info level is typically used to output information that is useful to the running and management of your system. It would also be the level used to log entry and exit points in key areas of your application.

Debug

The Debug logging level provides detailed information on the flow through the system used to identify possible errors or misconfiguration in the runtime environment. Debug-enabled logs may contain output information for various critical functions.

The Debug log level should not be activated in normal program operation, since it fills up the log files quickly.

Submitted error reports should preferably contain logs which have the Debug logging level enabled for easier and faster resolution. Normally, if a case is escalated to the development organization, the first thing asked for is trace/debug logs that show the problem.

Trace

The Trace logging level represents the highest level of detailed information on the flow through the system. This level can be used to identify where the call goes, which methods that are involved and output.

The Trace logging level should not be activated in normal program operation, since it fills up the log files quickly.

Submitted error report should preferably contain logs which have Trace enabled for easier and faster resolution. Normally, if a case is escalated to the development organization, the first thing asked for is trace/debug logs that show the problem.