All Classes and Interfaces
Class
Description
An interface used for abbreviating strings according to different policies.
An abstract implementation of the ComponentTracker interface.
Base implementation of
Discriminator that provides basic lifecycle
managementThis is the super class for module specific ServerSocketAppender
implementations can derive from.
An abstract base for module specific
SocketAppender implementations
in other logback modules.An abstract base for module specific
SSLSocketAppender
implementations located in other logback modules.Most of the work for configuring logback is done by Actions.
By throwing an exception an action can signal the Interpreter to skip
processing of all the nested (child) elements of the element associated with
the action causing the exception.
Various utility methods for computing the
AggregationType of a given property or
the class name of a property given implicit rules.AggregationType classifies how one object is contained within another object.
This implementation is intended for use in
FileNamePattern.Interface for attaching appenders to objects.
A
COWArrayList based implementation of the AppenderAttachable
interface.Sets a skeleton implementation for appenders.
Created with IntelliJ IDEA.
Builds new appenders dynamically by running SiftingJoranConfigurator instance,
a custom configurator tailored for the contents of the sift element.
Track appenders by key.
Given a date remove older archived log files.
In order to optimize performance this appender deems events of level TRACE,
DEBUG and INFO as discardable.
This appender and derived classes, log events asynchronously.
Automatically flushes the underlying
ObjectOutputStream
immediately after calling it's
ObjectOutputStream.writeObject(Object) method.BasicConfigurator configures logback-classic by attaching a
ConsoleAppender to the root logger.A very simple
SequenceNumberGenerator based on an AtomicLong
variable.Lightweight pendant to the java.beans.BeanInfo class.
Cache for
BeanDescription instances.Encapsulates creation of
BeanDescription instances.Encapsulates utility methods associated with standard java beans.
Encloses a given set of converter output in black using the appropriate ANSI
escape codes.
Encloses a given set of converter output in blue using the appropriate ANSI
escape codes.
Encloses a given set of converter output in bold blue using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold cyan using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold green using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold magenta using the
appropriate ANSI escape codes.
Encloses a given set of converter output in bold red using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold white using the appropriate
ANSI escape codes.
Encloses a given set of converter output in bold yellow using the appropriate
ANSI escape codes.
A CAS implementation of DateTimeFormatter (previously SimpleDateFormat) which
caches results for the duration of a millisecond.
This class computes caller data returning the result in the form of a
StackTraceElement array.
This converter outputs caller data depending on depth or depth range and
marker data.
This class serves the super-class of all converters in logback.
This abbreviator returns the class name from a fully qualified class name,
removing the leading package name.
Deprecated.
A client of a
ServerRunner.A visitor for a
Client.Static utility method for
Closeable objects.Abstract representation of configuration elements
Interface for tracking various components by key.
The
Compression class implements ZIP and GZ file
compression/decompression methods.A concurrent
ServerRunner.An
SSLServerSocketFactory that configures SSL parameters (those
specified in SSLParametersConfiguration) on each newly created socket.An
SSLSocketFactory that configures SSL parameters (those covered by
SSLParameters) on each newly created socket.This class configuration events which can be of various types such as
CHANGE_DETECTED, CONFIGURATION_STARTED and CONFIGURATION_ENDED.
A listener of
configuration events.In 1.3.9/1.49, ConfigurationModelHandler has been reduced in functionality and no
longer initiates a reconfiguration task.
This is a subclass of
ConfigurationModelHandler offering configuration reloading support.Allows programmatic initialization and configuration of Logback.
ConsoleAppender appends log events to
System.out or
System.err using a layout specified by the user.The set of console output targets.
Various utility methods for processing strings representing context types.
A context is the main anchorage point of all logback components.
An object which has a context and add methods for updating internal status
messages.
A helper class that implements ContextAware methods.
A helper class that implements ContextAware methods.
An interface extending both
PropertyContainer and ContextAwareThis discriminator returns the value context to which this event is attached
to.
This class contains logback's logic for automatic configuration
A class that allows the LoggerFactory to access an environment-based
LoggerContext.
Converts an event to the logger context's name.
An interface that provides access to different contexts.
Holds the context selector for use in the current environment.
A minimal converter which sets up the general interface for derived classes.
This class extends InheritableThreadLocal so that children threads get a copy
of the parent's hashmap.
A GC-free lock-free thread-safe implementation of the
List interface
for use cases where iterations over the list vastly out-number modifications
on the list.Encloses a given set of converter output in cyan using the appropriate ANSI
escape codes.
CyclicBuffer holds values in a cyclic array.
CyclicBufferAppender stores events in a cyclic buffer of user-specified size.
CyclicBufferTracker tracks
CyclicBuffer instances.This class is concerned with computing a regex corresponding to a date
pattern (in
SimpleDateFormat format).Returns a date formatted by SimpleDateFormatter.
Injects missing class names into ImplicitModel instances missing class name.
This class helps the HTMLLayout build the CSS link.
This class serves as a gateway for invocations of a "costly" operation on a
critical execution path.
A registry which maps a property in a host class to a default class.
DefaultProcessor traverses the Model produced at an earlier step and performs actual
configuration of logback according to the handlers it was given.
ShutdownHook implementation that stops the Logback context after a
specified delay.
Default implementation of
SocketConnector.Default implementation of
TimeBasedFileNamingAndTriggeringPolicy
interface extending TimeBasedFileNamingAndTriggeringPolicyBase.Instantiate class for define property value.
Creates
DefineModel instance and populate its name, className and
scope.A strategy for computing a delay.
Defines the relation between a dependee (Model) and a dependency (String).
This is a utility class for writing json logs.
Implement this interface in order to compute a discriminating value for a
given event of type <E>.
See
}
for details.
invalid @link
{@link http://logback.qos.ch/manual/filters.html#DuplicateMessageFilter
Duration instances represent a lapse of time.
This filter allows for efficient course grained filtering based on criteria
such as product name or company name that would be associated with requests
as they are processed.
Echos the incoming object adding a line separator character(s) at the end.
An element path characterizes a traversal path in an XML document.
ElementSelector extends
ElementPath with matching operations such as
ElementSelector.fullPathMatch(ElementPath),
ElementSelector.getPrefixMatchLength(ElementPath) and
ElementSelector.getTailMatchLength(ElementPath).Encoders are responsible for transform an incoming event into a byte array
Created with IntelliJ IDEA.
This exception wraps exceptions thrown while evaluating events.
The value of the
AbstractMatcherFilter.onMatch and AbstractMatcherFilter.onMismatch attributes is set
to FilterReply.NEUTRAL, so that a badly configured evaluator filter
does not disturb the functioning of the filter chain.Evaluates whether a given an event matches user-specified criteria.
Static utility methods for manipulating an
ExecutorService.FileAppender appends log events to a file.
In conjunction with
PropertyAction
sets the named variable to "true" if the file specified by
path property exists, to "false" otherwise.After parsing file name patterns, given a number or a date, instances of this
class can be used to compute a file name according to the file name pattern
and the current date or integer.
Instances of this class represent the size of a file.
A utility class using functionality available since JDK 1.7.
Users should extend this class to implement customized event filtering.
Interface for attaching filters to objects.
Implementation of FilterAttachable.
This enum represents the possible replies that a filtering component in
logback can return.
A default
DelayStrategy that implements a simple fixed delay.When rolling over,
FixedWindowRollingPolicy renames files
according to a fixed window algorithm.Base class for all foreground color setting composite converters.
FormattingInfo instances contain the information obtained when parsing
formatting modifiers in conversion modifiers.
Encloses a given set of converter output in gray using the appropriate ANSI
escape codes.
Encloses a given set of converter output in green using the appropriate ANSI
escape codes.
HardenedObjectInputStream restricts the set of classes that can be
deserialized to a set of explicitly whitelisted classes.
Highlights inner-text depending on the level, in bold red for events of level
ERROR, in red for WARN, in BLUE for INFO, and in the default color for other
levels.
A 2-tuple (a double) consisting of a Class and a String.
HTMLLayout outputs events in an HTML table.
This class is a base class for HTMLLayout classes part of other logback
modules such as logback-classic and logback-access.
An internal interface used by the GEventEvaluator.
The central interface in logback-classic.
Lump together several fields for use by
ImcplicitActionDataForBasicProperty.Action dealing with elements corresponding to implicit rules.
Lump together several fields for use by implicit action and co.
Lump together several fields for use by
ImplicitModelHandler.Populates
ImportModel based on XML input.Insert an env-entry found in JNDI as a new context variable
When asked to convert an integer,
IntegerTokenConverter the
string value of that integer.Allows masking of interrupt flag if previously the flag is already set.
Abstract class which sets the groundwork for janino based evaluations.
This discriminator returns the value context as determined by JNDI.
A simple utility class to create and use a JNDI Context.
JoranConfigurator class adds rules specific to logback-classic.
A JoranConfiguratorBase lays most of the groundwork for concrete
configurators derived from it.
This class contains constants used by Joran components.
http://ndjson.org/ https://datatracker.ietf.org/doc/html/rfc8259
A factory bean for a JSSE
KeyManagerFactory.A factory bean for a JCA
KeyStore.Convert the contents of
KeyValuePair list to a String.Defines the set of levels recognized by logback-classic, that is
Level.OFF, Level.ERROR, Level.WARN, Level.INFO, Level.DEBUG,
Level.TRACE and Level.ALL.Action to handle the element nested within element.
Propagate level changes made to a logback logger into the equivalent logger
in j.u.l.
Return the event's level.
A class that filters events by the level equality.
Utility methods for transforming string values to Level.
Components supporting start/stop implement this interface.
An object that manages a collection of components that implement the
LifeCycle interface.Load resources (or images) from various sources.
A converters based on a locally incremented sequence number.
A static utility method that converts a string that describes the location of
a resource into a
URL object.Contains mappings for the default type of nested components in
logback-classic.
This class just makes it easier to identify locks associated with logback
when analysing thread dumps.
A Mapped Diagnostic Context, or MDC in short, is an instrument for
distinguishing interleaved log output from different sources.
A Mapped Diagnostic Context, or MDC in short, is an instrument for
distinguishing interleaved log output from different sources.
Attaches a new instance of
LogbackServletContextListener to the
current web-applications ServletContext.Allows for graceful shutdown of the
LoggerContext associated with
this web-app.Action which handles elements in configuration files.
LoggerContext glues many of the logback-classic components together.
A servlet filter that puts the environment dependent LoggerContext in a
ThreadLocal variable, removing it after the request is processed.
LoggerContextVO offers a restricted view of LoggerContext intended to be
exposed by LoggingEvent to remote systems.
Utility class for analysing logger names.
An interface that allows Logger objects and LoggerSer objects to be used the
same way be client of the LoggingEvent object.
The internal representation of logging events.
A read-only and serializable implementation of
ILoggingEvent.Used by SMTPAppender for authentication purposes.
Encloses a given set of converter output in magenta using the appropriate
ANSI escape codes.
Return the event's marker value(s).
Checks whether the marker in the event matches the marker specified by the
user.
A helper class to be used in conjunction with
JaninoEventEvaluatorAn abstract class containing support for
MatchingFilter.onMatch on
MatchingFilter.onMismatch attributes, shared by many but not all turbo filters.MDCBasedDiscriminator essentially returns the value mapped to an MDC key.
This class allows output for a given MDC value.
A servlet filter that inserts various values retrieved from the incoming http
request into the MDC.
Bean pairing an MDC value with a log level.
Return the event's formatted message.
Outputs the number of microseconds of the timestamp.
Abstract representation of configuration elements
For a given DefaultProcessor instance link a
Model class to a
ModelHandler instance for
logback-classic.For a given DefaultProcessor instance link a
Model class to
a ModelHandler instance in logback-core.Converters which can deal only with one type should implement this interface.
In case abbreviation service is requested, NamedConverter will convert fully
qualified class names to their abbreviated from.
If a type (a class) has this annotation, then it will not be automatically
started by Joran at configuration time.
Compiles a previously parsed Node chain into a String.
No operation (NOP) action that does strictly nothing.
A no-operation (nop) StatusListener
Always returns an empty string.
Writes objects to an output.
Factory for
ObjectWriter instances.Print all new incoming status messages on the console (System.out).
Print all new incoming status messages on the error console (System.err).
Evaluates to true when the logging event passed as parameter has level ERROR
or higher.
Evaluates to true when the logging event passed as parameter contains one of
the user-specified markers.
Print all new incoming status messages on the designated PrintStream.
OutputStreamAppender appends events to a
OutputStream.Given a classname locate associated PackageInfo (jar name, version name).
Each tuple represents the association of a parentTag, tag, and a className
which corresponds to default class name rules.
Parse a token list returning a node chain.
A flexible layout configurable with pattern string.
This class provides information about the runtime platform.
Implements this to perform post compile processing for a PatternLayout.
PreSerializationTransformer instances have the responsibility to transform
object into a presumably equivalent serializable representation.
An enumeration of processing phases.
This class serves to build a model for properties which are to the ANT
<property> task which add/set properties of a given object.
A skeleton implementation for property definers so that they derive from
ContextAwareBase.Given a
PropertyModel offers methods to inject properties into a PropertyContainer.General purpose Object property setter.
Thrown when an error is encountered whilst attempting to set a property using
the
PropertySetter utility class.Factory for
Queue instances.A Joran
Action for a SocketReceiver configuration.An abstract base for components that receive logging events from a remote
peer and log according to local policy
A Joran
for a
invalid reference
ModelHandlerSocketReceiver configuration.Reconfigure a LoggerContext when the configuration file changes.
An interface for monitoring new failures and recoveries related to
ResilientOutputStreamBase.Encloses a given set of converter output in red using the appropriate ANSI
escape codes.
This implementation is intended for use in PatternLayout.
Utility class to help solving problems encountered while renaming files.
In conjunction with
PropertyAction
sets the named variable to "true" if the resource specified by the user is available on the class path, "false"
otherwise.This implementation is intended for use in PatternLayout.
RollingCalendar is a helper class to
TimeBasedRollingPolicy or similar
timed-based rolling policies.RollingFileAppender extends FileAppender to back up the
log files depending on RollingPolicy and TriggeringPolicy.A
RollingPolicy is responsible for performing the rolling over
of the active log file.Implements methods common to most, it not all, rolling policies.
A RolloverFailure occurs if, for whatever reason a rollover fails.
As its name indicates, a RuleStore contains 2-tuples consists of a
ElementSelector and an Action.
Interface for sanity checking Models.
An InterpretationContext contains the contextual state of a Joran parsing
session.
SaxEventInterpreter is Joran's driving class for handling "low-level"
SAX events.A factory bean for a JCA
SecureRandom generator.Return the event's sequence number.
Generate sequence numbers
Action which handles <sequenceNumberGenerator> elements in
configuration files.
A listener that accepts
Client connections on behalf of a
ServerRunner.An object that is responsible for the asynchronous execution of a socket
server.
An appender that listens on a TCP port for connections from remote loggers.
A
ServerListener that accepts connections on a ServerSocket.A logging socket server that is configurable using Joran.
Interface describing a logback shutdown hook implementation
Action which builds
ShutdownHookModel based on <shutdownHook>
elements found in configuration files.Base class for classes implementing a Logback ShutdownHook via extension
This appender can contain other appenders which it can build dynamically
depending on MDC values.
This appender serves as the base class for actual SiftingAppenders
implemented by the logback-classic and logback-access modules.
An invocation gate using very simple logic.
This class implements the
RuleStore interface.A simple
SocketNode based server.A
SimpleSocketServer that supports SSL.This class implement
TimeBasedFileNamingAndTriggeringPolicy
interface extending TimeBasedFileNamingAndTriggeringPolicyBase.SizeBasedTriggeringPolicy looks at size of the file being currently written
to.
Send an e-mail when a specific logging event occurs, typically on errors or
fatal errors.
An abstract class that provides support for sending events to an email
address.
Sends
ILoggingEvent objects to a remote a log server, usually a
SocketNode.A
Runnable that (re)connects a socket.An exception handler that is notified of all exceptions that occur during the
(re)connection process.
Read
ILoggingEvent objects sent from a remote client using Sockets
(TCP).A component that receives serialized
ILoggingEvent objects from a
remote appender over a Socket.Various constants used by the SSL implementation.
An interface used to identify components that have an SSL configuration.
An object that has configurable SSL parameters.
An
SSLConfigurable wrapper for an SSLServerSocket.An
SSLConfigurable wrapper for an SSLSocket.A configuration for an
SSLContext.A factory bean for a JSSE
SSLContext.Nested component registry rules for
SSLConfiguration and its
components.A configuration of SSL parameters for an
SSLEngine.A
ServerSocketAppender that supports SSL.This is the base class for module specific ServerSocketAppender
implementations.
A
ServerSocketReceiver that supports SSL.A
SocketAppender that supports SSL.A
SocketReceiver that supports SSL.A StatusListener registered with logback context's
StatusManager will
receive notification of every incoming status message.Collect all incoming events in a list.
Internal error messages (statii) are managed by instances of this interface.
Deprecated.
Same as StatusPrinter but with instance methods instead of static.
Add a status message to the
LoggerContext returned by
LoggerFactory.getILoggerFactory().Static utility methods for working with collections of strings.
Utility class which can convert string into objects.
This appender can be used to send messages to a remote syslog daemon.
Base class for SyslogAppender.
Constants used by syslog daemon and transitively by
SyslogAppenderBase.SyslogOutputStream is a wrapper around the
DatagramSocket class so
that it behaves like an OutputStream.This stream writes its output to the target PrintStream supplied to its
constructor.
Return the events thread (usually the current thread).
Filters events below the threshold level.
Converter which handle throwables should be derived from this class.
Add a stack trace in case the event contains a Throwable.
Convert a throwable into an array of ThrowableDataPoint objects.
This interface lists the set of methods that need to be implemented by
triggering policies which are nested within a
TimeBasedRollingPolicy.Base implementation of
TimeBasedFileNamingAndTriggeringPolicy.TimeBasedRollingPolicy is both easy to configure and quite
powerful.Given a key and a date-and-time pattern, puts a property to the context, with
the specified key and value equal to the current time in the format
corresponding to the specified date-and-time pattern.
TokenConverter offers some basic functionality used by more
specific token converters.Utility class for transforming strings.
A
TriggeringPolicy controls the conditions under which roll-over
occurs.SizeBasedTriggeringPolicy looks at size of the file being currently written
to.
A factory bean for a JSSE
TrustManagerFactory.A layout with a fixed format.
TurboFilter is a specialized filter with a decide method that takes a bunch
of parameters instead of a single event object.
Implementation of TurboFilterAttachable.
Similar to AppenderBase except that derived appenders need to handle thread
synchronization on their own.
This class helps the HTMLLayout build the CSS link.
Helper methods to deal with properties.
Encloses a given set of converter output in white using the appropriate ANSI
escape codes.
An appender used for testing.
Generates log4j.dtd compliant XML documents.
Encloses a given set of converter output in yellow using the appropriate ANSI
escape codes.
StatusPrinter2