Package sirius.kernel.health

Provides tools to record the system state and to log and handle exceptions.

See: Description

Interface Summary

Interface	Description
ExceptionHandler	Instances registered for this interface will be notified about every exception handled by Exceptions
LogTap	Can be used to "tap" the logging system.

Class Summary

Class	Description
Average	Represents an average value over a given set of values.
CleanLogsTask	Automatically deletes old log files.
Counter	Represents a counter for statistical use.
Exceptions	Central point for handling all system errors and exceptions.
Exceptions.ErrorHandler	Fluent API to create a HandledException based on given parameters The intention is to use a call like: Exceptions.handler() .error(anException) // Sets the exception to handle .to(aLogger) // Sets the logger to use for logging .withNLSKey("nls.key") // Sets the i18n key to create the error message .set("param",value) // Sets a named parameter which occurs in the message .handle(); // logs an creates the HandledException Since none of the methods must be called (except handle() of course), this provides a lot of flexibility and permits to handle several different error situations without having methods with long parameter lists and lots of null values.
Incident	Describes a handled exception generated by Exceptions and passed on to ExceptionHandler.
Log	The logging facade used by the system.
LogMessage	Contains a log message passed from Log to LogTap.
MemoryBasedHealthMonitor	Provides a in-memory store for logs and exceptions.
Microtiming	Performance measurement framework which can be used in development as well as in production systems.
Microtiming.Timing	Simple value class which represents a measured timing.

Exception Summary

Exception	Description
HandledException	An exception which has already been handled (logged and reacted upon) can be represented by HandledException.

Package sirius.kernel.health Description

Provides tools to record the system state and to log and handle exceptions.

The central class for handling exceptions is Exceptions. This provides a central facility to handle all kinds of errors. Additionally, a HandledException can be used to signal, that an error has already been logged and handled and needs no further attention (can be forwarded to the user).

The Log class provides a wrapper over the currently used logging framework. Loggers are auto-configured on startup via the system configuration.

Another essential framework is the Microtiming. This can be used for on-demand profiling (which can even be enabled in production systems). The framework gathers timing data from all kinds of sources (you can of course provide your own) and makes them available in a central place and an aggregated manner.