All Classes and Interfaces
Class
Description
An interface used for abbreviating strings according to different policies.
Builds new appenders dynamically by running SiftingJoranConfigurator instance,
a custom configurator tailored for the contents of the sift element.
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.A minimal context implementation used by certain logback-access components,
mainly SocketServer.
The Access module's internal representation of logging events.
AccessEventDiscriminator's job is to return the value of a designated field
in an
IAccessEvent instance.At present time the followed fields can be designated: COOKIE,
REQUEST_ATTRIBUTE, SESSION_ATTRIBUTE, REMOTE_ADDRESS,
LOCAL_PORT,REQUEST_URI
Most of the work for configuring logback is done by Actions.
This class contains costants used by other 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.
This action adds the two integers at the top of the stack (they are removed)
and pushes the result to the top the stack.
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 ReentrantReadWriteLock based implementation of the
AppenderAttachable interface.Sets a skeleton implementation for appenders.
This application loads a configuration containing some form of
socket appender and then allows the user to enter messages
which will be relayed to remote clients via the appender.
Created with IntelliJ IDEA.
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.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 synchronized implementation of SimpleDateFormat which uses caching internally.
When
Interpreter class is used as the origin of an
ContextAwareImpl instance, then XML locator information is lost.This examples illustrates collaboration between multiple actions through the
common execution context stack.
This examples illustrates collaboration between multiple actions through the
common execution context stack.
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.
Used to keep state about a char sequence.
This class supports mapping character sequences to
regular expressions as appropriate for SimpleDateFormatter.
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.
A client of a
ServerRunner.A visitor for a
Client.Static utility method for
Closeable objects.Interface for tracking various components by key.
The
Compression class implements ZIP and GZ file
compression/decompression methods.ComputationAction1 will print the result of the compuration made by
children elements but only if the compuration itself is named, that is if the
name attribute of the associated computation element is not null.
ComputationAction2 will print the result of the compuration made by
children elements but only if the computation itself is named, that is if the
name attribute of the associated computation element is not null.
A concurrent
ServerRunner.An
SSLServerSocketFactory that configures SSL parameters
(those specified in {@link SSLParametersConfiguration) on each newly
created socket.
<p>
When any of this factory's {@code createServerSocket} methods are invoked,
it calls on a delegate SSLServerSocketFactory to create the socket,
and then sets the SSL parameters of the socket (using the provided
configuration) before returning the socket to the caller.An
SSLSocketFactory that configures SSL parameters
(those covered by SSLParameters) on each newly created socket.This java "application" configures logback using a configuration file
supplied on the class path and logs a few times.
Allows programmatic initialization and configuration of Logback.
ConsoleAppender appends log events to
System.out or
System.err using a layout specified by the user.Created with IntelliJ IDEA.
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.
This 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 simple EventEvaluator implementation that triggers email transmission after
1024 events regardless of event level.
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.
Source of table and column names used in SQL queries generated by
ch.qos.logback.classic.db.DBAppender
Implement this interface to override default table and/or column names used by ch.qos.logback.classic.db.DBAppender.This class helps the HTMLLayout build the CSS link.
This class helps the HTMLLayout build the CSS link.
The default name resolver simply returns the enum passes as parameter
as a lower case string.
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.
Contains mappings for the default type of nested components in
logback-classic.
Default implementation of
SocketConnector.A default
SocketConnector.ExceptionHandler that writes to System.outInstantiate class for define property value.
ShutdownHook implementation that stops the Logback context after a specified
delay.
A strategy for computing a delay.
Implement this interface in order to compute a discriminating value for a
given event of type <E>.
See {@link http://logback.qos.ch/manual/filters.html#DuplicateMessageFilter}
for details.
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.
A 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).This application generates log messages in numbers specified by the
user.
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.
This class is tied to the
fullRequest conversion word.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.
A hello world example using Joran.
A trivial action that writes "Hello world" on the console.
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.
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.
The Access module's internal representation of logging events.
Lump together several fields for use by
NestedBasicPropertyIA.Lump together several fields for use by
NestedComplexPropertyIA.An internal interface used by the GEventEvaluator.
The central interface in logback-classic.
ImplcitActions are like normal (explicit) actions except that are applied
by the parser when no other pattern applies.
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.An InterpretationContext contains the contextual state of a Joran parsing
session.
Allows masking of interrupt flag if previously the flag is already set.
Abstract class which sets the groundwork for janino based evaluations.
A jetty specific implementation of the
ServerAdapter interface.A class that provides access to logback components via JMX.
This discriminator returns the value context as determined by JNDI.
A simple utility class to create and use a JNDI Context.
This JoranConfiguratorclass adds rules specific to logback-access.
JoranConfigurator class adds rules specific to logback-classic.
A JoranConfiguratorBase lays most of the groundwork for concrete
configurators derived from it.
A factory bean for a JSSE
KeyManagerFactory.A factory bean for a JCA
KeyStore.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.
An object that manages a collection of components that implement the
LifeCycle interface.This action converts the value attribute of the associated element to an
integer and pushes the resulting Integer object on top of the execution
context stack.
Load resources (or images) from various sources.
A converters based on a a locally incremented sequence number.
A static utility method that converts a string that describes the
location of a resource into a
URL object.A minimal application making use of log4j and TrivialLog4jAppender.
This class just makes it easier to identify locks associated with logback
when analysing thread dumps.
A minimal application making use of logback-classic.
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.This class is an implementation of tomcat's Valve interface, by extending
ValveBase.
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.
Clients of this class should only use the
LRUMessageCache.getMessageCountAndThenIncrement(java.lang.String) method.Encloses a given set of converter output in magenta using the appropriate ANSI escape codes.
This application generates a number of message many of which are of LEVEL.
Return the event's marker value(s).
Checks whether the marker in the event matches the marker specified by the
user.
An 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.
Converters which can deal only with one type should implement this interface.
This action multiplies the two integers at the top of the stack (they are
removed) and pushes the result on top the stack.
Always returns the NA (not available) string which is "-" in the case
of access conversions.
This action is responsible for tying together a parent object with one of its
simple properties specified as an element but for which there is
no explicit rule.
This action is responsible for tying together a parent object with a child
element for which there is no explicit rule.
This example illustrates the usage of NewRuleAction which allows the Joran
interpreter to learn new rules on the fly.
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.
No operation (NOP) action that does strictly nothing.
A no-operation (nop) StatusListener
Always returns an empty string.
NumberCruncher factors positive integers.
NumberCruncherClient is a simple client for factoring integers.
A simple NumberCruncher implementation that logs its progress when
factoring numbers.
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 on the designated PrintStream.
OutputStreamAppender appends events to a
OutputStream.Given a classname locate associated PackageInfo (jar name, version name).
Parse a token list returning a node chain.
This class is a module-specific implementation of
PatternLayout to allow http-specific patterns
to be used.
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.
This example illustrates the usage of implicit actions.
A rather trivial implicit action which is applicable if an element has a
printme attribute set to true.
This class serves as a base for other actions, which similar to the ANT
task which add/set properties of a given object.
A skeleton implementation for property definers so that they derive from
ContextAwareBase.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
This application loads a configuration containing a
receiver component and logs events received from the remote
appender according to the local configuration.
Reconfigure a LoggerContext when the configuration file changes.
Encloses a given set of converter output in red using the appropriate ANSI escape codes.
This implementation is intended for use in PatternLayout.
A client of a
ServerRunner that receives events from a remote
appender.A
ServerListener for remote appenders.A
ServerRunner that receives logging events from remote appender
clients.A client of a
ServerRunner that receives events from a local
appender and logs them according to local policy.A
ServerListener that accepts connections from remote receiver
component clients.A
ServerRunner that listens for connections from remote receiver
component clients and delivers logging events to all connected clients.A
RemoteReceiverClient that writes serialized logging events to an
OutputStream.Utility class to help solving problems encountered while renaming files.
This class is tied to the
requestContent conversion word.This class is logback's implementation of jetty's RequestLog interface.
The request URI.
The first line of the request.
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 class is tied to the
requestContent conversion word.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 backup 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.
A factory bean for a JCA
SecureRandom generator.An interface to access server-specific methods from
the server-independent AccessEvent.
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.
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 handles elements in configuration files.
Base class for classes implementing a Logback ShutdownHook via extension
This appender can contains other appenders which it can build dynamically
depending on MDC values.
This appender can contains 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.
A minimal configurator extending GenericConfigurator.
Adds custom prefix/suffix to table and column names.
This class implements the
RuleStore interface.A simple
SocketNode based server.A simple
SocketNode based server.A
SimpleSocketServer that supports SSL.SizeBasedTriggeringPolicy looks at size of the file being currently written
to.
Send an e-mail when a specific access event occurs, typically when
certain pages are accessed.
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
IAccessEvent objects to a remote a log server, usually a
SocketNode.Sends
ILoggingEvent objects to a remote a log server, usually a
SocketNode.This application uses a SocketAppender that log messages to a
server on a host and port specified by the user.
This application uses a SocketAppender that log messages to a
server on a host and port specified by the user.
A
Runnable that (re)connects a socket.An exception handler that is notified of all exceptions that occur
during the (re)connection process.
Read
IAccessEvent objects sent from a remote client using Sockets
(TCP).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.
A 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.An appender that listens on a TCP port for connections from remote
loggers.
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
SocketAppender that supports SSL.A
SocketReceiver that supports SSL.The binding of
LoggerFactory class with an actual instance of
ILoggerFactory is performed using information returned by this class.The binding of
MarkerFactory class with an actual instance of
IMarkerFactory is performed using information returned by this class.This implementation is bound to
LogbackMDCAdapter.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.
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.As the "tee" program on Unix, duplicate the request's input stream.
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.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.
Return a steady stream of tokens.
A tomcat specific implementation of the
ServerAdapter interface.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 very simple log4j layout which formats a logging event
by returning the message contained therein.
A very simple logback-classic layout which formats a logging event
by returning the message contained therein.
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.
This class helps the HTMLLayout build the CSS link.
A simple servlet filter that puts the username
found either in the Principal.
Encloses a given set of converter output in white using the appropriate ANSI escape codes.
Generates log4j.dtd compliant XML documents.
Encloses a given set of converter output in yellow using the appropriate ANSI escape codes.