Package | Description |
---|---|
org.apache.log4j.layout | |
org.apache.log4j.pattern | |
org.apache.logging.log4j.core.appender |
Log4j 2 Appenders.
|
org.apache.logging.log4j.core.appender.db |
The classes in this package and sub packages provide appenders for various types of databases and methods for
accessing databases.
|
org.apache.logging.log4j.core.appender.db.jdbc |
The JDBC Appender supports writing log events to a relational database using standard JDBC connections.
|
org.apache.logging.log4j.core.appender.mom |
Message oriented middleware appenders.
|
org.apache.logging.log4j.core.appender.mom.jeromq |
Classes and interfaces for ZeroMQ/JeroMQ support.
|
org.apache.logging.log4j.core.appender.nosql |
The NoSQL Appender supports writing log events to NoSQL databases.
|
org.apache.logging.log4j.core.appender.rewrite |
Apache Flume Appender.
|
org.apache.logging.log4j.core.appender.rolling |
Rolling File Appender and support classes.
|
org.apache.logging.log4j.core.appender.rolling.action |
Support classes for the Rolling File Appender.
|
org.apache.logging.log4j.core.appender.routing |
Apache Flume Appender.
|
org.apache.logging.log4j.core.async |
Provides Asynchronous Logger classes and interfaces for low-latency logging.
|
org.apache.logging.log4j.core.config |
Configuration of Log4j 2.
|
org.apache.logging.log4j.core.config.json |
Classes and interfaces supporting configuration of Log4j 2 with JSON.
|
org.apache.logging.log4j.core.config.plugins.convert |
TypeConverter plugins for converter strings into various types.
|
org.apache.logging.log4j.core.config.properties |
Configuration using Properties files.
|
org.apache.logging.log4j.core.config.xml |
Classes and interfaces supporting configuration of Log4j 2 with XML.
|
org.apache.logging.log4j.core.config.yaml |
Classes and interfaces supporting configuration of Log4j 2 with YAML.
|
org.apache.logging.log4j.core.filter |
Log4j 2 Filter support.
|
org.apache.logging.log4j.core.layout |
Log4j 2 Layout support.
|
org.apache.logging.log4j.core.lookup |
Log4j 2 Lookups.
|
org.apache.logging.log4j.core.net |
Log4j 2 network support.
|
org.apache.logging.log4j.core.net.ssl |
Log4j 2 SSL support
|
org.apache.logging.log4j.core.pattern |
Provides classes implementing format specifiers in conversion patterns.
|
org.apache.logging.log4j.core.script |
Log4j 2 Script support.
|
org.apache.logging.log4j.core.util |
Log4j 2 helper classes.
|
org.apache.logging.log4j.couchdb |
The classes in this package contain the Apache CouchDB provider for the NoSQL Appender.
|
org.apache.logging.log4j.mongodb3 |
The classes in this package contain the MongoDB provider for the NoSQL Appender.
|
org.apache.logging.log4j.web |
The classes in this package are responsible for properly initializing and deinitializing Log4j in a Java EE web
application.
|
org.apache.logging.log4j.web.appender |
Modifier and Type | Class | Description |
---|---|---|
class |
Log4j1XmlLayout |
Port of XMLLayout in Log4j 1.x.
|
Modifier and Type | Class | Description |
---|---|---|
class |
Log4j1MdcPatternConverter |
Able to handle the contents of the LogEvent's MDC and either
output the entire contents of the properties, or to output the value of a specific key
within the property bundle when this pattern converter has the option set.
|
class |
Log4j1NdcPatternConverter |
Returns the event's NDC in a StringBuilder.
|
Modifier and Type | Class | Description |
---|---|---|
class |
AppenderSet |
A deferred plugin for appenders.
|
class |
AsyncAppender |
Appends to one or more Appenders asynchronously.
|
class |
ConsoleAppender |
Appends log events to
System.out or System.err using a layout specified by the user. |
class |
CountingNoOpAppender |
No-Operation Appender that counts events.
|
class |
FailoverAppender |
The FailoverAppender will capture exceptions in an Appender and then route the event
to a different appender.
|
class |
FailoversPlugin |
The array of failover Appenders.
|
class |
FileAppender |
File Appender.
|
class |
HttpAppender |
Sends log events over HTTP.
|
class |
MemoryMappedFileAppender |
Memory Mapped File Appender.
|
class |
NullAppender |
An Appender that ignores log events.
|
class |
OutputStreamAppender |
Appends log events to a given output stream using a layout.
|
class |
RandomAccessFileAppender |
File Appender.
|
class |
RollingFileAppender |
An appender that writes to files and can roll over at intervals.
|
class |
RollingRandomAccessFileAppender |
An appender that writes to random access files and can roll over at
intervals.
|
class |
ScriptAppenderSelector |
|
class |
SmtpAppender |
Send an e-mail when a specific logging event occurs, typically on errors or
fatal errors.
|
class |
SocketAppender |
An Appender that delivers events over socket connections.
|
class |
SyslogAppender |
The Syslog Appender.
|
class |
WriterAppender |
Appends log events to a
Writer . |
Modifier and Type | Class | Description |
---|---|---|
class |
ColumnMapping |
A configuration element for specifying a database column name mapping.
|
Modifier and Type | Class | Description |
---|---|---|
class |
ColumnConfig |
A configuration element used to configure which event properties are logged to which columns in the database table.
|
class |
DataSourceConnectionSource |
A
JdbcAppender connection source that uses a DataSource to connect to the database. |
class |
DriverManagerConnectionSource |
A
ConnectionSource that uses a JDBC connection string, a user name, and a password to call
DriverManager.getConnection(String, String, String) . |
class |
FactoryMethodConnectionSource |
A
JdbcAppender connection source that uses a public static factory method to obtain a Connection or
DataSource . |
class |
JdbcAppender |
This Appender writes logging events to a relational database using standard JDBC mechanisms.
|
Modifier and Type | Class | Description |
---|---|---|
class |
JmsAppender |
Generic JMS Appender plugin for both queues and topics.
|
Modifier and Type | Class | Description |
---|---|---|
class |
JeroMqAppender |
Sends log events to one or more ZeroMQ (JeroMQ) endpoints.
|
Modifier and Type | Class | Description |
---|---|---|
class |
NoSqlAppender |
This Appender writes logging events to a NoSQL database using a configured NoSQL provider.
|
Modifier and Type | Class | Description |
---|---|---|
class |
LoggerNameLevelRewritePolicy |
Rewrites log event levels for a given logger name.
|
class |
MapRewritePolicy |
This policy modifies events by replacing or possibly adding keys and values to the MapMessage.
|
class |
PropertiesRewritePolicy |
This policy modifies events by replacing or possibly adding keys and values to the MapMessage.
|
class |
RewriteAppender |
This Appender allows the logging event to be manipulated before it is processed by other Appenders.
|
Modifier and Type | Class | Description |
---|---|---|
class |
CompositeTriggeringPolicy |
Triggering policy that wraps other triggering policies.
|
class |
CronTriggeringPolicy |
Rolls a file over based on a cron schedule.
|
class |
DefaultRolloverStrategy |
When rolling over,
DefaultRolloverStrategy renames files according to an algorithm as described below. |
class |
DirectWriteRolloverStrategy |
When rolling over,
DirectWriteRolloverStrategy writes directly to the file as resolved by the file
pattern. |
class |
NoOpTriggeringPolicy |
|
class |
OnStartupTriggeringPolicy |
Triggers a rollover on every restart, but only if the file size is greater than zero.
|
class |
SizeBasedTriggeringPolicy |
|
class |
TimeBasedTriggeringPolicy |
Rolls a file over based on time.
|
Modifier and Type | Class | Description |
---|---|---|
class |
DeleteAction |
Rollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.
|
class |
IfAccumulatedFileCount |
PathCondition that accepts paths after some count threshold is exceeded during the file tree walk.
|
class |
IfAccumulatedFileSize |
PathCondition that accepts paths after the accumulated file size threshold is exceeded during the file tree walk.
|
class |
IfAll |
Composite
PathCondition that only accepts objects that are accepted by all component conditions. |
class |
IfAny |
Composite
PathCondition that accepts objects that are accepted by any component conditions. |
class |
IfFileName |
PathCondition that accepts files for deletion if their relative path matches either a glob pattern or a regular
expression.
|
class |
IfLastModified |
PathCondition that accepts paths that are older than the specified duration.
|
class |
IfNot |
Wrapper
PathCondition that accepts objects that are rejected by the wrapped component filter. |
class |
PathSortByModificationTime |
PathSorter that sorts path by their LastModified attribute. |
class |
PosixViewAttributeAction |
File posix attribute view action.
|
class |
ScriptCondition |
A condition of the
DeleteAction where a user-provided script selects the files to delete from a provided
list. |
Modifier and Type | Class | Description |
---|---|---|
class |
IdlePurgePolicy |
Policy is purging appenders that were not in use specified time in minutes
|
class |
Route |
A Route to an appender.
|
class |
Routes |
Contains the individual Route elements.
|
class |
RoutingAppender |
This Appender "routes" between various Appenders, some of which can be references to
Appenders defined earlier in the configuration while others can be dynamically created
within this Appender as required.
|
Modifier and Type | Class | Description |
---|---|---|
class |
ArrayBlockingQueueFactory<E> |
Factory for creating instances of
ArrayBlockingQueue . |
class |
AsyncLoggerConfig |
Asynchronous Logger object that is created via configuration and can be
combined with synchronous loggers.
|
static class |
AsyncLoggerConfig.RootLogger |
An asynchronous root Logger.
|
class |
DisruptorBlockingQueueFactory<E> |
Factory for creating instances of
DisruptorBlockingQueue . |
class |
JCToolsBlockingQueueFactory<E> |
Factory for creating instances of BlockingQueues backed by JCTools
MpscArrayQueue . |
class |
LinkedTransferQueueFactory<E> |
Factory for creating instances of
LinkedTransferQueue . |
Modifier and Type | Class | Description |
---|---|---|
class |
AppenderRef |
An Appender reference.
|
class |
AppendersPlugin |
An Appender container.
|
class |
CustomLevelConfig |
Descriptor of a custom Level object that is created via configuration.
|
class |
CustomLevels |
Container for CustomLevelConfig objects.
|
class |
DefaultAdvertiser |
The default advertiser does not do anything.
|
class |
LoggerConfig |
Logger object that is created via configuration.
|
static class |
LoggerConfig.RootLogger |
The root Logger.
|
class |
LoggersPlugin |
Container of Logger objects.
|
class |
PropertiesPlugin |
Handles properties defined in the configuration.
|
class |
Property |
Represents a key/value pair in the configuration.
|
class |
ScriptsPlugin |
A container of Scripts.
|
Modifier and Type | Class | Description |
---|---|---|
class |
JsonConfigurationFactory |
Modifier and Type | Class | Description |
---|---|---|
class |
PropertiesConfigurationFactory |
Creates a PropertiesConfiguration from a properties file.
|
Modifier and Type | Class | Description |
---|---|---|
class |
XmlConfigurationFactory |
Factory to construct an XmlConfiguration.
|
Modifier and Type | Class | Description |
---|---|---|
class |
YamlConfigurationFactory |
Modifier and Type | Class | Description |
---|---|---|
class |
BurstFilter |
The
BurstFilter is a logging filter that regulates logging traffic. |
class |
CompositeFilter |
Composes and invokes one or more filters.
|
class |
DynamicThresholdFilter |
Compares against a log level that is associated with a context value.
|
class |
LevelRangeFilter |
This filter returns the
onMatch result if the level in the LogEvent is in the range of the configured
min and max levels, otherwise it returns onMismatch value . |
class |
MapFilter |
A Filter that operates on a Map.
|
class |
MarkerFilter |
This filter returns the onMatch result if the marker in the LogEvent is the same as or has the
configured marker as a parent.
|
class |
RegexFilter |
This filter returns the onMatch result if the message matches the regular expression.
|
class |
ScriptFilter |
Returns the onMatch result if the script returns True and returns the onMismatch value otherwise.
|
class |
StructuredDataFilter |
Filter based on data in a StructuredDataMessage.
|
class |
ThreadContextMapFilter |
Filter based on a value in the Thread Context Map (MDC).
|
class |
ThresholdFilter |
This filter returns the onMatch result if the level in the LogEvent is the same or more specific
than the configured level and the onMismatch value otherwise.
|
class |
TimeFilter |
Filters events that fall within a specified time period in each day.
|
Modifier and Type | Class | Description |
---|---|---|
class |
CsvLogEventLayout |
A Comma-Separated Value (CSV) layout to log events.
|
class |
CsvParameterLayout |
A Comma-Separated Value (CSV) layout to log event parameters.
|
class |
GelfLayout |
Lays out events in the Graylog Extended Log Format (GELF) 1.1.
|
class |
HtmlLayout |
Outputs events as rows in an HTML table on an HTML page.
|
class |
JsonLayout |
Appends a series of JSON events as strings serialized as bytes.
|
class |
LoggerFields |
A LoggerFields container.
|
class |
MarkerPatternSelector |
Selects the pattern to use based on the Marker in the LogEvent.
|
class |
MessageLayout |
|
class |
PatternLayout |
A flexible layout configurable with pattern string.
|
class |
PatternMatch |
PatternMatch configuration item.
|
class |
Rfc5424Layout |
Formats a log event in accordance with RFC 5424.
|
class |
ScriptPatternSelector |
Selects the pattern to use based on the Marker in the LogEvent.
|
class |
SerializedLayout |
Deprecated.
Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .
|
class |
SyslogLayout |
Formats a log event as a BSD Log record.
|
class |
XmlLayout |
Appends a series of
event elements as defined in the log4j.dtd. |
class |
YamlLayout |
Appends a series of YAML events as strings serialized as bytes.
|
Modifier and Type | Class | Description |
---|---|---|
class |
ContextMapLookup |
Looks up keys from the context.
|
class |
DateLookup |
Formats the current date or the date in the LogEvent.
|
class |
EnvironmentLookup |
Looks up keys from environment variables.
|
class |
JavaLookup |
Looks up keys related to Java: Java version, JRE version, VM version, and so on.
|
class |
JmxRuntimeInputArgumentsLookup |
Maps JVM input arguments (but not main arguments) using JMX to acquire JVM arguments.
|
class |
JndiLookup |
Looks up keys from JNDI resources.
|
class |
Log4jLookup |
Lookup properties of Log4j
|
class |
MainMapLookup |
A map-based lookup for main arguments.
|
class |
MapLookup |
A map-based lookup.
|
class |
MarkerLookup |
Looks-up markers.
|
class |
ResourceBundleLookup |
Looks up keys from resource bundles.
|
class |
StructuredDataLookup |
Looks up keys from
StructuredDataMessage log messages. |
class |
SystemPropertiesLookup |
Looks up keys from system properties.
|
Modifier and Type | Class | Description |
---|---|---|
class |
MulticastDnsAdvertiser |
Advertise an entity via ZeroConf/MulticastDNS and the JmDNS library.
|
class |
SocketAddress |
Plugin to hold a hostname and port (socket address).
|
class |
SocketOptions |
Holds all socket options settable via
Socket methods. |
class |
SocketPerformancePreferences |
Holds all socket options settable via
Socket.setPerformancePreferences(int, int, int) . |
Modifier and Type | Class | Description |
---|---|---|
class |
KeyStoreConfiguration |
Configuration of the KeyStore
|
class |
SslConfiguration |
SSL Configuration
|
class |
TrustStoreConfiguration |
Configuration of the TrustStore
|
Modifier and Type | Class | Description |
---|---|---|
static class |
AbstractStyleNameConverter.Black |
Black style pattern converter.
|
static class |
AbstractStyleNameConverter.Blue |
Blue style pattern converter.
|
static class |
AbstractStyleNameConverter.Cyan |
Cyan style pattern converter.
|
static class |
AbstractStyleNameConverter.Green |
Green style pattern converter.
|
static class |
AbstractStyleNameConverter.Magenta |
Magenta style pattern converter.
|
static class |
AbstractStyleNameConverter.Red |
Red style pattern converter.
|
static class |
AbstractStyleNameConverter.White |
White style pattern converter.
|
static class |
AbstractStyleNameConverter.Yellow |
Yellow style pattern converter.
|
class |
ClassNamePatternConverter |
Formats the class name of the site of the logging request.
|
class |
DatePatternConverter |
Converts and formats the event's date in a StringBuilder.
|
class |
EncodingPatternConverter |
Converter that encodes the output from a pattern using a specified format.
|
class |
EndOfBatchPatternConverter |
Formats the EndOfBatch.
|
class |
EqualsIgnoreCaseReplacementConverter |
Equals ignore case pattern converter.
|
class |
EqualsReplacementConverter |
Equals pattern converter.
|
class |
ExtendedThrowablePatternConverter |
Outputs the Throwable portion of the LoggingEvent as a full stack trace
unless this converter's option is 'short', where it just outputs the first line of the trace, or if
the number of lines to print is explicitly specified.
|
class |
FileDatePatternConverter |
Formats a date by delegating to
DatePatternConverter . |
class |
FileLocationPatternConverter |
Returns the event's line location information in a StringBuilder.
|
class |
FullLocationPatternConverter |
Format the event's line location information.
|
class |
HighlightConverter |
Highlight pattern converter.
|
class |
IntegerPatternConverter |
Formats an integer.
|
class |
LevelPatternConverter |
Returns the event's level in a StringBuilder.
|
class |
LineLocationPatternConverter |
Returns the event's line location information in a StringBuilder.
|
class |
LineSeparatorPatternConverter |
Formats a line separator.
|
class |
LoggerFqcnPatternConverter |
Formats the Logger FQCN.
|
class |
LoggerPatternConverter |
Formats a logger name.
|
class |
MapPatternConverter |
Able to handle the contents of the LogEvent's MapMessage and either
output the entire contents of the properties in a similar format to the
java.util.Hashtable.toString(), or to output the value of a specific key
within the Map.
|
class |
MarkerPatternConverter |
Returns events' full marker string in a StringBuilder.
|
class |
MarkerSimpleNamePatternConverter |
Appends an event's maker name to a StringBuilder.
|
class |
MaxLengthConverter |
Max length pattern converter.
|
class |
MdcPatternConverter |
Able to handle the contents of the LogEvent's MDC and either
output the entire contents of the properties in a similar format to the
java.util.Hashtable.toString(), or to output the value of a specific key
within the property bundle
when this pattern converter has the option set.
|
class |
MessagePatternConverter |
Returns the event's rendered message in a StringBuilder.
|
class |
MethodLocationPatternConverter |
Returns the event's line location information in a StringBuilder.
|
class |
NanoTimePatternConverter |
Converts and formats the event's nanoTime in a StringBuilder.
|
class |
NdcPatternConverter |
Returns the event's NDC in a StringBuilder.
|
class |
ProcessIdPatternConverter |
|
class |
RegexReplacement |
Replace tokens in the LogEvent message.
|
class |
RegexReplacementConverter |
Replacement pattern converter.
|
class |
RelativeTimePatternConverter |
Returns the relative time in milliseconds since JVM Startup.
|
class |
RootThrowablePatternConverter |
Outputs the Throwable portion of the LoggingEvent as a full stack trace
unless this converter's option is 'short', where it just outputs the first line of the trace, or if
the number of lines to print is explicitly specified.
|
class |
SequenceNumberPatternConverter |
Formats the event sequence number.
|
class |
StyleConverter |
Style pattern converter.
|
class |
ThreadIdPatternConverter |
Formats the event thread ID.
|
class |
ThreadNamePatternConverter |
Formats the event thread name.
|
class |
ThreadPriorityPatternConverter |
Formats the event thread priority.
|
class |
ThrowablePatternConverter |
Outputs the Throwable portion of the LoggingEvent as a full stack trace
unless this converter's option is 'short', where it just outputs the first line of the trace, or if
the number of lines to print is explicitly specified.
|
class |
UuidPatternConverter |
Formats the event sequence number.
|
class |
VariablesNotEmptyReplacementConverter |
VariablesNotEmpty pattern converter.
|
Modifier and Type | Class | Description |
---|---|---|
class |
Script |
Container for the language and body of a script.
|
class |
ScriptFile |
Container for the language and body of a script file along with the file location.
|
class |
ScriptRef |
Contains a reference to a script defined elsewhere in the configuration.
|
Modifier and Type | Class | Description |
---|---|---|
class |
KeyValuePair |
Key/Value pair configuration item.
|
Modifier and Type | Class | Description |
---|---|---|
class |
CouchDbProvider |
The Apache CouchDB implementation of
NoSqlProvider . |
Modifier and Type | Class | Description |
---|---|---|
class |
MongoDbProvider |
The MongoDB implementation of
NoSqlProvider . |
Modifier and Type | Class | Description |
---|---|---|
class |
WebLookup |
Modifier and Type | Class | Description |
---|---|---|
class |
ServletAppender |
Logs using the ServletContext's log method
|
Copyright © 1999-2018. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.