There are four main target uses of the logs:
- Problem diagnosis by end users and system administrators. This consists of simple logging of common problems that can be fixed or tracked locally, such as running out of resources, security failures, and simple configuration errors.
- Problem diagnosis by field service engineers. The logging information used by field service engineers may be considerably more complex and verbose than that required by system administrators. Typically such information will require extra logging within particular subsystems.
- Problem diagnosis by the development organization. When a problem occurs in the field, it may be necessary to return the captured logging information to the original development team for diagnosis. This logging information may be extremely detailed and fairly inscrutable. Such information might include detailed tracing on the internal execution of particular subsystems.
- Problem diagnosis by developers. The Logging APIs may also be used to help debug an application under development. This may include logging information generated by the target application as well as logging information generated by lower-level libraries. Note however that while this use is perfectly reasonable, the logging APIs are not intended to replace the normal debugging and profiling tools that may already exist in the development environment.
The key elements of this package include:
- Logger: The main entity on which applications make logging calls. A Logger object is used to log messages for a specific system or application component.
- LogRecord: Used to pass logging requests between the logging framework and individual log handlers.
- Handler: Exports LogRecord objects to a variety of destinations including memory, output streams, consoles, files, and sockets. A variety of Handler subclasses exist for this purpose. Additional Handlers may be developed by third parties and delivered on top of the core platform.
- Level: Defines a set of standard logging levels that can be used to control logging output. Programs can be configured to output logging for some levels while ignoring output for others.
- Filter: Provides fine-grained control over what gets logged, beyond the control provided by log levels. The logging APIs support a general-purpose filter mechanism that allows application code to attach arbitrary filters to control logging output.
- Formatter: Provides support for formatting LogRecord objects. This package includes two formatters, SimpleFormatter and XMLFormatter, for formatting log records in plain text or XML respectively. As with Handlers, additional Formatters may be developed by third parties.
The Logging APIs offer both static and dynamic configuration control. Static control enables field service staff to set up a particular configuration and then re-launch the application with the new logging settings. Dynamic control allows for updates to the logging configuration within a currently running program. The APIs also allow for logging to be enabled or disabled for different functional areas of the system. For example, a field service engineer might be interested in tracing all AWT events, but might have no interest in socket events or memory management.
In general, unless otherwise noted in the javadoc, methods and constructors will throw NullPointerException if passed a null argument. The one broad exception to this rule is that the logging convenience methods in the Logger class (the config, entering, exiting, fine, finer, finest, log, logp, logrb, severe, throwing, and warning methods) will accept null values for all arguments except for the initial Level argument (if any).
For an overview of control flow, please refer to the Java Logging Overview
Interface Summary Interface Description FilterA Filter can be used to provide fine grain control over what is logged, beyond the control provided by log levels. LoggingMXBean Deprecated.
LoggingMXBeanis no longer a
platform MXBeanand is replaced with
Class Summary Class Description ConsoleHandlerThis
Handlerpublishes log records to
ErrorManagerErrorManager objects can be attached to Handlers to process any error that occurs on a Handler during Logging. FileHandlerSimple file logging
FormatterA Formatter provides support for formatting LogRecords. HandlerA
Handlerobject takes log messages from a
Loggerand exports them.
LevelThe Level class defines a set of standard logging levels that can be used to control logging output. LoggerA Logger object is used to log messages for a specific system or application component. LoggingPermissionThe permission which the SecurityManager will check when code that is running with a SecurityManager calls one of the logging control methods (such as Logger.setLevel). LogManagerThere is a single global LogManager object that is used to maintain a set of shared state about Loggers and log services. LogRecordLogRecord objects are used to pass logging requests between the logging framework and individual log Handlers. MemoryHandler
Handlerthat buffers requests in a circular buffer in memory.
SimpleFormatterPrint a brief summary of the
LogRecordin a human readable format.
SocketHandlerSimple network logging
StreamHandlerStream based logging
XMLFormatterFormat a LogRecord into a standard XML format.