Logging Framework Design Documentation

The JLF logging framework has three major goals:

1. Provide a way to automatically notify the appropriate persons or processes of problems with code.
2. Provide concise yet meaningful information when notifying people of problems so that they can be corrected with little or no problem recreation and debugging.
3. Support multiple projects, servers, and services, all while isolating developers from this complexity and allowing them to log this information with ideally one but at most two Java source statements.

This article explains in detail the importance of logging and how to go about a process for integrating logging into your application.  See the Logging Framework Quick Start guide to help you integrate the Logging Framework into your application.

The logging framework is near the bottom of the Architectural Layer Diagram, and rests right above the configuration framework (which means that the configuration framework, and the logging framework itself, cannot use the logging framework to report errors or the system may go into an infinite loop!).

See the Logging Framework Class Diagram for the major classes and methods involved in the framework.  The key class is MultiThreadLog, which is wrapped by a singleton instance copy of AppLog,  Logs are serviced by any number of logging mechanisms in a polymorphic hierarchy. The source code for the framework begins here.  Here is the JavaDoc for all of Shared Code, including the configuration framework..