Uses of Annotation Type
org.apache.logging.log4j.core.config.plugins.Plugin
Package
Description
Log4j 2 Appenders.
The classes in this package and sub packages provide appenders for various types of databases and methods for
accessing databases.
The JDBC Appender supports writing log events to a relational database using standard JDBC connections.
Message oriented middleware appenders.
Classes and interfaces for ZeroMQ/JeroMQ support.
Classes and interfaces for Kafka appender support.
The NoSQL Appender supports writing log events to NoSQL databases.
Apache Flume Appender.
Rolling File Appender and support classes.
Support classes for the Rolling File Appender.
Apache Flume Appender.
Provides Asynchronous Logger classes and interfaces for low-latency logging.
Configuration of Log4j 2.
Classes and interfaces supporting configuration of Log4j 2 with JSON.
TypeConverter plugins for converter strings into various types.
Configuration using Properties files.
Classes and interfaces supporting configuration of Log4j 2 with XML.
Classes and interfaces supporting configuration of Log4j 2 with YAML.
Log4j 2 Filter support.
Log4j 2 Layout support.
Log4j 2 Lookups.
Log4j 2 network support.
Log4j 2 SSL support
Provides classes implementing format specifiers in conversion patterns.
Log4j 2 Script support.
Log4j 2 helper classes.
-
Uses of Plugin in org.apache.logging.log4j.core.appender
Modifier and TypeClassDescriptionclass
A deferred plugin for appenders.final class
Appends to one or more Appenders asynchronously.final class
Appends log events toSystem.out
orSystem.err
using a layout specified by the user.class
No-Operation Appender that counts events.final class
The FailoverAppender will capture exceptions in an Appender and then route the event to a different appender.final class
The array of failover Appenders.final class
File Appender.final class
Sends log events over HTTP.final class
Memory Mapped File Appender.class
An Appender that ignores log events.final class
Appends log events to a given output stream using a layout.final class
File Appender.final class
An appender that writes to files and can roll over at intervals.final class
An appender that writes to random access files and can roll over at intervals.class
final class
Send an e-mail when a specific logging event occurs, typically on errors or fatal errors.class
An Appender that delivers events over socket connections.class
The Syslog Appender.final class
Appends log events to aWriter
. -
Uses of Plugin in org.apache.logging.log4j.core.appender.db
Modifier and TypeClassDescriptionclass
A configuration element for specifying a database column name mapping. -
Uses of Plugin in org.apache.logging.log4j.core.appender.db.jdbc
Modifier and TypeClassDescriptionfinal class
A configuration element used to configure which event properties are logged to which columns in the database table.final class
AJdbcAppender
connection source that uses aDataSource
to connect to the database.class
AConnectionSource
that uses a JDBC connection string, a user name, and a password to callDriverManager.getConnection(String, String, String)
.final class
AJdbcAppender
connection source that uses a public static factory method to obtain aConnection
orDataSource
.final class
This Appender writes logging events to a relational database using standard JDBC mechanisms. -
Uses of Plugin in org.apache.logging.log4j.core.appender.mom
Modifier and TypeClassDescriptionclass
Generic JMS Appender plugin for both queues and topics. -
Uses of Plugin in org.apache.logging.log4j.core.appender.mom.jeromq
Modifier and TypeClassDescriptionfinal class
Sends log events to one or more ZeroMQ (JeroMQ) endpoints. -
Uses of Plugin in org.apache.logging.log4j.core.appender.mom.kafka
Modifier and TypeClassDescriptionfinal class
Sends log events to an Apache Kafka topic. -
Uses of Plugin in org.apache.logging.log4j.core.appender.nosql
Modifier and TypeClassDescriptionfinal class
This Appender writes logging events to a NoSQL database using a configured NoSQL provider. -
Uses of Plugin in org.apache.logging.log4j.core.appender.rewrite
Modifier and TypeClassDescriptionclass
Rewrites log event levels for a given logger name.final class
This policy modifies events by replacing or possibly adding keys and values to the MapMessage.final class
This policy modifies events by replacing or possibly adding keys and values to the MapMessage.final class
This Appender allows the logging event to be manipulated before it is processed by other Appenders. -
Uses of Plugin in org.apache.logging.log4j.core.appender.rolling
Modifier and TypeClassDescriptionfinal class
Triggering policy that wraps other triggering policies.final class
Rolls a file over based on a cron schedule.class
When rolling over,DefaultRolloverStrategy
renames files according to an algorithm as described below.class
When rolling over,DirectWriteRolloverStrategy
writes directly to the file as resolved by the file pattern.class
class
Triggers a rollover on every restart, but only if the file size is greater than zero.class
final class
Rolls a file over based on time. -
Uses of Plugin in org.apache.logging.log4j.core.appender.rolling.action
Modifier and TypeClassDescriptionclass
Rollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.final class
PathCondition that accepts paths after some count threshold is exceeded during the file tree walk.final class
PathCondition that accepts paths after the accumulated file size threshold is exceeded during the file tree walk.final class
CompositePathCondition
that only accepts objects that are accepted by all component conditions.final class
CompositePathCondition
that accepts objects that are accepted by any component conditions.final class
PathCondition that accepts files for deletion if their relative path matches either a glob pattern or a regular expression.final class
PathCondition that accepts paths that are older than the specified duration.final class
WrapperPathCondition
that accepts objects that are rejected by the wrapped component filter.class
PathSorter
that sorts path by their LastModified attribute.class
File POSIX attribute view action.class
A condition of theDeleteAction
where a user-provided script selects the files to delete from a provided list. -
Uses of Plugin in org.apache.logging.log4j.core.appender.routing
Modifier and TypeClassDescriptionclass
Policy is purging appenders that were not in use specified time in minutesfinal class
A Route to an appender.final class
Contains the individual Route elements.final class
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. -
Uses of Plugin in org.apache.logging.log4j.core.async
Modifier and TypeClassDescriptionclass
Factory for creating instances ofArrayBlockingQueue
.class
Asynchronous Logger object that is created via configuration and can be combined with synchronous loggers.static class
An asynchronous root Logger.class
This class allows users to configure the factory used to create an instance of the LMAX disruptor WaitStrategy used by Async Loggers in the log4j configuration.class
Factory for creating instances ofDisruptorBlockingQueue
.class
Factory for creating instances of BlockingQueues backed by JCToolsMpscArrayQueue
.class
Factory for creating instances ofLinkedTransferQueue
. -
Uses of Plugin in org.apache.logging.log4j.core.config
Modifier and TypeClassDescriptionfinal class
An Appender reference.final class
An Appender container.final class
Descriptor of a custom Level object that is created via configuration.final class
Container for CustomLevelConfig objects.class
The default advertiser does not do anything.class
class
Logger object that is created via configuration.static class
The root Logger.final class
Container of Logger objects.final class
Handles properties defined in the configuration.final class
Represents a key/value pair in the configuration.final class
A container of Scripts. -
Uses of Plugin in org.apache.logging.log4j.core.config.arbiters
Modifier and TypeClassDescriptionclass
Conditional that determines if the specified class is present.class
Default Condition for a Select Condition.class
Condition that determines if the specified environment variable is set.class
Condition that evaluates a script.class
Class Description goes here.class
Condition that determines if the specified property is set. -
Uses of Plugin in org.apache.logging.log4j.core.config.json
-
Uses of Plugin in org.apache.logging.log4j.core.config.plugins.convert
Modifier and TypeClassDescriptionstatic class
Parses aString
into aBigDecimal
.static class
Parses aString
into aBigInteger
.static class
static class
Converts aString
into abyte[]
.static class
static class
static class
Converts aString
into achar[]
.static class
static class
static class
static class
static class
Deprecated.since 2.24.0.static class
static class
static class
Converts aString
into anInetAddress
.static class
static class
static class
static class
static class
static class
static class
static class
Returns the givenString
, no conversion takes place.static class
static class
static class
-
Uses of Plugin in org.apache.logging.log4j.core.config.properties
Modifier and TypeClassDescriptionclass
Creates a PropertiesConfiguration from a properties file. -
Uses of Plugin in org.apache.logging.log4j.core.config.xml
Modifier and TypeClassDescriptionclass
Factory to construct an XmlConfiguration. -
Uses of Plugin in org.apache.logging.log4j.core.config.yaml
-
Uses of Plugin in org.apache.logging.log4j.core.filter
Modifier and TypeClassDescriptionfinal class
TheBurstFilter
is a logging filter that regulates logging traffic.final class
Composes and invokes one or more filters.final class
This filter causes all logging events to be dropped.final class
Compares against a log level that is associated with a context value.final class
This filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.final class
This filter returns theAbstractFilter.onMatch
result if the level of theLogEvent
is in the range of the configuredLevelRangeFilter.minLevel
andLevelRangeFilter.maxLevel
values, otherwise it returns theAbstractFilter.onMismatch
result.class
A Filter that operates on a Map.final class
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
Filter based on a value in the Thread Context Map (MDC).final class
This filter returns the onMatch result if there is no marker in the LogEvent.final class
A filter that matches the given regular expression pattern against messages.final class
Returns the onMatch result if the script returns True and returns the onMismatch value otherwise.final class
This filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.final class
Filter based on data in a StructuredDataMessage.class
Filter based on a value in the Thread Context Map (MDC).final class
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.final class
Filters events that fall within a specified time period in each day. -
Uses of Plugin in org.apache.logging.log4j.core.layout
Modifier and TypeClassDescriptionclass
A Comma-Separated Value (CSV) layout to log events.class
A Comma-Separated Value (CSV) layout to log event parameters.final class
Lays out events in the Graylog Extended Log Format (GELF) 1.1.final class
Outputs events as rows in an HTML table on an HTML page.final class
Note: The JsonLayout should be considered to be deprecated.class
Selects the pattern to use based on the Level in the LogEvent.final class
A LoggerFields container.class
Selects the pattern to use based on the Marker in the LogEvent.class
final class
A flexible layout configurable with pattern string.final class
PatternMatch configuration item.final class
Formats a log event in accordance with RFC 5424.class
Selects the pattern to use based on the result of executing a Script.final class
Deprecated.Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .final class
Formats a log event as a BSD Log record.final class
Appends a series ofevent
elements as defined in the Log4j-events.xsd.final class
Appends a series of YAML events as strings serialized as bytes. -
Uses of Plugin in org.apache.logging.log4j.core.lookup
Modifier and TypeClassDescriptionclass
Looks up keys from the context.class
Formats the current date or the date in the LogEvent.class
Looks up keys from environment variables.class
Looks up values from the log event.class
Looks up keys related to Java: Java version, JRE version, VM version, and so on.class
Maps JVM input arguments (but not main arguments) using JMX to acquire JVM arguments.class
Looks up keys from JNDI resources.class
Lookup properties of Log4jclass
Converts values to lower case.class
A map-based lookup for main arguments.class
A map-based lookup.class
Looks-up markers.class
Looks up keys from resource bundles.class
Looks up keys fromStructuredDataMessage
log messages.class
Looks up keys from system properties.class
Converts values to upper case. -
Uses of Plugin in org.apache.logging.log4j.core.net
Modifier and TypeClassDescriptionclass
Advertise an entity via ZeroConf/MulticastDNS and the JmDNS library.class
Plugin to hold a hostname and port (socket address).class
Holds all socket options settable viaSocket
methods.class
Holds all socket options settable viaSocket.setPerformancePreferences(int, int, int)
. -
Uses of Plugin in org.apache.logging.log4j.core.net.ssl
Modifier and TypeClassDescriptionclass
Configuration of the KeyStoreclass
SSL Configurationclass
Configuration of the TrustStore -
Uses of Plugin in org.apache.logging.log4j.core.pattern
Modifier and TypeClassDescriptionstatic final class
Black style pattern converter.static final class
Blue style pattern converter.static final class
Cyan style pattern converter.static final class
Green style pattern converter.static final class
Magenta style pattern converter.static final class
Red style pattern converter.static final class
White style pattern converter.static final class
Yellow style pattern converter.final class
Formats the class name of the site of the logging request.final class
Converts and formats the event's date in a StringBuilder.final class
Converter that encodes the output from a pattern using a specified format.final class
Formats the EndOfBatch.final class
Equals ignore case pattern converter.final class
Equals pattern converter.final class
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.final class
Formats a date by delegating toDatePatternConverter
.final class
Returns the event's line location information in a StringBuilder.final class
Format the event's line location information.final class
Highlight pattern converter.final class
Formats an integer.class
Returns the event's level in a StringBuilder.final class
Returns the event's line location information in a StringBuilder.final class
Formats a line separator.final class
Formats the Logger FQCN.final class
Formats a logger name.final class
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.final class
Returns events' full marker string in a StringBuilder.final class
Appends an event's maker name to a StringBuilder.final class
Max length pattern converter.final class
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
Returns the event's rendered message in a StringBuilder.final class
Returns the event's line location information in a StringBuilder.final class
Converts and formats the event's nanoTime in a StringBuilder.final class
Returns the event's NDC in a StringBuilder.final class
final class
Replace tokens in the LogEvent message.final class
Replacement pattern converter.class
Returns the relative time in milliseconds since JVM Startup.final class
Equals pattern converter.final class
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.final class
Formats the event sequence number.final class
Style pattern converter.final class
Formats the event thread ID.final class
Formats the event thread name.final class
Formats the event thread priority.class
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.final class
Formats the event sequence number.final class
VariablesNotEmpty pattern converter. -
Uses of Plugin in org.apache.logging.log4j.core.script
Modifier and TypeClassDescriptionclass
Container for the language and body of a script.class
Container for the language and body of a script file along with the file location.class
Contains a reference to a script defined elsewhere in the configuration. -
Uses of Plugin in org.apache.logging.log4j.core.util