Uses of Annotation Type
org.apache.logging.log4j.core.config.plugins.Plugin
Packages that use 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
Classes in org.apache.logging.log4j.core.appender with annotations of type PluginModifier and TypeClassDescriptionclassA deferred plugin for appenders.final classAppends to one or more Appenders asynchronously.final classAppends log events toSystem.outorSystem.errusing a layout specified by the user.classNo-Operation Appender that counts events.final classThe FailoverAppender will capture exceptions in an Appender and then route the event to a different appender.final classThe array of failover Appenders.final classFile Appender.final classfinal classMemory Mapped File Appender.classAn Appender that ignores log events.final classAppends log events to a given output stream using a layout.final classFile Appender.final classAn appender that writes to files and can roll over at intervals.final classAn appender that writes to random access files and can roll over at intervals.classfinal classSend an e-mail when a specific logging event occurs, typically on errors or fatal errors.classAn Appender that delivers events over socket connections.classThe Syslog Appender.final classAppends log events to aWriter. -
Uses of Plugin in org.apache.logging.log4j.core.appender.db
Classes in org.apache.logging.log4j.core.appender.db with annotations of type PluginModifier and TypeClassDescriptionclassA configuration element for specifying a database column name mapping. -
Uses of Plugin in org.apache.logging.log4j.core.appender.db.jdbc
Classes in org.apache.logging.log4j.core.appender.db.jdbc with annotations of type PluginModifier and TypeClassDescriptionfinal classA configuration element used to configure which event properties are logged to which columns in the database table.final classAJdbcAppenderconnection source that uses aDataSourceto connect to the database.classAConnectionSourcethat uses a JDBC connection string, a user name, and a password to callDriverManager.getConnection(String, String, String).final classAJdbcAppenderconnection source that uses a public static factory method to obtain aConnectionorDataSource.final classThis Appender writes logging events to a relational database using standard JDBC mechanisms. -
Uses of Plugin in org.apache.logging.log4j.core.appender.mom
Classes in org.apache.logging.log4j.core.appender.mom with annotations of type Plugin -
Uses of Plugin in org.apache.logging.log4j.core.appender.mom.jeromq
Classes in org.apache.logging.log4j.core.appender.mom.jeromq with annotations of type PluginModifier and TypeClassDescriptionfinal classSends log events to one or more ZeroMQ (JeroMQ) endpoints. -
Uses of Plugin in org.apache.logging.log4j.core.appender.mom.kafka
Classes in org.apache.logging.log4j.core.appender.mom.kafka with annotations of type PluginModifier and TypeClassDescriptionfinal classSends log events to an Apache Kafka topic. -
Uses of Plugin in org.apache.logging.log4j.core.appender.nosql
Classes in org.apache.logging.log4j.core.appender.nosql with annotations of type PluginModifier and TypeClassDescriptionfinal classThis Appender writes logging events to a NoSQL database using a configured NoSQL provider. -
Uses of Plugin in org.apache.logging.log4j.core.appender.rewrite
Classes in org.apache.logging.log4j.core.appender.rewrite with annotations of type PluginModifier and TypeClassDescriptionclassRewrites log event levels for a given logger name.final classThis policy modifies events by replacing or possibly adding keys and values to the MapMessage.final classThis policy modifies events by replacing or possibly adding keys and values to the MapMessage.final classThis 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
Classes in org.apache.logging.log4j.core.appender.rolling with annotations of type PluginModifier and TypeClassDescriptionfinal classTriggering policy that wraps other triggering policies.final classRolls a file over based on a cron schedule.classWhen rolling over,DefaultRolloverStrategyrenames files according to an algorithm as described below.classWhen rolling over,DirectWriteRolloverStrategywrites directly to the file as resolved by the file pattern.classclassTriggers a rollover on every restart, but only if the file size is greater than zero.classfinal classRolls a file over based on time. -
Uses of Plugin in org.apache.logging.log4j.core.appender.rolling.action
Classes in org.apache.logging.log4j.core.appender.rolling.action with annotations of type PluginModifier and TypeClassDescriptionclassRollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.final classPathCondition that accepts paths after some count threshold is exceeded during the file tree walk.final classPathCondition that accepts paths after the accumulated file size threshold is exceeded during the file tree walk.final classCompositePathConditionthat only accepts objects that are accepted by all component conditions.final classCompositePathConditionthat accepts objects that are accepted by any component conditions.final classPathCondition that accepts files for deletion if their relative path matches either a glob pattern or a regular expression.final classPathCondition that accepts paths that are older than the specified duration.final classWrapperPathConditionthat accepts objects that are rejected by the wrapped component filter.classPathSorterthat sorts path by their LastModified attribute.classFile POSIX attribute view action.classA condition of theDeleteActionwhere a user-provided script selects the files to delete from a provided list. -
Uses of Plugin in org.apache.logging.log4j.core.appender.routing
Classes in org.apache.logging.log4j.core.appender.routing with annotations of type PluginModifier and TypeClassDescriptionclassPolicy is purging appenders that were not in use specified time in minutesfinal classA Route to an appender.final classContains the individual Route elements.final classThis 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
Classes in org.apache.logging.log4j.core.async with annotations of type PluginModifier and TypeClassDescriptionclassFactory for creating instances ofArrayBlockingQueue.classAsynchronous Logger object that is created via configuration and can be combined with synchronous loggers.static classAn asynchronous root Logger.classThis 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.classFactory for creating instances ofDisruptorBlockingQueue.classFactory for creating instances of BlockingQueues backed by JCToolsMpscArrayQueue.classFactory for creating instances ofLinkedTransferQueue. -
Uses of Plugin in org.apache.logging.log4j.core.config
Classes in org.apache.logging.log4j.core.config with annotations of type PluginModifier and TypeClassDescriptionfinal classAn Appender reference.final classAn Appender container.final classDescriptor of a custom Level object that is created via configuration.final classContainer for CustomLevelConfig objects.classThe default advertiser does not do anything.classclassLogger object that is created via configuration.static classThe root Logger.final classContainer of Logger objects.final classContainer for theMonitorResourceelement.final classContainer for theMonitorResourceselement.final classHandles properties defined in the configuration.final classRepresents a key/value pair in the configuration.final classA container of Scripts. -
Uses of Plugin in org.apache.logging.log4j.core.config.arbiters
Classes in org.apache.logging.log4j.core.config.arbiters with annotations of type PluginModifier and TypeClassDescriptionclassConditional that determines if the specified class is present.classDefault Condition for a Select Condition.classCondition that determines if the specified environment variable is set.classCondition that evaluates a script.classClass Description goes here.classCondition that determines if the specified property is set. -
Uses of Plugin in org.apache.logging.log4j.core.config.json
Classes in org.apache.logging.log4j.core.config.json with annotations of type Plugin -
Uses of Plugin in org.apache.logging.log4j.core.config.plugins.convert
Classes in org.apache.logging.log4j.core.config.plugins.convert with annotations of type PluginModifier and TypeClassDescriptionstatic classParses aStringinto aBigDecimal.static classParses aStringinto aBigInteger.static classstatic classConverts aStringinto abyte[].static classstatic classstatic classConverts aStringinto achar[].static classstatic classstatic classstatic classstatic classDeprecated.since 2.24.0.static classstatic classstatic classConverts aStringinto anInetAddress.static classstatic classstatic classstatic classstatic classstatic classstatic classstatic classReturns the givenString, no conversion takes place.static classstatic classstatic class -
Uses of Plugin in org.apache.logging.log4j.core.config.properties
Classes in org.apache.logging.log4j.core.config.properties with annotations of type PluginModifier and TypeClassDescriptionclassCreates a PropertiesConfiguration from a properties file. -
Uses of Plugin in org.apache.logging.log4j.core.config.xml
Classes in org.apache.logging.log4j.core.config.xml with annotations of type PluginModifier and TypeClassDescriptionclassFactory to construct an XmlConfiguration. -
Uses of Plugin in org.apache.logging.log4j.core.config.yaml
Classes in org.apache.logging.log4j.core.config.yaml with annotations of type Plugin -
Uses of Plugin in org.apache.logging.log4j.core.filter
Classes in org.apache.logging.log4j.core.filter with annotations of type PluginModifier and TypeClassDescriptionfinal classTheBurstFilteris a logging filter that regulates logging traffic.final classComposes and invokes one or more filters.final classThis filter causes all logging events to be dropped.final classCompares against a log level that is associated with a context value.final classThis filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.final classThis filter returns theAbstractFilter.onMatchresult if the level of theLogEventis in the range of the configuredLevelRangeFilter.minLevelandLevelRangeFilter.maxLevelvalues, otherwise it returns theAbstractFilter.onMismatchresult.classA Filter that operates on a Map.final classThis filter returns the onMatch result if the marker in the LogEvent is the same as or has the configured marker as a parent.classFilter based on a value in the Thread Context Map (MDC).final classThis filter returns the onMatch result if there is no marker in the LogEvent.final classA filter that matches the given regular expression pattern against messages.final classReturns the onMatch result if the script returns True and returns the onMismatch value otherwise.final classThis filter returns the onMatch result if the logging level in the event matches the specified logging level exactly.final classFilter based on data in a StructuredDataMessage.classFilter based on a value in the Thread Context Map (MDC).final classThis filter returns the onMatch result if the level in theLogEventis the same or more specific than the configured level and theonMismatchvalue otherwise.final classFilters events that fall within a specified time period in each day. -
Uses of Plugin in org.apache.logging.log4j.core.layout
Classes in org.apache.logging.log4j.core.layout with annotations of type PluginModifier and TypeClassDescriptionclassA Comma-Separated Value (CSV) layout to log events.classA Comma-Separated Value (CSV) layout to log event parameters.final classLays out events in the Graylog Extended Log Format (GELF) 1.1.final classOutputs events as rows in an HTML table on an HTML page.final classNote: The JsonLayout should be considered to be deprecated.classSelects the pattern to use based on the Level in the LogEvent.final classA LoggerFields container.classSelects the pattern to use based on the Marker in the LogEvent.classfinal classA flexible layout configurable with pattern string.final classPatternMatch configuration item.final classFormats a log event in accordance with RFC 5424.classSelects the pattern to use based on the result of executing a Script.final classDeprecated.Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .final classFormats a log event as a BSD Log record.final classAppends a series ofeventelements as defined in the Log4j-events.xsd.final classAppends a series of YAML events as strings serialized as bytes. -
Uses of Plugin in org.apache.logging.log4j.core.lookup
Classes in org.apache.logging.log4j.core.lookup with annotations of type PluginModifier and TypeClassDescriptionclassLooks up keys from the context.classFormats the current date or the date in the LogEvent.classLooks up keys from environment variables.classLooks up values from the log event.classLooks up keys related to Java: Java version, JRE version, VM version, and so on.classMaps JVM input arguments (but not main arguments) using JMX to acquire JVM arguments.classLooks up keys from JNDI resources.classLookup properties of Log4jclassConverts values to lower case.classA map-based lookup for main arguments.classA map-based lookup.classLooks-up markers.classLooks up keys from resource bundles.classLooks up keys fromStructuredDataMessagelog messages.classLooks up keys from system properties.classConverts values to upper case. -
Uses of Plugin in org.apache.logging.log4j.core.net
Classes in org.apache.logging.log4j.core.net with annotations of type PluginModifier and TypeClassDescriptionclassAdvertise an entity via ZeroConf/MulticastDNS and the JmDNS library.classPlugin to hold a hostname and port (socket address).classHolds all socket options settable viaSocketmethods.classHolds all socket options settable viaSocket.setPerformancePreferences(int, int, int). -
Uses of Plugin in org.apache.logging.log4j.core.net.ssl
Classes in org.apache.logging.log4j.core.net.ssl with annotations of type PluginModifier and TypeClassDescriptionclassConfiguration of the KeyStoreclassSSL ConfigurationclassConfiguration of the TrustStore -
Uses of Plugin in org.apache.logging.log4j.core.pattern
Classes in org.apache.logging.log4j.core.pattern with annotations of type PluginModifier and TypeClassDescriptionstatic final classBlack style pattern converter.static final classBlue style pattern converter.static final classCyan style pattern converter.static final classGreen style pattern converter.static final classMagenta style pattern converter.static final classRed style pattern converter.static final classWhite style pattern converter.static final classYellow style pattern converter.final classFormats the class name of the site of the logging request.final classConverts and formats the event's date in a StringBuilder.final classConverter that encodes the output from a pattern using a specified format.final classFormats the EndOfBatch.final classEquals ignore case pattern converter.final classEquals pattern converter.final classThrowablePatternConvertervariant where the renderedStackTraceElements are enriched with the enclosing JAR file and its version information, if available.final classFormats a date by delegating toDatePatternConverter.final classReturns the event's line location information in a StringBuilder.final classFormat the event's line location information.final classHighlight pattern converter.final classFormats an integer.classReturns the event's level in a StringBuilder.final classReturns the event's line location information in a StringBuilder.final classFormats a line separator.final classFormats the Logger FQCN.final classFormats a logger name.final classAble 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 classReturns events' full marker string in a StringBuilder.final classAppends an event's maker name to a StringBuilder.final classMax length pattern converter.final classAble 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.classReturns the event's rendered message in a StringBuilder.final classReturns the event's line location information in a StringBuilder.final classConverts and formats the event's nanoTime in a StringBuilder.final classReturns the event's NDC in a StringBuilder.final classfinal classReplace tokens in the LogEvent message.final classReplacement pattern converter.classReturns the relative time in milliseconds since JVM Startup.final classEquals pattern converter.final classThrowablePatternConvertervariant where the stack trace causal chain is rendered in reverse order.final classFormats the event sequence number.final classStyle pattern converter.final classFormats the event thread ID.final classFormats the event thread name.final classFormats the event thread priority.classfinal classFormats a UUID.final classVariablesNotEmpty pattern converter. -
Uses of Plugin in org.apache.logging.log4j.core.script
Classes in org.apache.logging.log4j.core.script with annotations of type PluginModifier and TypeClassDescriptionclassContainer for the language and body of a script.classContainer for the language and body of a script file along with the file location.classContains a reference to a script defined elsewhere in the configuration. -
Uses of Plugin in org.apache.logging.log4j.core.util
Classes in org.apache.logging.log4j.core.util with annotations of type Plugin
org.apache.logging.log4j.core.appender.mom.jakarta.JmsAppender.