Module org.refcodes.logger
Package org.refcodes.logger
package org.refcodes.logger
This artifact provides flexible logging of any data to any data sink
(including files, databases or the console). It supports straight forward,
composite (clustering) or partitioning functionality provided by different
implementations of the
Logger type. The
RuntimeLogger type harnesses the
Logger type for logging your runtime log messages
and integrates with SLF4J seamlessly (and
may also act as an alternative datasink to log to when using
SLF4J).
Please refer to the refcodes-logger: Fancy runtime-logs and highly scalable cloud logging documentation for an up-to-date and detailed description on the usage of this artifact.
-
ClassDescriptionPredefined layouts passed to logger implementation supporting
ColumnLayoutmodes.Provides an accessor for a column layout property.Provides a builder method for a column layout property returning the builder for applying multiple build operations.Provides a mutator for a column layout property.Provides a column layout property.Thrown in case the record cannot be logged as a specific implementation might expect some dedicatedColumninstances to be contained in the provided Record.TheLogDecoratorprovides means to beautify or enrich logs for example when printing user friendly logs to the console.Logger<T>TheLoggerinterface defines those methods required for an atomic (sub-)logger to implement.LoggerAccessor<L extends Logger<?>>Provides an accessor for aLoggerproperty.LoggerAccessor.LoggerMutator<L extends Logger<?>>Provides a mutator for aLoggerproperty.LoggerAccessor.LoggerProperty<L extends Logger<?>>Provides aLoggerproperty.TheLoggerCompositeis a ready to use implementation of a compositeLoggerextending theAbstractLoggerComposite.LoggerFactory<L extends Logger<?>>ALoggerFactorydefines the methods required to factorLoggerinstances.Specialization and instantiateable (non abstract) implementation of theAbstractLoggerFactoryCompositecreating compositeLoggerinstances.Defines default loggerHeader.Thrown in case instantiating aLogger(RuntimeLogger) failed, e.g. theRuntimeLoggerSingletontries to construct aRuntimeLoggerfrom a bean configuration file (or a SpringRuntimeLoggerSingleton tries to construct aRuntimeLoggerfrom a bean configuration context file) and fails doing so (due to missing or "wrong" configuration file).The ClassLoggerRuntimeException.The Class LoggerUtility.This enumeration defines the various log priorities to be used by the application logger.Provides an accessor for aLogPriorityproperty.Provides a mutator for aLogPriorityproperty.Provides aLogPriorityproperty.The aMessage logger is the generic version of theRuntimeLogger.PartedLogger<T,P extends T> ThePartedLoggeris a ready to use implementation of a partedLoggerextending theAbstractPartedLogger.PartedQueryLogger<T,P extends T> ThePartedQueryLoggeris a ready to use implementation of a partedQueryLoggerextending theAbstractPartedQueryLogger.PartedTrimLogger<T,P extends T> ThePartedTrimLoggeris a ready to use implementation of a partedTrimLoggerextending theAbstractPartedTrimLogger.QueryLogger<T>TheQueryLoggerextends theLogger; providing additional functionality for querying once logged dataRecordsby specifying queryCriteriaor other query restrictions.TheQueryLoggerCompositeis a ready to use implementation of a compositeQueryLoggerextending theAbstractQueryLoggerComposite.Implementation of theAbstractLoggerFactoryCompositecreating compositeQueryLoggerinstances.Plain simple interface for logging out runtime information generated by software systems.Provides an accessor for aRuntimeLoggerproperty.Provides a mutator for aRuntimeLoggerproperty.Provides aRuntimeLoggerproperty.ARuntimeLoggerFactorydefines the methods required to factorRuntimeLoggerinstances.You configure yourRuntimeLoggerFactoryImplby providing a "runtimelogger.ini" file (see "http://www.refcodes.org/refcodes/refcodes-logger") in one of those locations relative to your main class's location: . .The singleton of theRuntimeLoggerFactoryImplfor easyRuntimeLoggercreation.TheRuntimeLoggerHandlerprovides aHandlerfor the JUL Framework.The Class RuntimeLoggerHeader.The default implementation of theRuntimeLoggerinterface to be configured with a (back-end)Logger.ThisRuntimeLoggerSingletonprovides aRuntimeLoggersingleton configured by a "runtimelogger-config.xml" file find in one of the several locations relative to your application's base directory: The applications base directory (where your JAR or your classes reside) is taken and a list of directories (as defined in theFolders.CONFIG_DIRS) relative to this base directory is generated : The actual directories being looked at (in case them exist) are as follows, relative to your applications base directory: ..Very plain implementation of the logger interface, mainly used as fallbackLogger.TrimLogger<T>TheTrimLoggerextends theQueryLoggerwith the functionality to removeRecordinstances previously being logged by providing the accordingCriteria.TheTrimLoggerCompositeis a ready to use implementation of a compositeTrimLoggerextending theAbstractTrimLoggerComposite.Specialization and instantiateable (non abstract) implementation of theAbstractLoggerFactoryCompositecreating compositeTrimLoggerinstances.Thrown in case some other problems regarding logging occurred, e.g. the data sink (physical system where to log to) experiences problems.