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
ColumnLayout
modes.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 dedicatedColumn
instances to be contained in the provided Record.TheLogDecorator
provides means to beautify or enrich logs for example when printing user friendly logs to the console.Logger<T>TheLogger
interface defines those methods required for an atomic (sub-)logger to implement.LoggerAccessor<L extends Logger<?>>Provides an accessor for aLogger
property.LoggerAccessor.LoggerMutator<L extends Logger<?>>Provides a mutator for aLogger
property.LoggerAccessor.LoggerProperty<L extends Logger<?>>Provides aLogger
property.TheLoggerComposite
is a ready to use implementation of a compositeLogger
extending theAbstractLoggerComposite
.LoggerFactory<L extends Logger<?>>ALoggerFactory
defines the methods required to factorLogger
instances.Specialization and instantiateable (non abstract) implementation of theAbstractLoggerFactoryComposite
creating compositeLogger
instances.Defines default loggerHeader
.Thrown in case instantiating aLogger
(RuntimeLogger
) failed, e.g. theRuntimeLoggerSingleton
tries to construct aRuntimeLogger
from a bean configuration file (or a SpringRuntimeLoggerSingleton tries to construct aRuntimeLogger
from a bean configuration context file) and fails doing so (due to missing or "wrong" configuration file).The Class LoggerRuntimeException.The Class LoggerUtility.This enumeration defines the various log priorities to be used by the application logger.Provides an accessor for aLogPriority
property.Provides a mutator for aLogPriority
property.Provides aLogPriority
property.The aMessage logger is the generic version of theRuntimeLogger
.PartedLogger<T,P extends T> ThePartedLogger
is a ready to use implementation of a partedLogger
extending theAbstractPartedLogger
.PartedQueryLogger<T,P extends T> ThePartedQueryLogger
is a ready to use implementation of a partedQueryLogger
extending theAbstractPartedQueryLogger
.PartedTrimLogger<T,P extends T> ThePartedTrimLogger
is a ready to use implementation of a partedTrimLogger
extending theAbstractPartedTrimLogger
.QueryLogger<T>TheQueryLogger
extends theLogger
; providing additional functionality for querying once logged dataRecords
by specifying queryCriteria
or other query restrictions.TheQueryLoggerComposite
is a ready to use implementation of a compositeQueryLogger
extending theAbstractQueryLoggerComposite
.Implementation of theAbstractLoggerFactoryComposite
creating compositeQueryLogger
instances.Plain simple interface for logging out runtime information generated by software systems.Provides an accessor for aRuntimeLogger
property.Provides a mutator for aRuntimeLogger
property.Provides aRuntimeLogger
property.ARuntimeLoggerFactory
defines the methods required to factorRuntimeLogger
instances.You configure yourRuntimeLoggerFactoryImpl
by 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 theRuntimeLoggerFactoryImpl
for easyRuntimeLogger
creation.TheRuntimeLoggerHandler
provides aHandler
for the JUL Framework.The Class RuntimeLoggerHeader.The default implementation of theRuntimeLogger
interface to be configured with a (back-end)Logger
.ThisRuntimeLoggerSingleton
provides aRuntimeLogger
singleton 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>TheTrimLogger
extends theQueryLogger
with the functionality to removeRecord
instances previously being logged by providing the accordingCriteria
.TheTrimLoggerComposite
is a ready to use implementation of a compositeTrimLogger
extending theAbstractTrimLoggerComposite
.Specialization and instantiateable (non abstract) implementation of theAbstractLoggerFactoryComposite
creating compositeTrimLogger
instances.Thrown in case some other problems regarding logging occurred, e.g. the data sink (physical system where to log to) experiences problems.